@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
|
@@ -16,13 +16,15 @@
|
|
|
16
16
|
<!-- TOC-END -->
|
|
17
17
|
|
|
18
18
|
## Ti.UI.TextField
|
|
19
|
+
> Full released contract: [Titanium.UI.TextField](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TextField)
|
|
20
|
+
|
|
19
21
|
> A single line text field.
|
|
20
22
|
> Extends Ti.UI.View
|
|
21
23
|
> Platforms: both
|
|
22
24
|
|
|
23
25
|
| Android | iOS |
|
|
24
26
|
| ------- | --- |
|
|
25
|
-
|
|
|
27
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TextField) | [iOS API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TextField) |
|
|
26
28
|
|
|
27
29
|
Use the <Titanium.UI.createTextField> method or **`<TextField>`** Alloy element to create a text field.
|
|
28
30
|
|
|
@@ -56,7 +58,7 @@ In iOS 11+, `click` event in text field is not fired due to changes from apple.
|
|
|
56
58
|
| hinttextid | String | — | both | Key identifying a string from the locale file to use for the [hintText](Titaniu… |
|
|
57
59
|
| hintType | Number | <Titanium.UI.HINT_TYPE_STATIC> | android | Hint type to display on the text field. |
|
|
58
60
|
| inputType | Array<Number> | Empty array. If not defined, default is Keyboard type specified by <Titanium.UI.TextField.keyboardType>. | android | Input type to accept in the text field. Also influences the Keyboard type to di… |
|
|
59
|
-
| keyboardToolbar | Array<Titanium.UI.View> \| Ti.UI.Toolbar | — | ios | Array of toolbar button objects or a [toolbar](Titanium.UI.Toolbar) to be used … |
|
|
61
|
+
| keyboardToolbar | Array<Titanium.UI.View> \| Ti.UI.Toolbar | — | ios | Array of toolbar button objects or a [toolbar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Toolbar) to be used … |
|
|
60
62
|
| keyboardToolbarColor | String \| Ti.UI.Color | — | ios | Color of the keyboard toolbar if keyboardToolbar is an array, as a color name o… |
|
|
61
63
|
| keyboardToolbarHeight | Number | — | ios | Height of the keyboard toolbar if keyboardToolbar is an array. |
|
|
62
64
|
| keyboardType | Number | <Titanium.UI.KEYBOARD_TYPE_DEFAULT> | both | Keyboard type to display when this text field is focused. |
|
|
@@ -131,13 +133,15 @@ In iOS 11+, `click` event in text field is not fired due to changes from apple.
|
|
|
131
133
|
---
|
|
132
134
|
|
|
133
135
|
## Ti.UI.TextArea
|
|
136
|
+
> Full released contract: [Titanium.UI.TextArea](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TextArea)
|
|
137
|
+
|
|
134
138
|
> A multiline text field that supports editing and scrolling.
|
|
135
139
|
> Extends Ti.UI.View
|
|
136
140
|
> Platforms: both
|
|
137
141
|
|
|
138
142
|
| Android | iOS |
|
|
139
143
|
| ------- | --- |
|
|
140
|
-
|
|
|
144
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TextArea) | [iOS API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TextArea) |
|
|
141
145
|
|
|
142
146
|
Use the <Titanium.UI.createTextArea> method or **<TextArea>** Alloy element to create a text area.
|
|
143
147
|
|
|
@@ -171,13 +175,13 @@ In iOS 11+, `click` event in text area is not fired due to changes from apple. U
|
|
|
171
175
|
| hintType | Number | <Titanium.UI.HINT_TYPE_STATIC> | android | Hint type to display on the text field. |
|
|
172
176
|
| handleLinks | Boolean | false | ios | Specifies if the text area should allow user interaction with the given URL in … |
|
|
173
177
|
| html | String | — | both | Pass a HTML-based string and it will be formatted accordingly. |
|
|
174
|
-
| keyboardToolbar | Array<Titanium.UI.View> \| Ti.UI.Toolbar | — | ios | Array of toolbar button objects or a [toolbar](Titanium.UI.Toolbar) to be used … |
|
|
178
|
+
| keyboardToolbar | Array<Titanium.UI.View> \| Ti.UI.Toolbar | — | ios | Array of toolbar button objects or a [toolbar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Toolbar) to be used … |
|
|
175
179
|
| keyboardToolbarColor | String \| Ti.UI.Color | — | ios | Color of the keyboard toolbar if keyboardToolbar is an array, as a color name o… |
|
|
176
180
|
| keyboardToolbarHeight | Number | — | ios | Height of the keyboard toolbar if keyboardToolbar is an array. |
|
|
177
181
|
| keyboardType | Number | <Titanium.UI.KEYBOARD_DEFAULT> | both | Keyboard type to display when this text area is focused. |
|
|
178
|
-
| lines | Number | 1 |
|
|
182
|
+
| lines | Number | 1 | both | Number of lines tall the text area height will be, if set. |
|
|
179
183
|
| maxLength | Number | -1 | both | Maximum length of text field input. |
|
|
180
|
-
| maxLines | Number | -1 |
|
|
184
|
+
| maxLines | Number | -1 | both | Maximum line count of text field input. |
|
|
181
185
|
| padding | Padding | — | both | Sets the left and right padding of this TextArea. The text will always be verti… |
|
|
182
186
|
| returnKeyType | Number | <Titanium.UI.RETURNKEY_DEFAULT> | ios | Specifies the text to display on the keyboard `Return` key when this text area … |
|
|
183
187
|
| scrollsToTop | Boolean | true | ios | Controls whether the scroll-to-top gesture is effective. |
|
|
@@ -187,7 +191,7 @@ In iOS 11+, `click` event in text area is not fired due to changes from apple. U
|
|
|
187
191
|
| value | String | — | both | Value of this text area, which may be set programmatically and modified by the … |
|
|
188
192
|
| scrollable | Boolean | true | ios | Determines whether this text area can be scrolled. |
|
|
189
193
|
| selection | textAreaSelectedParams | — | both | Returns the currently selected text of the text area. |
|
|
190
|
-
| verticalAlign | Number \| String | <Titanium.UI.TEXT_VERTICAL_ALIGNMENT_TOP> |
|
|
194
|
+
| verticalAlign | Number \| String | <Titanium.UI.TEXT_VERTICAL_ALIGNMENT_TOP> | both | Vertical alignment within this text area. |
|
|
191
195
|
|
|
192
196
|
|
|
193
197
|
### Methods (4)
|
|
@@ -240,17 +244,18 @@ In iOS 11+, `click` event in text area is not fired due to changes from apple. U
|
|
|
240
244
|
| length | Number | Number of characters selected. |
|
|
241
245
|
|
|
242
246
|
---
|
|
243
|
-
|
|
244
247
|
## Ti.UI.SearchBar
|
|
248
|
+
> Full released contract: [Titanium.UI.SearchBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.SearchBar)
|
|
249
|
+
|
|
245
250
|
> A specialized text field for entering search text.
|
|
246
251
|
> Extends Ti.UI.View
|
|
247
252
|
> Platforms: both
|
|
248
253
|
|
|
249
254
|
| Android | iOS |
|
|
250
255
|
| ------- | --- |
|
|
251
|
-
|
|
|
256
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.SearchBar) | [iOS API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.SearchBar) |
|
|
252
257
|
|
|
253
|
-
Search bars are most commonly used for filtering the rows in a [TableView](Titanium.UI.TableView) and [ListView](Titanium.UI.ListView). You can add a search bar to a table view via its [search](Titanium.UI.TableView
|
|
258
|
+
Search bars are most commonly used for filtering the rows in a [TableView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TableView) and [ListView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ListView). You can add a search bar to a table view via its [search](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TableView) property. You can add a search bar to a list view via its [searchBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.SearchBar) property.
|
|
254
259
|
|
|
255
260
|
A search bar can also be used on its own.
|
|
256
261
|
|
|
@@ -259,7 +264,7 @@ Use the <Titanium.UI.createSearchBar> method or Alloy **`<SearchBar>`** element
|
|
|
259
264
|
### Android Notes
|
|
260
265
|
|
|
261
266
|
|
|
262
|
-
|
|
267
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.SearchBar API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.SearchBar).
|
|
263
268
|
|
|
264
269
|
### Properties (unique: 23/95)
|
|
265
270
|
| Property | Type | Default | Platform | Description |
|
|
@@ -286,7 +291,7 @@ Use the <Titanium.UI.createSearchBar> method or Alloy **`<SearchBar>`** element
|
|
|
286
291
|
| showCancel | Boolean | false | both | Determines whether the cancel button is displayed. |
|
|
287
292
|
| style | Number | Titanium.UI.iOS.SEARCH_BAR_STYLE_PROMINENT | ios | Determines the style of the search bar. |
|
|
288
293
|
| value | String | — | both | Value of the search bar. |
|
|
289
|
-
| tokens | Array<String> |
|
|
294
|
+
| tokens | Array<String> | `[]` | ios | Search text-field tokens; requires iOS 13 or later. |
|
|
290
295
|
|
|
291
296
|
|
|
292
297
|
### Methods (5)
|
|
@@ -329,13 +334,15 @@ Use the <Titanium.UI.createSearchBar> method or Alloy **`<SearchBar>`** element
|
|
|
329
334
|
---
|
|
330
335
|
|
|
331
336
|
## Ti.UI.AttributedString
|
|
337
|
+
> Full released contract: [Titanium.UI.AttributedString](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.AttributedString)
|
|
338
|
+
|
|
332
339
|
> An attributed string proxy manages character strings and associated sets of attributes (for example, font and foregroundcolor) that apply to individual characters or ranges of characters in the string.
|
|
333
340
|
> Extends Ti.Proxy
|
|
334
341
|
> Platforms: both
|
|
335
342
|
|
|
336
343
|
The AttributedString proxy is created with the <Titanium.UI.createAttributedString> method.
|
|
337
344
|
|
|
338
|
-
The `text` property must be set initially in the constructor when creating an attributed string. The [attributes](Titanium.UI.AttributedString
|
|
345
|
+
The `text` property must be set initially in the constructor when creating an attributed string. The [attributes](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.AttributedString) can either be set in the constructor or after it has been created.
|
|
339
346
|
|
|
340
347
|
For examples of Attributed Strings, see the [Attributed Strings guide](https://titaniumsdk.com/docs/build/ui).
|
|
341
348
|
|
|
@@ -349,7 +356,7 @@ For examples of Attributed Strings, see the [Attributed Strings guide](https://t
|
|
|
349
356
|
### Methods (1)
|
|
350
357
|
| Method | Returns | Platform | Description |
|
|
351
358
|
|--------|---------|----------|-------------|
|
|
352
|
-
| addAttribute(attribute) | void | both | Adds an [attribute](Attribute) with the given name and value to the characters … |
|
|
359
|
+
| addAttribute(attribute) | void | both | Adds an [attribute](https://titaniumsdk.com/docs/sdk/13.4.1/Attribute) with the given name and value to the characters … |
|
|
353
360
|
|
|
354
361
|
|
|
355
362
|
### Related Types
|
|
@@ -366,6 +373,8 @@ For examples of Attributed Strings, see the [Attributed Strings guide](https://t
|
|
|
366
373
|
---
|
|
367
374
|
|
|
368
375
|
## Ti.UI.Color
|
|
376
|
+
> Full released contract: [Titanium.UI.Color](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Color)
|
|
377
|
+
|
|
369
378
|
> Represents a color used for UI components.
|
|
370
379
|
> Extends Ti.Proxy
|
|
371
380
|
> Platforms: both
|
|
@@ -382,6 +391,8 @@ This type may be used on iOS for assignment to any property typically taking a S
|
|
|
382
391
|
---
|
|
383
392
|
|
|
384
393
|
## Ti.UI.Clipboard
|
|
394
|
+
> Full released contract: [Titanium.UI.Clipboard](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Clipboard)
|
|
395
|
+
|
|
385
396
|
> A module used for accessing clipboard data.
|
|
386
397
|
> Extends Ti.Module
|
|
387
398
|
> Platforms: both
|
|
@@ -396,7 +407,7 @@ When working with text, either of the `getData()`/`setData()` methods may be use
|
|
|
396
407
|
Android currently only supports text data to be stored.
|
|
397
408
|
|
|
398
409
|
|
|
399
|
-
|
|
410
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Clipboard API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Clipboard).
|
|
400
411
|
|
|
401
412
|
### Properties (unique: 3/6)
|
|
402
413
|
| Property | Type | Default | Platform | Description |
|
|
@@ -438,13 +449,15 @@ Android currently only supports text data to be stored.
|
|
|
438
449
|
---
|
|
439
450
|
|
|
440
451
|
## Ti.UI.Picker
|
|
452
|
+
> Full released contract: [Titanium.UI.Picker](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Picker)
|
|
453
|
+
|
|
441
454
|
> A control used to select one or more fixed values.
|
|
442
455
|
> Extends Ti.UI.View
|
|
443
456
|
> Platforms: both
|
|
444
457
|
|
|
445
458
|
| Android | iOS |
|
|
446
459
|
| ------- | --- |
|
|
447
|
-
|
|
|
460
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Picker) | [iOS API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Picker) |
|
|
448
461
|
|
|
449
462
|
Use the <Titanium.UI.createPicker> method or Alloy **`<Picker>`** element to create a picker control.
|
|
450
463
|
|
|
@@ -452,7 +465,7 @@ On Android, the `useSpinner` property must be enabled to support multiple column
|
|
|
452
465
|
|
|
453
466
|
On iOS, the `height` property is only available in iOS 9 and later. By default, the size of the picker, including its background, is fixed at the
|
|
454
467
|
|
|
455
|
-
|
|
468
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Picker API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Picker).
|
|
456
469
|
|
|
457
470
|
### Properties (unique: 24/78)
|
|
458
471
|
| Property | Type | Default | Platform | Description |
|
|
@@ -516,6 +529,8 @@ On iOS, the `height` property is only available in iOS 9 and later. By default,
|
|
|
516
529
|
---
|
|
517
530
|
|
|
518
531
|
## Ti.UI.PickerColumn
|
|
532
|
+
> Full released contract: [Titanium.UI.PickerColumn](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.PickerColumn)
|
|
533
|
+
|
|
519
534
|
> A picker column, representing a selectable group of items in a <Titanium.UI.Picker>.
|
|
520
535
|
> Extends Ti.UI.View
|
|
521
536
|
> Platforms: both
|
|
@@ -557,6 +572,8 @@ See <Titanium.UI.Picker> for further examples of usage.
|
|
|
557
572
|
---
|
|
558
573
|
|
|
559
574
|
## Ti.UI.PickerRow
|
|
575
|
+
> Full released contract: [Titanium.UI.PickerRow](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.PickerRow)
|
|
576
|
+
|
|
560
577
|
> A picker row, representing a selectable item in a <Titanium.UI.Picker>.
|
|
561
578
|
> Extends Ti.UI.View
|
|
562
579
|
> Platforms: both
|
|
@@ -20,6 +20,8 @@
|
|
|
20
20
|
<!-- TOC-END -->
|
|
21
21
|
|
|
22
22
|
## Ti.UI.View
|
|
23
|
+
> Full released contract: [Titanium.UI.View](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.View)
|
|
24
|
+
|
|
23
25
|
> An empty drawing surface or container
|
|
24
26
|
> Extends Ti.Proxy
|
|
25
27
|
> Platforms: both
|
|
@@ -139,6 +141,8 @@
|
|
|
139
141
|
---
|
|
140
142
|
|
|
141
143
|
## Ti.UI.Label
|
|
144
|
+
> Full released contract: [Titanium.UI.Label](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Label)
|
|
145
|
+
|
|
142
146
|
> A text label, with an optional background image.
|
|
143
147
|
> Extends Ti.UI.View
|
|
144
148
|
> Platforms: both
|
|
@@ -188,6 +192,8 @@
|
|
|
188
192
|
---
|
|
189
193
|
|
|
190
194
|
## Ti.UI.Button
|
|
195
|
+
> Full released contract: [Titanium.UI.Button](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Button)
|
|
196
|
+
|
|
191
197
|
> A button widget that has four states: normal, disabled, focused and selected.
|
|
192
198
|
> Extends Ti.UI.View
|
|
193
199
|
> Platforms: both
|
|
@@ -231,6 +237,8 @@
|
|
|
231
237
|
---
|
|
232
238
|
|
|
233
239
|
## Ti.UI.ImageView
|
|
240
|
+
> Full released contract: [Titanium.UI.ImageView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ImageView)
|
|
241
|
+
|
|
234
242
|
> A view to display a single image or series of animated images.
|
|
235
243
|
> Extends Ti.UI.View
|
|
236
244
|
> Platforms: both
|
|
@@ -280,6 +288,8 @@
|
|
|
280
288
|
---
|
|
281
289
|
|
|
282
290
|
## Ti.UI.ScrollView
|
|
291
|
+
> Full released contract: [Titanium.UI.ScrollView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ScrollView)
|
|
292
|
+
|
|
283
293
|
> A view that contains a horizontally and/or vertically-scrollable region of content.
|
|
284
294
|
> Extends Ti.UI.View
|
|
285
295
|
> Platforms: both
|
|
@@ -332,6 +342,8 @@
|
|
|
332
342
|
---
|
|
333
343
|
|
|
334
344
|
## Ti.UI.ScrollableView
|
|
345
|
+
> Full released contract: [Titanium.UI.ScrollableView](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ScrollableView)
|
|
346
|
+
|
|
335
347
|
> A view that encapsulates a horizontally-scrolling set of child views, known as pages, navigable using its built-in horizontal swipe gestures.
|
|
336
348
|
> Extends Ti.UI.View
|
|
337
349
|
> Platforms: both
|
|
@@ -389,6 +401,8 @@
|
|
|
389
401
|
---
|
|
390
402
|
|
|
391
403
|
## Ti.UI.ActivityIndicator
|
|
404
|
+
> Full released contract: [Titanium.UI.ActivityIndicator](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ActivityIndicator)
|
|
405
|
+
|
|
392
406
|
> An activity indicator that lets the user know an action is taking place.
|
|
393
407
|
> Extends Ti.UI.View
|
|
394
408
|
> Platforms: both
|
|
@@ -420,6 +434,8 @@
|
|
|
420
434
|
---
|
|
421
435
|
|
|
422
436
|
## Ti.UI.ActivityIndicatorStyle
|
|
437
|
+
> Full released contract: [Titanium.UI.ActivityIndicatorStyle](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ActivityIndicatorStyle)
|
|
438
|
+
|
|
423
439
|
> A set of constants for the styles available for <Titanium.UI.ActivityIndicator> objects.
|
|
424
440
|
> Extends Ti.Module
|
|
425
441
|
> Platforms: both
|
|
@@ -435,6 +451,8 @@
|
|
|
435
451
|
---
|
|
436
452
|
|
|
437
453
|
## Ti.UI.ProgressBar
|
|
454
|
+
> Full released contract: [Titanium.UI.ProgressBar](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.ProgressBar)
|
|
455
|
+
|
|
438
456
|
> A progress bar.
|
|
439
457
|
> Extends Ti.UI.View
|
|
440
458
|
> Platforms: both
|
|
@@ -459,6 +477,8 @@
|
|
|
459
477
|
---
|
|
460
478
|
|
|
461
479
|
## Ti.UI.Slider
|
|
480
|
+
> Full released contract: [Titanium.UI.Slider](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Slider)
|
|
481
|
+
|
|
462
482
|
> A slider component with a draggable thumb.
|
|
463
483
|
> Extends Ti.UI.View
|
|
464
484
|
> Platforms: both
|
|
@@ -496,7 +516,7 @@
|
|
|
496
516
|
### Methods (1)
|
|
497
517
|
| Method | Returns | Platform | Description |
|
|
498
518
|
|--------|---------|----------|-------------|
|
|
499
|
-
| setValue(value, options) | void | ios | Sets the [value](Titanium.UI.Slider
|
|
519
|
+
| setValue(value, options) | void | ios | Sets the [value](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Slider) proper… |
|
|
500
520
|
|
|
501
521
|
### Events (4)
|
|
502
522
|
| Event | Platform | Description |
|
|
@@ -509,6 +529,8 @@
|
|
|
509
529
|
---
|
|
510
530
|
|
|
511
531
|
## Ti.UI.Switch
|
|
532
|
+
> Full released contract: [Titanium.UI.Switch](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Switch)
|
|
533
|
+
|
|
512
534
|
> An on/off switch control.
|
|
513
535
|
> Extends Ti.UI.View
|
|
514
536
|
> Platforms: both
|
|
@@ -544,6 +566,8 @@
|
|
|
544
566
|
---
|
|
545
567
|
|
|
546
568
|
## Ti.UI.MaskedImage
|
|
569
|
+
> Full released contract: [Titanium.UI.MaskedImage](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.MaskedImage)
|
|
570
|
+
|
|
547
571
|
> A control that displays an image composited with a background image or color.
|
|
548
572
|
> Extends Ti.UI.View
|
|
549
573
|
> Platforms: both
|
|
@@ -562,6 +586,8 @@
|
|
|
562
586
|
---
|
|
563
587
|
|
|
564
588
|
## Ti.UI.RefreshControl
|
|
589
|
+
> Full released contract: [Titanium.UI.RefreshControl](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.RefreshControl)
|
|
590
|
+
|
|
565
591
|
> The RefreshControl is a representation of the native iOS [UIRefreshControl](https://developer.apple.com/documentation/uikit/uirefreshcontrol) and Android [SwipeRefreshLayout](https://developer.android.com/reference/android/support/v4/widget/SwipeRefreshLayout.html).
|
|
566
592
|
> Extends Ti.Proxy
|
|
567
593
|
> Platforms: both
|
|
@@ -14,6 +14,8 @@
|
|
|
14
14
|
<!-- TOC-END -->
|
|
15
15
|
|
|
16
16
|
## Ti.UI.Window
|
|
17
|
+
> Full released contract: [Titanium.UI.Window](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Window)
|
|
18
|
+
|
|
17
19
|
> The Window is an empty drawing surface or container.
|
|
18
20
|
> Extends Ti.UI.View
|
|
19
21
|
> Platforms: both
|
|
@@ -24,13 +26,13 @@ A window is a top-level container which can contain other views. Windows can be
|
|
|
24
26
|
|
|
25
27
|
Windows *contain* other views, but in general they are not *contained* inside other views. There are a few specialized views that manage windows:
|
|
26
28
|
|
|
27
|
-
* [NavigationWindow](Titanium.UI.NavigationWindow)
|
|
28
|
-
* [SplitWindow](Titanium.UI.iOS.SplitWindow)
|
|
29
|
-
* [TabGroup](Titanium.UI.TabGroup)
|
|
30
|
-
* [Tab](Titanium.UI.Tab)
|
|
29
|
+
* [NavigationWindow](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.NavigationWindow)
|
|
30
|
+
* [SplitWindow](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.iOS.SplitWindow)
|
|
31
|
+
* [TabGroup](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabGroup)
|
|
32
|
+
* [Tab](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Tab)
|
|
31
33
|
|
|
32
34
|
|
|
33
|
-
|
|
35
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Window API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Window).
|
|
34
36
|
|
|
35
37
|
### Properties (unique: 72/138)
|
|
36
38
|
| Property | Type | Default | Platform | Description |
|
|
@@ -222,6 +224,8 @@ Also referenced by this API, documented elsewhere: `Dictionary`, [Font](api-ui-l
|
|
|
222
224
|
---
|
|
223
225
|
|
|
224
226
|
## Ti.UI.NavigationWindow
|
|
227
|
+
> Full released contract: [Titanium.UI.NavigationWindow](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.NavigationWindow)
|
|
228
|
+
|
|
225
229
|
> A `NavigationWindow` implements a specialized view that manages the navigation of hierarchical content.
|
|
226
230
|
> Extends Ti.UI.Window
|
|
227
231
|
> Platforms: both
|
|
@@ -262,24 +266,26 @@ This object is not meant to be added to other windows. However, it can be used w
|
|
|
262
266
|
---
|
|
263
267
|
|
|
264
268
|
## Ti.UI.TabGroup
|
|
269
|
+
> Full released contract: [Titanium.UI.TabGroup](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabGroup)
|
|
270
|
+
|
|
265
271
|
> A tabbed group of windows.
|
|
266
272
|
> Extends Ti.UI.Window
|
|
267
273
|
> Platforms: both
|
|
268
274
|
|
|
269
275
|
| Android | iOS |
|
|
270
276
|
| ------- | --- |
|
|
271
|
-
|
|
|
277
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabGroup) | |
|
|
272
278
|
|
|
273
|
-
A tab group can contain one or more [Tab](Titanium.UI.Tab) objects, each of which has an associated tab control that is used to bring it into focus.
|
|
279
|
+
A tab group can contain one or more [Tab](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Tab) objects, each of which has an associated tab control that is used to bring it into focus.
|
|
274
280
|
|
|
275
281
|
Use the <Titanium.UI.createTabGroup> method or **`<TabGroup>`** Alloy element to create a tab group that, in turn, contains one or more `<Tab>` elements.
|
|
276
282
|
|
|
277
|
-
You can add tabs to the group using [addTab](Titanium.UI.TabGroup
|
|
283
|
+
You can add tabs to the group using [addTab](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabGroup), and programmatically switch to a specific tab using [setActiveTab](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabGroup).
|
|
278
284
|
|
|
279
285
|
### Platform Implementation Notes
|
|
280
286
|
|
|
281
287
|
|
|
282
|
-
|
|
288
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.TabGroup API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabGroup).
|
|
283
289
|
|
|
284
290
|
### Properties (unique: 43/136)
|
|
285
291
|
| Property | Type | Default | Platform | Description |
|
|
@@ -405,7 +411,9 @@ Also referenced by this API, documented elsewhere: `Dictionary`, [Font](api-ui-l
|
|
|
405
411
|
---
|
|
406
412
|
|
|
407
413
|
## Ti.UI.Tab
|
|
408
|
-
>
|
|
414
|
+
> Full released contract: [Titanium.UI.Tab](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Tab)
|
|
415
|
+
|
|
416
|
+
> A tab instance for a [TabGroup](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabGroup).
|
|
409
417
|
> Extends Ti.UI.View
|
|
410
418
|
> Platforms: both
|
|
411
419
|
|
|
@@ -413,7 +421,7 @@ A `TabGroup` tab instance. Each tab includes a button and one or more windows, w
|
|
|
413
421
|
|
|
414
422
|
Use the <Titanium.UI.createTab> method or **`<Tab>`** Alloy element to create a tab.
|
|
415
423
|
|
|
416
|
-
Use [TabGroup.setActiveTab](Titanium.UI.TabGroup
|
|
424
|
+
Use [TabGroup.setActiveTab](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.TabGroup) to switch between tabs in a tab group.
|
|
417
425
|
|
|
418
426
|
The behavior of tabs and tab groups follows the platform's native navigation style, which varies significantly between platforms.
|
|
419
427
|
|
|
@@ -421,7 +429,7 @@ The behavior of tabs and tab groups follows the platform's native navigation sty
|
|
|
421
429
|
|
|
422
430
|
On iOS, the tab maintains a stack of windows. Windows on top of the stack can partially or totally obscure windows lower in the stack. Calling
|
|
423
431
|
|
|
424
|
-
|
|
432
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.Tab API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Tab).
|
|
425
433
|
|
|
426
434
|
### Properties (unique: 20/57)
|
|
427
435
|
| Property | Type | Default | Platform | Description |
|
|
@@ -459,7 +467,7 @@ On iOS, the tab maintains a stack of windows. Windows on top of the stack can pa
|
|
|
459
467
|
### Events (3)
|
|
460
468
|
| Event | Platform | Description |
|
|
461
469
|
|-------|----------|-------------|
|
|
462
|
-
| click |
|
|
470
|
+
| click | android | Fired when this tab is clicked in the tab group. |
|
|
463
471
|
| unselected | both | Fired when the tab is no longer selected. |
|
|
464
472
|
| selected | both | Fired when the tab is selected. |
|
|
465
473
|
|
|
@@ -505,13 +513,15 @@ On iOS, the tab maintains a stack of windows. Windows on top of the stack can pa
|
|
|
505
513
|
---
|
|
506
514
|
|
|
507
515
|
## Ti.UI.AlertDialog
|
|
516
|
+
> Full released contract: [Titanium.UI.AlertDialog](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.AlertDialog)
|
|
517
|
+
|
|
508
518
|
> An alert dialog is a modal view that includes an optional title, a message and buttons, positioned in the middle of the display.
|
|
509
519
|
> Extends Ti.UI.View
|
|
510
520
|
> Platforms: both
|
|
511
521
|
|
|
512
522
|
| Android | iOS |
|
|
513
523
|
| ------- | --- |
|
|
514
|
-
|
|
|
524
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.AlertDialog) | [iOS API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.AlertDialog) |
|
|
515
525
|
|
|
516
526
|
An alert dialog is created using <Titanium.UI.createAlertDialog> or **`<AlertDialog>`** Alloy element.
|
|
517
527
|
|
|
@@ -521,7 +531,7 @@ Although this dialog always appears in the middle of the display (not touching t
|
|
|
521
531
|
|
|
522
532
|
On Android, the default alert dialog displays text information, via a title and message, without any buttons. As the user can use the system hardware `back` button to dismiss it, a button is optional.
|
|
523
533
|
|
|
524
|
-
|
|
534
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.AlertDialog API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.AlertDialog).
|
|
525
535
|
|
|
526
536
|
### Properties (unique: 36/60)
|
|
527
537
|
| Property | Type | Default | Platform | Description |
|
|
@@ -587,13 +597,15 @@ On Android, the default alert dialog displays text information, via a title and
|
|
|
587
597
|
---
|
|
588
598
|
|
|
589
599
|
## Ti.UI.OptionDialog
|
|
600
|
+
> Full released contract: [Titanium.UI.OptionDialog](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.OptionDialog)
|
|
601
|
+
|
|
590
602
|
> An option dialog is a modal view that includes a message and one or more option items positioned in the middle of the display on Android and at the bottom edge on iOS. On Android, buttons may be added below the options.
|
|
591
603
|
> Extends Ti.UI.View
|
|
592
604
|
> Platforms: both
|
|
593
605
|
|
|
594
606
|
| Android | iPhone | iPad |
|
|
595
607
|
| ------- | ------ | ---- |
|
|
596
|
-
|
|
|
608
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.OptionDialog) | [iPhone API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.OptionDialog) | [iPad API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.OptionDialog) |
|
|
597
609
|
|
|
598
610
|
An option dialog is created using <Titanium.UI.createOptionDialog> or Alloy `<OptionDialog>` element. See Examples below for usage.
|
|
599
611
|
|
|
@@ -604,7 +616,7 @@ This dialog is presented differently on each platform, as described below.
|
|
|
604
616
|
On Android, the dialog is shown in the middle of the display (not touching the edges), with the option items represented in a picker. The previously-selected, or default, item can be set on creation.
|
|
605
617
|
|
|
606
618
|
|
|
607
|
-
|
|
619
|
+
Complete overview, setup, examples and version restrictions: [official Titanium.UI.OptionDialog API](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.OptionDialog).
|
|
608
620
|
|
|
609
621
|
### Properties (unique: 10/35)
|
|
610
622
|
| Property | Type | Default | Platform | Description |
|
|
@@ -657,13 +669,15 @@ On Android, the dialog is shown in the middle of the display (not touching the e
|
|
|
657
669
|
---
|
|
658
670
|
|
|
659
671
|
## Ti.UI.Notification
|
|
672
|
+
> Full released contract: [Titanium.UI.Notification](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Notification)
|
|
673
|
+
|
|
660
674
|
> A toast notification.
|
|
661
675
|
> Extends Ti.Proxy
|
|
662
676
|
> Platforms: android
|
|
663
677
|
|
|
664
678
|
| Android | iOS |
|
|
665
679
|
| ------- | --- |
|
|
666
|
-
|
|
|
680
|
+
| [Android API reference](https://titaniumsdk.com/docs/sdk/13.4.1/Titanium.UI.Notification) | |
|
|
667
681
|
|
|
668
682
|
A toast notification is an unobtrusive, pop-up notification that does not block the UI. Use the <Titanium.UI.createNotification> method or **`<Notification>`** Alloy element to create a Toast notification.
|
|
669
683
|
|