@maccesar/titools 5.3.0 → 5.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +1 -1
- package/README.md +31 -60
- package/agents/ti-pro.md +3 -1
- package/commands/ti-audit.md +6 -4
- package/docs/examples.md +9 -0
- package/docs/knowledge-index.md +2 -1
- package/lib/config.js +1 -0
- package/package.json +1 -1
- package/skills/alloy-guides/SKILL.md +18 -179
- package/skills/alloy-guides/references/CLI_TASKS.md +17 -216
- package/skills/alloy-guides/references/CONCEPTS.md +27 -162
- package/skills/alloy-guides/references/CONTROLLERS.md +38 -236
- package/skills/alloy-guides/references/MODELS.md +47 -723
- package/skills/alloy-guides/references/MODELS_ADVANCED.md +21 -482
- package/skills/alloy-guides/references/VIEWS_DYNAMIC.md +12 -222
- package/skills/alloy-guides/references/VIEWS_STYLES.md +39 -358
- package/skills/alloy-guides/references/VIEWS_XML.md +36 -552
- package/skills/alloy-guides/references/WIDGETS.md +49 -127
- package/skills/alloy-howtos/SKILL.md +14 -169
- package/skills/alloy-howtos/references/best_practices.md +9 -113
- package/skills/alloy-howtos/references/cli_reference.md +18 -223
- package/skills/alloy-howtos/references/config_files.md +50 -133
- package/skills/alloy-howtos/references/debugging_troubleshooting.md +19 -63
- package/skills/alloy-howtos/references/samples.md +21 -138
- package/skills/ti-api/SKILL.md +10 -2
- package/skills/ti-api/references/api-android.md +36 -2
- package/skills/ti-api/references/api-app-platform.md +39 -3
- package/skills/ti-api/references/api-core.md +50 -18
- package/skills/ti-api/references/api-data-network.md +49 -35
- package/skills/ti-api/references/api-media.md +45 -27
- package/skills/ti-api/references/api-services.md +39 -9
- package/skills/ti-api/references/api-ui-android.md +33 -13
- package/skills/ti-api/references/api-ui-extras.md +41 -15
- package/skills/ti-api/references/api-ui-ios-animator.md +42 -26
- package/skills/ti-api/references/api-ui-ios.md +74 -2
- package/skills/ti-api/references/api-ui-lists.md +32 -16
- package/skills/ti-api/references/api-ui-text-input.md +34 -17
- package/skills/ti-api/references/api-ui-views.md +27 -1
- package/skills/ti-api/references/api-ui-windows-navigation.md +32 -18
- package/skills/ti-api/references/api-xml-global.md +66 -16
- package/skills/ti-create-release/SKILL.md +98 -0
- package/skills/ti-create-release/references/module-discovery.md +69 -0
- package/skills/ti-expert/references/adaptive-layouts.md +1 -1
- package/skills/ti-guides/SKILL.md +37 -76
- package/skills/ti-guides/references/advanced-data-and-images.md +122 -126
- package/skills/ti-guides/references/android-manifest.md +24 -83
- package/skills/ti-guides/references/app-distribution.md +31 -377
- package/skills/ti-guides/references/application-frameworks.md +127 -335
- package/skills/ti-guides/references/cli-reference.md +184 -633
- package/skills/ti-guides/references/commonjs-advanced.md +81 -231
- package/skills/ti-guides/references/compatibility-matrix.md +36 -75
- package/skills/ti-guides/references/hello-world.md +95 -70
- package/skills/ti-guides/references/hyperloop-native-access.md +52 -448
- package/skills/ti-guides/references/resources.md +174 -142
- package/skills/ti-guides/references/sdk-release-notes.md +28 -71
- package/skills/ti-guides/references/tiapp-config.md +222 -598
- package/skills/ti-howtos/SKILL.md +23 -123
- package/skills/ti-howtos/references/cross-platform-development.md +119 -324
- package/skills/ti-howtos/references/debugging-profiling.md +77 -445
- package/skills/ti-howtos/references/extending-titanium.md +199 -673
- package/skills/ti-howtos/references/local-data-sources.md +87 -300
- package/skills/ti-howtos/references/location-and-maps.md +86 -213
- package/skills/ti-howtos/references/media-apis.md +103 -223
- package/skills/ti-howtos/references/notification-services.md +86 -506
- package/skills/ti-howtos/references/remote-data-sources.md +97 -316
- package/skills/ti-howtos/references/using-modules.md +77 -133
- package/skills/ti-ui/SKILL.md +28 -143
- package/skills/ti-ui/references/icons-and-splash-screens.md +74 -403
- package/skills/ti-ui/references/layouts-and-positioning.md +175 -402
- package/skills/ti-ui/references/listviews-and-performance.md +100 -703
- package/skills/ti-ui/references/platform-conventions.md +180 -0
- package/skills/ti-ui/references/user-interface.md +43 -0
- package/skills/alloy-guides/references/VIEWS_WITHOUT_CONTROLLERS.md +0 -102
- package/skills/alloy-howtos/references/custom_tags.md +0 -148
- package/skills/ti-guides/references/coding-best-practices.md +0 -149
- package/skills/ti-guides/references/javascript-primer.md +0 -414
- package/skills/ti-guides/references/reserved-words.md +0 -36
- package/skills/ti-guides/references/style-and-conventions.md +0 -103
- package/skills/ti-howtos/references/android-platform-deep-dives.md +0 -624
- package/skills/ti-howtos/references/automation-fastlane-appium.md +0 -96
- package/skills/ti-howtos/references/buffer-codec-streams.md +0 -162
- package/skills/ti-howtos/references/google-maps-v2.md +0 -172
- package/skills/ti-howtos/references/ios-map-kit.md +0 -149
- package/skills/ti-howtos/references/ios-platform-deep-dives.md +0 -611
- package/skills/ti-howtos/references/tutorials.md +0 -565
- package/skills/ti-howtos/references/web-content-integration.md +0 -287
- package/skills/ti-howtos/references/webpack-build-pipeline.md +0 -124
- package/skills/ti-ui/references/accessibility-deep-dive.md +0 -288
- package/skills/ti-ui/references/animation-and-matrices.md +0 -569
- package/skills/ti-ui/references/application-structures.md +0 -626
- package/skills/ti-ui/references/custom-fonts-styling.md +0 -549
- package/skills/ti-ui/references/event-handling.md +0 -401
- package/skills/ti-ui/references/gestures.md +0 -448
- package/skills/ti-ui/references/orientation.md +0 -374
- package/skills/ti-ui/references/platform-ui-android.md +0 -727
- package/skills/ti-ui/references/platform-ui-ios.md +0 -576
- package/skills/ti-ui/references/scrolling-views.md +0 -288
- package/skills/ti-ui/references/tableviews.md +0 -542
|
@@ -20,19 +20,21 @@
|
|
|
20
20
|
<!-- TOC-END -->
|
|
21
21
|
|
|
22
22
|
## Ti.UI.Animation
|
|
23
|
+
> Full released contract: [Titanium.UI.Animation](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Animation)
|
|
24
|
+
|
|
23
25
|
> The `Animation` object defines an animation that can be applied to a view.
|
|
24
26
|
> Extends Ti.Proxy
|
|
25
27
|
> Platforms: both
|
|
26
28
|
|
|
27
29
|
An animation object describes the properties of an animation. At its most basic, an animation object represents a single-phase animation with an end state and a duration.
|
|
28
30
|
|
|
29
|
-
When [animate](Titanium.UI.View
|
|
31
|
+
When [animate](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.View) is called on a [View](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.View), the view is animated from its current state to the state described by the animation object. The properties that can be animated include the view's position, size, colors, transformation matrix and opacity.
|
|
30
32
|
|
|
31
|
-
You can also specify an animation curve or *easing function* to control the pace of the animation. To use an easing function, set the animation's `curve` property to one of the `ANIMATION_CURVE` constants defined in <Titanium.UI>. For example, [ANIMATION_CURVE_EASE_IN](Titanium.UI
|
|
33
|
+
You can also specify an animation curve or *easing function* to control the pace of the animation. To use an easing function, set the animation's `curve` property to one of the `ANIMATION_CURVE` constants defined in <Titanium.UI>. For example, [ANIMATION_CURVE_EASE_IN](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI) specifies an animation that starts slowly and then speeds up.
|
|
32
34
|
|
|
33
35
|
Animations can be set to reverse themselves automatically on completion, and to repeat a given number of times. For more complicated effects, multiple animations can be combined in sequence,
|
|
34
36
|
|
|
35
|
-
|
|
37
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Animation API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Animation).
|
|
36
38
|
|
|
37
39
|
### Properties (unique: 28/31)
|
|
38
40
|
| Property | Type | Default | Platform | Description |
|
|
@@ -88,6 +90,8 @@ Animations can be set to reverse themselves automatically on completion, and to
|
|
|
88
90
|
---
|
|
89
91
|
|
|
90
92
|
## Ti.UI.Matrix2D
|
|
93
|
+
> Full released contract: [Titanium.UI.Matrix2D](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Matrix2D)
|
|
94
|
+
|
|
91
95
|
> The 2D Matrix is an object for holding values for an affine transformation matrix.
|
|
92
96
|
> Extends Ti.Proxy
|
|
93
97
|
> Platforms: both
|
|
@@ -118,6 +122,8 @@ A 2D matrix is used to rotate, scale, translate, or skew the objects in a two-di
|
|
|
118
122
|
---
|
|
119
123
|
|
|
120
124
|
## Ti.UI.Matrix3D
|
|
125
|
+
> Full released contract: [Titanium.UI.Matrix3D](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Matrix3D)
|
|
126
|
+
|
|
121
127
|
> The 3D Matrix is an object for holding values for a 3D affine transform.
|
|
122
128
|
> Extends Ti.Proxy
|
|
123
129
|
> Platforms: ios
|
|
@@ -160,6 +166,8 @@ You create an `identity matrix` by creating a 3D Matrix with an empty constructo
|
|
|
160
166
|
---
|
|
161
167
|
|
|
162
168
|
## Ti.UI.WebView
|
|
169
|
+
> Full released contract: [Titanium.UI.WebView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.WebView)
|
|
170
|
+
|
|
163
171
|
> The web view allows you to open an HTML5 based view which can load either local or remote content.
|
|
164
172
|
> Extends Ti.UI.View
|
|
165
173
|
> Platforms: both
|
|
@@ -177,7 +185,7 @@ JavaScript in the web view executes in its own context. The web view can intera
|
|
|
177
185
|
**Local Scripts**
|
|
178
186
|
|
|
179
187
|
|
|
180
|
-
|
|
188
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.WebView API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.WebView).
|
|
181
189
|
|
|
182
190
|
### Properties (unique: 44/123)
|
|
183
191
|
| Property | Type | Default | Platform | Description |
|
|
@@ -235,7 +243,7 @@ JavaScript in the web view executes in its own context. The web view can intera
|
|
|
235
243
|
### Methods (24)
|
|
236
244
|
| Method | Returns | Platform | Description |
|
|
237
245
|
|--------|---------|----------|-------------|
|
|
238
|
-
| setHtml(html, options) | void | both | Sets the value of [html](Titanium.UI.WebView
|
|
246
|
+
| setHtml(html, options) | void | both | Sets the value of [html](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.WebView) property. |
|
|
239
247
|
| canGoBack(—) | Boolean | both | Returns `true` if the web view can go back in its history list. |
|
|
240
248
|
| canGoForward(—) | Boolean | both | Returns `true` if the web view can go forward in its history list. |
|
|
241
249
|
| evalJS(code, callback) | String | both | Evaluates a JavaScript expression inside the context of the web view and option… |
|
|
@@ -368,13 +376,15 @@ Also referenced by this API, documented elsewhere: `Dictionary`.
|
|
|
368
376
|
---
|
|
369
377
|
|
|
370
378
|
## Ti.UI.Toolbar
|
|
379
|
+
> Full released contract: [Titanium.UI.Toolbar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Toolbar)
|
|
380
|
+
|
|
371
381
|
> A Toolbar can contain buttons, as well as certain other widgets, including text fields and labels.
|
|
372
382
|
> Extends Ti.UI.View
|
|
373
383
|
> Platforms: both
|
|
374
384
|
|
|
375
385
|
A `Toolbar` is created by the <Titanium.UI.createToolbar> factory method or **`<Toolbar>`** Alloy element.
|
|
376
386
|
|
|
377
|
-
To provide spacing between items in the toolbar, on iOS you can use the special system button types, [FIXED_SPACE](Titanium.UI.iOS.SystemButton
|
|
387
|
+
To provide spacing between items in the toolbar, on iOS you can use the special system button types, [FIXED_SPACE](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.SystemButton) and [FLEXIBLE_SPACE](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.SystemButton).
|
|
378
388
|
|
|
379
389
|
Note that toolbars are positioned like other views (using the `top` and `bottom` properties, for example), but the [iOS Human Interface Guidelines](https://developer.apple.com/ios/human-interface-guidelines/overview/themes/#//apple_ref/doc/uid/TP40006556-CH12-SW4) have specific requirements for placing toolbars, specifically:
|
|
380
390
|
|
|
@@ -383,7 +393,7 @@ Note that toolbars are positioned like other views (using the `top` and `bottom`
|
|
|
383
393
|
|
|
384
394
|
Due to an iOS limitation, the buttons in the toolbar only support the `click` event. The native object underlying a toolbar button does not generate standard view events,
|
|
385
395
|
|
|
386
|
-
|
|
396
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Toolbar API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Toolbar).
|
|
387
397
|
|
|
388
398
|
### Properties (unique: 14/73)
|
|
389
399
|
| Property | Type | Default | Platform | Description |
|
|
@@ -428,19 +438,21 @@ Due to an iOS limitation, the buttons in the toolbar only support the `click` ev
|
|
|
428
438
|
---
|
|
429
439
|
|
|
430
440
|
## Ti.UI.ButtonBar
|
|
441
|
+
> Full released contract: [Titanium.UI.ButtonBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ButtonBar)
|
|
442
|
+
|
|
431
443
|
> An iOS button bar component.
|
|
432
444
|
> Extends Ti.UI.View
|
|
433
445
|
> Platforms: both
|
|
434
446
|
|
|
435
447
|
| Android | iOS |
|
|
436
448
|
| ------- | --- |
|
|
437
|
-
|
|
|
449
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ButtonBar) | |
|
|
438
450
|
|
|
439
451
|
The button bar is a set of buttons joined into a single control. On iOS, you can set up the buttons with either a title or image, but not both. On Android, you can set up the buttons with a title, image, or both.
|
|
440
452
|
|
|
441
453
|
Use the <Titanium.UI.createButtonBar> method or **`<ButtonBar>`** Alloy element to create a button bar.
|
|
442
454
|
|
|
443
|
-
The [TabbedBar](Titanium.UI.iOS.TabbedBar) control is a button bar where the last selected button maintains a pressed or selected state. The following discussion applies to both button bar and tabbed bar.
|
|
455
|
+
The [TabbedBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.TabbedBar) control is a button bar where the last selected button maintains a pressed or selected state. The following discussion applies to both button bar and tabbed bar.
|
|
444
456
|
|
|
445
457
|
### Properties (unique: 5/76)
|
|
446
458
|
| Property | Type | Default | Platform | Description |
|
|
@@ -461,11 +473,13 @@ The [TabbedBar](Titanium.UI.iOS.TabbedBar) control is a button bar where the las
|
|
|
461
473
|
---
|
|
462
474
|
|
|
463
475
|
## Ti.UI.TabbedBar
|
|
476
|
+
> Full released contract: [Titanium.UI.TabbedBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabbedBar)
|
|
477
|
+
|
|
464
478
|
> A button bar that maintains a selected state.
|
|
465
479
|
> Extends Ti.UI.View
|
|
466
480
|
> Platforms: both
|
|
467
481
|
|
|
468
|
-
A tabbed bar is a button bar that maintains a state (visually distinguished as a pressed or selected look). It is closely related to the `ButtonBar` control. See the description of [ButtonBar](Titanium.UI.ButtonBar) for information on styling tabbed bars and buttons bars.
|
|
482
|
+
A tabbed bar is a button bar that maintains a state (visually distinguished as a pressed or selected look). It is closely related to the `ButtonBar` control. See the description of [ButtonBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ButtonBar) for information on styling tabbed bars and buttons bars.
|
|
469
483
|
|
|
470
484
|
Use the <Titanium.UI.createTabbedBar> method to create a Tabbed Bar.
|
|
471
485
|
|
|
@@ -490,13 +504,15 @@ Use the <Titanium.UI.createTabbedBar> method to create a Tabbed Bar.
|
|
|
490
504
|
---
|
|
491
505
|
|
|
492
506
|
## Ti.UI.OptionBar
|
|
507
|
+
> Full released contract: [Titanium.UI.OptionBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.OptionBar)
|
|
508
|
+
|
|
493
509
|
> A bar of selectable buttons where only 1 can be selected at a time.
|
|
494
510
|
> Extends Ti.UI.View
|
|
495
511
|
> Platforms: both
|
|
496
512
|
|
|
497
513
|
| Android | iOS |
|
|
498
514
|
| ------- | --- |
|
|
499
|
-
|
|
|
515
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.OptionBar) | |
|
|
500
516
|
|
|
501
517
|
This is a view which shows a list of options where only 1 option is selectable by the user.
|
|
502
518
|
|
|
@@ -527,6 +543,8 @@ Use the <Titanium.UI.createOptionBar> method to create a Option Bar.
|
|
|
527
543
|
---
|
|
528
544
|
|
|
529
545
|
## Ti.UI.Shortcut
|
|
546
|
+
> Full released contract: [Titanium.UI.Shortcut](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Shortcut)
|
|
547
|
+
|
|
530
548
|
> Manage application shortcuts.
|
|
531
549
|
> Extends Ti.Proxy
|
|
532
550
|
> Platforms: both
|
|
@@ -558,6 +576,8 @@ On iOS, shortcuts are only supported on a 3D Touch compatible device. Use the <T
|
|
|
558
576
|
---
|
|
559
577
|
|
|
560
578
|
## Ti.UI.ShortcutItem
|
|
579
|
+
> Full released contract: [Titanium.UI.ShortcutItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ShortcutItem)
|
|
580
|
+
|
|
561
581
|
> An application shortcut item.
|
|
562
582
|
> Extends Ti.Proxy
|
|
563
583
|
> Platforms: both
|
|
@@ -593,13 +613,15 @@ In the `tiapp.xml` file, you will need to add a shortcuts `<meta-data/>` element
|
|
|
593
613
|
---
|
|
594
614
|
|
|
595
615
|
## Ti.UI.EmailDialog
|
|
616
|
+
> Full released contract: [Titanium.UI.EmailDialog](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.EmailDialog)
|
|
617
|
+
|
|
596
618
|
> An email dialog is a modal window that allows users to compose and send an email.
|
|
597
619
|
> Extends Ti.UI.View
|
|
598
620
|
> Platforms: both
|
|
599
621
|
|
|
600
622
|
| Android | iOS |
|
|
601
623
|
| ------- | --- |
|
|
602
|
-
|
|
|
624
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.EmailDialog) | [iOS API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.EmailDialog) |
|
|
603
625
|
|
|
604
626
|
The Email Dialog is created with the <Titanium.UI.createEmailDialog> method. The user needs to register an e-mail account on the device in order to open the dialog. The dialog will not open when there is not a registered e-mail account.
|
|
605
627
|
|
|
@@ -646,20 +668,22 @@ On iOS, you cannot test the e-mail dialog on the iOS Simulator. Test the email d
|
|
|
646
668
|
---
|
|
647
669
|
|
|
648
670
|
## Ti.UI.DashboardView
|
|
671
|
+
> Full released contract: [Titanium.UI.DashboardView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.DashboardView)
|
|
672
|
+
|
|
649
673
|
> A dashboard view is an iOS Springboard-like view of <Titanium.UI.DashboardItem> items that may be deleted and reordered by the user using its built-in edit mode.
|
|
650
674
|
> Extends Ti.UI.View
|
|
651
675
|
> Platforms: ios
|
|
652
676
|
|
|
653
677
|
The DashboardView is created using the <Titanium.UI.createDashboardView> method or **`<DashboardView>`** Alloy element.
|
|
654
678
|
|
|
655
|
-
Dashboard view's edit mode may be activated by a longpress of a <Titanium.UI.DashboardItem> item, unless this behavior has been disabled by the [editable](Titanium.UI.DashboardView
|
|
679
|
+
Dashboard view's edit mode may be activated by a longpress of a <Titanium.UI.DashboardItem> item, unless this behavior has been disabled by the [editable](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.DashboardView) property. As a dashboard view does not inherently provide a way to exit edit mode, this must be explicitly defined.
|
|
656
680
|
|
|
657
|
-
When edit mode has been activated, the item icons wobble by default to act as a visual cue. This behavior may be disabled using the [wobble](Titanium.UI.DashboardView
|
|
681
|
+
When edit mode has been activated, the item icons wobble by default to act as a visual cue. This behavior may be disabled using the [wobble](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.DashboardView) property.
|
|
658
682
|
|
|
659
683
|
If a dashboard contains more than 9 items, it will be paged into screens in a 3 x 3 formation using its built-in scrollable view. A paging control is added to the bottom of the view to indicate the active page.
|
|
660
684
|
|
|
661
685
|
|
|
662
|
-
|
|
686
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.DashboardView API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.DashboardView).
|
|
663
687
|
|
|
664
688
|
### Properties (unique: 5/51)
|
|
665
689
|
| Property | Type | Default | Platform | Description |
|
|
@@ -702,6 +726,8 @@ If a dashboard contains more than 9 items, it will be paged into screens in a 3
|
|
|
702
726
|
---
|
|
703
727
|
|
|
704
728
|
## Ti.UI.DashboardItem
|
|
729
|
+
> Full released contract: [Titanium.UI.DashboardItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.DashboardItem)
|
|
730
|
+
|
|
705
731
|
> A dashboard item is a view that is displayed as an icon in a <Titanium.UI.DashboardView>.
|
|
706
732
|
> Extends Ti.Proxy
|
|
707
733
|
> Platforms: ios
|
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
<!-- TOC-END -->
|
|
16
16
|
|
|
17
17
|
## Ti.UI.iOS.AnchorAttachmentBehavior
|
|
18
|
+
> Full released contract: [Titanium.UI.iOS.AnchorAttachmentBehavior](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.AnchorAttachmentBehavior)
|
|
19
|
+
|
|
18
20
|
> Dynamic behavior to support connections between an anchor point and an item.
|
|
19
21
|
> Extends Ti.Proxy
|
|
20
22
|
> Platforms: ios
|
|
@@ -23,9 +25,9 @@ An anchor attachment behavior creates a dynamic connection between an anchor poi
|
|
|
23
25
|
To define an anchor attachment behavior:
|
|
24
26
|
|
|
25
27
|
1. Use the <Titanium.UI.iOS.createAnchorAttachmentBehavior> method to create a behavior.
|
|
26
|
-
2. Set the [anchor](Titanium.UI.iOS.AnchorAttachmentBehavior
|
|
27
|
-
[item](Titanium.UI.iOS.AnchorAttachmentBehavior
|
|
28
|
-
3. Add the behavior to the [Animator object](Titanium.UI.iOS.Animator).
|
|
28
|
+
2. Set the [anchor](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.AnchorAttachmentBehavior) and
|
|
29
|
+
[item](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.AnchorAttachmentBehavior) properties.
|
|
30
|
+
3. Add the behavior to the [Animator object](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator).
|
|
29
31
|
|
|
30
32
|
To create a dynamic connection between two items, use <Titanium.UI.iOS.ViewAttachmentBehavior>.
|
|
31
33
|
|
|
@@ -55,6 +57,8 @@ To create a dynamic connection between two items, use <Titanium.UI.iOS.ViewAttac
|
|
|
55
57
|
---
|
|
56
58
|
|
|
57
59
|
## Ti.UI.iOS.Animator
|
|
60
|
+
> Full released contract: [Titanium.UI.iOS.Animator](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator)
|
|
61
|
+
|
|
58
62
|
> Provides support for the built-in iOS dynamic animations
|
|
59
63
|
> Extends Ti.Proxy
|
|
60
64
|
> Platforms: ios
|
|
@@ -69,13 +73,13 @@ To use these dynamic animations, first create the items to animate, then:
|
|
|
69
73
|
|
|
70
74
|
**1.** Create an animator using the <Titanium.UI.iOS.createAnimator> method.
|
|
71
75
|
|
|
72
|
-
**2.** Set the [referenceView](Titanium.UI.iOS.Animator
|
|
76
|
+
**2.** Set the [referenceView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator) property to establish the
|
|
73
77
|
coordinate system for the animations.
|
|
74
78
|
|
|
75
79
|
**3.** Create and add items to one or more of the following behaviors:
|
|
76
80
|
|
|
77
81
|
|
|
78
|
-
|
|
82
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.iOS.Animator API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator).
|
|
79
83
|
|
|
80
84
|
### Properties (unique: 3/5)
|
|
81
85
|
| Property | Type | Default | Platform | Description |
|
|
@@ -104,6 +108,8 @@ To use these dynamic animations, first create the items to animate, then:
|
|
|
104
108
|
---
|
|
105
109
|
|
|
106
110
|
## Ti.UI.iOS.CollisionBehavior
|
|
111
|
+
> Full released contract: [Titanium.UI.iOS.CollisionBehavior](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.CollisionBehavior)
|
|
112
|
+
|
|
107
113
|
> Dynamic behavior to support collisions between items and boundaries.
|
|
108
114
|
> Extends Ti.Proxy
|
|
109
115
|
> Platforms: ios
|
|
@@ -112,11 +118,11 @@ A collision behavior specifies the behavior when items collide with each other a
|
|
|
112
118
|
To define a collision behavior:
|
|
113
119
|
|
|
114
120
|
1. Use the <Titanium.UI.iOS.createCollisionBehavior> method to create and define the behavior.
|
|
115
|
-
2. Use the [addItem](Titanium.UI.iOS.CollisionBehavior
|
|
116
|
-
3. Use the [addBoundary](Titanium.UI.iOS.CollisionBehavior
|
|
121
|
+
2. Use the [addItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.CollisionBehavior) method to add items to the behavior.
|
|
122
|
+
3. Use the [addBoundary](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.CollisionBehavior) method to add custom
|
|
117
123
|
boundaries for the item to collide with. By default, the behavior uses the Animator
|
|
118
124
|
object's reference view as the boundary.
|
|
119
|
-
4. Add the behavior to an [Animator object](Titanium.UI.iOS.Animator).
|
|
125
|
+
4. Add the behavior to an [Animator object](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator).
|
|
120
126
|
|
|
121
127
|
### Properties (unique: 5/7)
|
|
122
128
|
| Property | Type | Default | Platform | Description |
|
|
@@ -175,6 +181,8 @@ To define a collision behavior:
|
|
|
175
181
|
---
|
|
176
182
|
|
|
177
183
|
## Ti.UI.iOS.DynamicItemBehavior
|
|
184
|
+
> Full released contract: [Titanium.UI.iOS.DynamicItemBehavior](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.DynamicItemBehavior)
|
|
185
|
+
|
|
178
186
|
> Base dynamic configuration for an item.
|
|
179
187
|
> Extends Ti.Proxy
|
|
180
188
|
> Platforms: ios
|
|
@@ -184,8 +192,8 @@ attributes, such as density and resistance, affects the behavior of the object w
|
|
|
184
192
|
such as push forces or collisions, are applied to it. To define a dynamic behavior for an item:
|
|
185
193
|
|
|
186
194
|
1. Use the <Titanium.UI.iOS.createDynamicItemBehavior> method to create and define the behavior.
|
|
187
|
-
2. Use the [addItem](Titanium.UI.iOS.DynamicItemBehavior
|
|
188
|
-
3. Add the behavior to an [Animator object](Titanium.UI.iOS.Animator).
|
|
195
|
+
2. Use the [addItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.DynamicItemBehavior) method to add items to the behavior.
|
|
196
|
+
3. Add the behavior to an [Animator object](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator).
|
|
189
197
|
|
|
190
198
|
### Properties (unique: 7/9)
|
|
191
199
|
| Property | Type | Default | Platform | Description |
|
|
@@ -223,6 +231,8 @@ such as push forces or collisions, are applied to it. To define a dynamic behav
|
|
|
223
231
|
---
|
|
224
232
|
|
|
225
233
|
## Ti.UI.iOS.GravityBehavior
|
|
234
|
+
> Full released contract: [Titanium.UI.iOS.GravityBehavior](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.GravityBehavior)
|
|
235
|
+
|
|
226
236
|
> Gravitational force to apply to an item.
|
|
227
237
|
> Extends Ti.Proxy
|
|
228
238
|
> Platforms: ios
|
|
@@ -232,11 +242,11 @@ behavior:
|
|
|
232
242
|
|
|
233
243
|
1. Use the <Titanium.UI.iOS.createGravityBehavior> method to create and define the behavior.
|
|
234
244
|
2. To define a gravity vector, either set the
|
|
235
|
-
[angle](Titanium.UI.iOS.GravityBehavior
|
|
236
|
-
[magnitude](Titanium.UI.iOS.GravityBehavior
|
|
237
|
-
[gravityDirection](Titanium.UI.iOS.GravityBehavior
|
|
238
|
-
3. Use the [addItem](Titanium.UI.iOS.GravityBehavior
|
|
239
|
-
4. Add the behavior to an [Animator object](Titanium.UI.iOS.Animator).
|
|
245
|
+
[angle](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.GravityBehavior) and
|
|
246
|
+
[magnitude](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.GravityBehavior) properties, or set the
|
|
247
|
+
[gravityDirection](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.GravityBehavior) property.
|
|
248
|
+
3. Use the [addItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.GravityBehavior) method to add items to the behavior.
|
|
249
|
+
4. Add the behavior to an [Animator object](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator).
|
|
240
250
|
|
|
241
251
|
You can only define one gravity behavior per animator.
|
|
242
252
|
|
|
@@ -269,6 +279,8 @@ You can only define one gravity behavior per animator.
|
|
|
269
279
|
---
|
|
270
280
|
|
|
271
281
|
## Ti.UI.iOS.PushBehavior
|
|
282
|
+
> Full released contract: [Titanium.UI.iOS.PushBehavior](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.PushBehavior)
|
|
283
|
+
|
|
272
284
|
> Continuous or instantaneous force to apply to an item.
|
|
273
285
|
> Extends Ti.Proxy
|
|
274
286
|
> Platforms: ios
|
|
@@ -278,11 +290,11 @@ define a push behavior:
|
|
|
278
290
|
|
|
279
291
|
1. Use the <Titanium.UI.iOS.createPushBehavior> method to create and define the behavior.
|
|
280
292
|
2. To define a force vector, either set the
|
|
281
|
-
[angle](Titanium.UI.iOS.PushBehavior
|
|
282
|
-
[magnitude](Titanium.UI.iOS.PushBehavior
|
|
283
|
-
[pushDirection](Titanium.UI.iOS.PushBehavior
|
|
284
|
-
3. Use the [addItem](Titanium.UI.iOS.PushBehavior
|
|
285
|
-
4. Add the behavior to an [Animator object](Titanium.UI.iOS.Animator).
|
|
293
|
+
[angle](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.PushBehavior) and
|
|
294
|
+
[magnitude](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.PushBehavior) properties, or set the
|
|
295
|
+
[pushDirection](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.PushBehavior) property.
|
|
296
|
+
3. Use the [addItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.PushBehavior) method to add items to the behavior.
|
|
297
|
+
4. Add the behavior to an [Animator object](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator).
|
|
286
298
|
|
|
287
299
|
### Properties (unique: 6/8)
|
|
288
300
|
| Property | Type | Default | Platform | Description |
|
|
@@ -315,6 +327,8 @@ define a push behavior:
|
|
|
315
327
|
---
|
|
316
328
|
|
|
317
329
|
## Ti.UI.iOS.SnapBehavior
|
|
330
|
+
> Full released contract: [Titanium.UI.iOS.SnapBehavior](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.SnapBehavior)
|
|
331
|
+
|
|
318
332
|
> Dynamic behavior defining an item's movement to a specific point.
|
|
319
333
|
> Extends Ti.Proxy
|
|
320
334
|
> Platforms: ios
|
|
@@ -323,9 +337,9 @@ A snap behavior specifies how an item moves towards a specified point with a spr
|
|
|
323
337
|
effect, ending with an oscillation.
|
|
324
338
|
|
|
325
339
|
1. Use the <Titanium.UI.iOS.createSnapBehavior> method to create the behavior.
|
|
326
|
-
2. Set the [item](Titanium.UI.iOS.SnapBehavior
|
|
327
|
-
[snapPoint](Titanium.UI.iOS.SnapBehavior
|
|
328
|
-
3. Add the behavior to an [Animator object](Titanium.UI.iOS.Animator).
|
|
340
|
+
2. Set the [item](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.SnapBehavior) and
|
|
341
|
+
[snapPoint](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.SnapBehavior) properties.
|
|
342
|
+
3. Add the behavior to an [Animator object](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator).
|
|
329
343
|
|
|
330
344
|
### Properties (unique: 3/5)
|
|
331
345
|
| Property | Type | Default | Platform | Description |
|
|
@@ -350,6 +364,8 @@ effect, ending with an oscillation.
|
|
|
350
364
|
---
|
|
351
365
|
|
|
352
366
|
## Ti.UI.iOS.ViewAttachmentBehavior
|
|
367
|
+
> Full released contract: [Titanium.UI.iOS.ViewAttachmentBehavior](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.ViewAttachmentBehavior)
|
|
368
|
+
|
|
353
369
|
> Dynamic behavior to support connections between two items.
|
|
354
370
|
> Extends Ti.Proxy
|
|
355
371
|
> Platforms: ios
|
|
@@ -358,9 +374,9 @@ A view attachment behavior creates a dynamic connection between two items. To de
|
|
|
358
374
|
attachment behavior:
|
|
359
375
|
|
|
360
376
|
1. Use the <Titanium.UI.iOS.createViewAttachmentBehavior> method to create and define a behavior.
|
|
361
|
-
2. Set the [anchorItem](Titanium.UI.iOS.ViewAttachmentBehavior
|
|
362
|
-
[item](Titanium.UI.iOS.ViewAttachmentBehavior
|
|
363
|
-
3. Add the behavior to the [Animator object](Titanium.UI.iOS.Animator).
|
|
377
|
+
2. Set the [anchorItem](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.ViewAttachmentBehavior) and
|
|
378
|
+
[item](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.ViewAttachmentBehavior) properties.
|
|
379
|
+
3. Add the behavior to the [Animator object](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.Animator).
|
|
364
380
|
|
|
365
381
|
To create a dynamic connection between an item and anchor point, use <Titanium.UI.iOS.AnchorAttachmentBehavior>.
|
|
366
382
|
|