@maccesar/titools 4.4.0 → 4.4.2

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.
Files changed (39) hide show
  1. package/README.md +9 -12
  2. package/package.json +1 -1
  3. package/skills/purgetss/SKILL.md +4 -9
  4. package/skills/ti-api/references/api-core.md +24 -69
  5. package/skills/ti-api/references/api-data-network.md +18 -63
  6. package/skills/ti-api/references/api-media.md +15 -49
  7. package/skills/ti-api/references/api-modules-coremotion-urlsession.md +6 -20
  8. package/skills/ti-api/references/api-modules-map.md +17 -40
  9. package/skills/ti-api/references/api-modules-nfc.md +23 -56
  10. package/skills/ti-api/references/api-ui-android.md +16 -37
  11. package/skills/ti-api/references/api-ui-extras.md +28 -72
  12. package/skills/ti-api/references/api-ui-lists.md +14 -35
  13. package/skills/ti-api/references/api-ui-text-input.md +13 -39
  14. package/skills/ti-api/references/api-ui-windows-navigation.md +17 -43
  15. package/skills/ti-api/references/api-xml-global.md +25 -60
  16. package/skills/ti-expert/SKILL.md +8 -11
  17. package/skills/ti-expert/references/adaptive-layouts.md +15 -43
  18. package/skills/ti-expert/references/alloy-builtins.md +1 -4
  19. package/skills/ti-expert/references/alloy-structure.md +4 -12
  20. package/skills/ti-expert/references/anti-patterns.md +16 -45
  21. package/skills/ti-expert/references/code-conventions.md +2 -6
  22. package/skills/ti-expert/references/controller-patterns.md +1 -3
  23. package/skills/ti-expert/references/examples.md +3 -10
  24. package/skills/ti-expert/references/feedback-migration.md +17 -39
  25. package/skills/ti-expert/references/feedback-surfaces.md +19 -48
  26. package/skills/ti-expert/references/feedback-widget-contracts.md +31 -69
  27. package/skills/ti-expert/references/file-type-association.md +265 -0
  28. package/skills/ti-expert/references/migration-patterns.md +8 -18
  29. package/skills/ti-expert/references/sharing.md +227 -0
  30. package/skills/ti-expert/references/theming.md +20 -45
  31. package/skills/ti-guides/references/coding-best-practices.md +1 -2
  32. package/skills/ti-guides/references/style-and-conventions.md +1 -2
  33. package/skills/ti-howtos/references/debugging-profiling.md +1 -2
  34. package/skills/ti-howtos/references/location-and-maps.md +1 -2
  35. package/skills/ti-howtos/references/using-modules.md +1 -2
  36. package/skills/ti-howtos/references/web-content-integration.md +1 -2
  37. package/skills/ti-howtos/references/webpack-build-pipeline.md +1 -2
  38. package/skills/ti-ui/references/listviews-and-performance.md +5 -10
  39. package/skills/ti-ui/references/orientation.md +1 -2
@@ -24,21 +24,13 @@
24
24
  > Extends Ti.Proxy
25
25
  > Platforms: both
26
26
 
27
- An animation object describes the properties of an animation. At its most basic, an animation
28
- object represents a single-phase animation with an end state and a duration.
27
+ 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.
29
28
 
30
- When [animate](Titanium.UI.View.animate) is called on a [View](Titanium.UI.View), the view is
31
- animated from its current state to the state described by the animation object. The properties
32
- that can be animated include the view's position, size, colors, transformation matrix and opacity.
29
+ When [animate](Titanium.UI.View.animate) is called on a [View](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.
33
30
 
34
- You can also specify an animation curve or *easing function* to control the pace of the
35
- animation. To use an easing function, set the animation's `curve` property to one of the
36
- `ANIMATION_CURVE` constants defined in <Titanium.UI>. For example,
37
- [ANIMATION_CURVE_EASE_IN](Titanium.UI.ANIMATION_CURVE_EASE_IN) specifies an animation that
38
- starts slowly and then speeds up.
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.ANIMATION_CURVE_EASE_IN) specifies an animation that starts slowly and then speeds up.
39
32
 
40
- Animations can be set to reverse themselves automatically on completion, and to repeat a given
41
- number of times. For more complicated effects, multiple animations can be combined in sequence,
33
+ 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,
42
34
 
43
35
  *(See full overview in titanium-docs)*
44
36
 
@@ -100,8 +92,7 @@ number of times. For more complicated effects, multiple animations can be combin
100
92
  > Extends Ti.Proxy
101
93
  > Platforms: both
102
94
 
103
- A 2D matrix is used to rotate, scale, translate, or skew the objects in a two-dimensional space.
104
- A 2D affine transformation can be represented by a 3 by 3 matrix:
95
+ A 2D matrix is used to rotate, scale, translate, or skew the objects in a two-dimensional space. A 2D affine transformation can be represented by a 3 by 3 matrix:
105
96
 
106
97
  ### Properties (unique: 6/9)
107
98
  | Property | Type | Default | Platform | Description |
@@ -131,12 +122,9 @@ A 2D affine transformation can be represented by a 3 by 3 matrix:
131
122
  > Extends Ti.Proxy
132
123
  > Platforms: ios
133
124
 
134
- The 3D Matrix is created by <Titanium.UI.createMatrix3D>. A 3D transform is
135
- used to rotate, scale, translate, or skew the objects in three-dimensional
136
- space. A 3D transform is represented by a 4 by 4 matrix.
125
+ The 3D Matrix is created by <Titanium.UI.createMatrix3D>. A 3D transform is used to rotate, scale, translate, or skew the objects in three-dimensional space. A 3D transform is represented by a 4 by 4 matrix.
137
126
 
138
- You create an `identity matrix` by creating a 3D Matrix with an empty
139
- constructor.
127
+ You create an `identity matrix` by creating a 3D Matrix with an empty constructor.
140
128
 
141
129
  ### Properties (unique: 16/18)
142
130
  | Property | Type | Default | Platform | Description |
@@ -178,16 +166,13 @@ constructor.
178
166
 
179
167
  Use the <Titanium.UI.createWebView> method or **`<WebView>`** Alloy element to create a web view.
180
168
 
181
- Web views are more expensive to create than other native views because of the requirement to
182
- load the HTML browser into memory.
169
+ Web views are more expensive to create than other native views because of the requirement to load the HTML browser into memory.
183
170
 
184
- The web view content can be any valid web content such as HTML, PDF, SVG or other WebKit supported
185
- content types.
171
+ The web view content can be any valid web content such as HTML, PDF, SVG or other WebKit supported content types.
186
172
 
187
173
  ### JavaScript Context in WebViews--Local vs. Remote Content
188
174
 
189
- JavaScript in the web view executes in its own context. The web view can interact with this
190
- content, but most of this functionality is limited to local content.
175
+ JavaScript in the web view executes in its own context. The web view can interact with this content, but most of this functionality is limited to local content.
191
176
 
192
177
  **Local Scripts**
193
178
 
@@ -326,19 +311,14 @@ content, but most of this functionality is limited to local content.
326
311
 
327
312
  A `Toolbar` is created by the <Titanium.UI.createToolbar> factory method or **`<Toolbar>`** Alloy element.
328
313
 
329
- To provide spacing between items in the toolbar, on iOS you can use the special system button types,
330
- [FIXED_SPACE](Titanium.UI.iOS.SystemButton.FIXED_SPACE) and
331
- [FLEXIBLE_SPACE](Titanium.UI.iOS.SystemButton.FLEXIBLE_SPACE).
314
+ To provide spacing between items in the toolbar, on iOS you can use the special system button types, [FIXED_SPACE](Titanium.UI.iOS.SystemButton.FIXED_SPACE) and [FLEXIBLE_SPACE](Titanium.UI.iOS.SystemButton.FLEXIBLE_SPACE).
332
315
 
333
- Note that toolbars are positioned like other views (using the `top` and `bottom` properties,
334
- 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)
335
- have specific requirements for placing toolbars, specifically:
316
+ 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:
336
317
 
337
318
  * On the iPhone and Android, a toolbar should be at the bottom of the window.
338
319
  * On the iPad, a toolbar should appear at the top or bottom of a window.
339
320
 
340
- Due to an iOS limitation, the buttons in the toolbar only support the `click` event.
341
- The native object underlying a toolbar button does not generate standard view events,
321
+ 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,
342
322
 
343
323
  *(See full overview in titanium-docs)*
344
324
 
@@ -393,15 +373,11 @@ The native object underlying a toolbar button does not generate standard view ev
393
373
  | ------- | --- |
394
374
  | ![Android](./buttonbar_android.png) | |
395
375
 
396
- The button bar is a set of buttons joined into a single control.
397
- On iOS, you can set up the buttons with either a title or image, but not both.
398
- On Android, you can set up the buttons with a title, image, or both.
376
+ 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.
399
377
 
400
378
  Use the <Titanium.UI.createButtonBar> method or **`<ButtonBar>`** Alloy element to create a button bar.
401
379
 
402
- The [TabbedBar](Titanium.UI.iOS.TabbedBar) control is a button bar where the
403
- last selected button maintains a pressed or selected state. The following discussion
404
- applies to both button bar and tabbed bar.
380
+ 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.
405
381
 
406
382
  ### Properties (unique: 5/76)
407
383
  | Property | Type | Default | Platform | Description |
@@ -426,11 +402,7 @@ applies to both button bar and tabbed bar.
426
402
  > Extends Ti.UI.View
427
403
  > Platforms: both
428
404
 
429
- A tabbed bar is a button bar that
430
- maintains a state (visually distinguished as a pressed or selected look).
431
- It is closely related to the `ButtonBar` control. See the description of
432
- [ButtonBar](Titanium.UI.ButtonBar) for information on styling tabbed bars and buttons
433
- bars.
405
+ 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.
434
406
 
435
407
  Use the <Titanium.UI.createTabbedBar> method to create a Tabbed Bar.
436
408
 
@@ -465,11 +437,9 @@ Use the <Titanium.UI.createTabbedBar> method to create a Tabbed Bar.
465
437
 
466
438
  This is a view which shows a list of options where only 1 option is selectable by the user.
467
439
 
468
- On iOS, this displays a
469
- [segmented control](https://developer.apple.com/design/human-interface-guidelines/ios/controls/segmented-controls/).
440
+ On iOS, this displays a [segmented control](https://developer.apple.com/design/human-interface-guidelines/ios/controls/segmented-controls/).
470
441
 
471
- On Android, this displays a
472
- [toggle button group](https://material.io/components/buttons/android#toggle-button).
442
+ On Android, this displays a [toggle button group](https://material.io/components/buttons/android#toggle-button).
473
443
 
474
444
  Use the <Titanium.UI.createOptionBar> method to create a Option Bar.
475
445
 
@@ -498,11 +468,9 @@ Use the <Titanium.UI.createOptionBar> method to create a Option Bar.
498
468
  > Extends Ti.Proxy
499
469
  > Platforms: both
500
470
 
501
- Allows the creation of application shortcuts, which can be detected using
502
- the `click` event from <Titanium.UI.Shortcut>.
471
+ Allows the creation of application shortcuts, which can be detected using the `click` event from <Titanium.UI.Shortcut>.
503
472
 
504
- On iOS, shortcuts are only supported on a 3D Touch compatible device.
505
- Use the <Titanium.UI.iOS.forceTouchSupported> property to see if it's supported.
473
+ On iOS, shortcuts are only supported on a 3D Touch compatible device. Use the <Titanium.UI.iOS.forceTouchSupported> property to see if it's supported.
506
474
 
507
475
  ### Properties (unique: 2/5)
508
476
  | Property | Type | Default | Platform | Description |
@@ -531,15 +499,12 @@ Use the <Titanium.UI.iOS.forceTouchSupported> property to see if it's supported.
531
499
  > Extends Ti.Proxy
532
500
  > Platforms: both
533
501
 
534
- Allows the creation of dynamic application shortcut items which can be set in the app to
535
- offer a dynamic behavior at runtime.
502
+ Allows the creation of dynamic application shortcut items which can be set in the app to offer a dynamic behavior at runtime.
536
503
 
537
- Use the <Titanium.UI.createShortcutItem> method to create a shortcut item and pass it to
538
- the <Titanium.UI.Shortcut.add> method to add it to the application.
504
+ Use the <Titanium.UI.createShortcutItem> method to create a shortcut item and pass it to the <Titanium.UI.Shortcut.add> method to add it to the application.
539
505
 
540
506
  ### Android Static Shortcuts
541
- Google documents how to add static shortcuts
542
- [here](https://developer.android.com/guide/topics/ui/shortcuts/creating-shortcuts#static).
507
+ Google documents how to add static shortcuts [here](https://developer.android.com/guide/topics/ui/shortcuts/creating-shortcuts#static).
543
508
 
544
509
  In the `tiapp.xml` file, you will need to add a shortcuts `<meta-data/>` element to your main activity.
545
510
 
@@ -573,9 +538,7 @@ In the `tiapp.xml` file, you will need to add a shortcuts `<meta-data/>` element
573
538
  | ------- | --- |
574
539
  | ![Android](./emaildialog_android.png) | ![iOS](./emaildialog_ios.png) |
575
540
 
576
- The Email Dialog is created with the <Titanium.UI.createEmailDialog> method. The user needs to
577
- register an e-mail account on the device in order to open the dialog. The dialog will not
578
- open when there is not a registered e-mail account.
541
+ 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.
579
542
 
580
543
  **iOS Platform Notes**
581
544
 
@@ -624,20 +587,13 @@ On iOS, you cannot test the e-mail dialog on the iOS Simulator. Test the email d
624
587
  > Extends Ti.UI.View
625
588
  > Platforms: ios
626
589
 
627
- The DashboardView is created using the <Titanium.UI.createDashboardView> method or **`<DashboardView>`**
628
- Alloy element.
590
+ The DashboardView is created using the <Titanium.UI.createDashboardView> method or **`<DashboardView>`** Alloy element.
629
591
 
630
- Dashboard view's edit mode may be activated by a longpress of a <Titanium.UI.DashboardItem> item,
631
- unless this behavior has been disabled by the [editable](Titanium.UI.DashboardView.editable)
632
- property. As a dashboard view does not inherently provide a way to exit edit mode, this must be
633
- explicitly defined.
592
+ 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.editable) property. As a dashboard view does not inherently provide a way to exit edit mode, this must be explicitly defined.
634
593
 
635
- When edit mode has been activated, the item icons wobble by default to act as a visual cue.
636
- This behavior may be disabled using the [wobble](Titanium.UI.DashboardView.wobble) property.
594
+ 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.wobble) property.
637
595
 
638
- If a dashboard contains more than 9 items, it will be paged into screens in a 3 x 3 formation
639
- using its built-in scrollable view. A paging control is added to the bottom of the view to
640
- indicate the active page.
596
+ 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.
641
597
 
642
598
 
643
599
  *(See full overview in titanium-docs)*
@@ -25,9 +25,7 @@
25
25
 
26
26
  Use the <Titanium.UI.createListView> method or **`<ListView>`** Alloy element to create a `ListView`.
27
27
 
28
- A `ListView` object is a container for [ListSection](Titanium.UI.ListSection)
29
- objects that are, in turn, containers for [ListItem](Titanium.UI.ListItem) objects. This is
30
- easily visualized as an Alloy view:
28
+ A `ListView` object is a container for [ListSection](Titanium.UI.ListSection) objects that are, in turn, containers for [ListItem](Titanium.UI.ListItem) objects. This is easily visualized as an Alloy view:
31
29
 
32
30
 
33
31
  ### Properties (unique: 54/122)
@@ -157,16 +155,11 @@ easily visualized as an Alloy view:
157
155
  > Extends Ti.Proxy
158
156
  > Platforms: both
159
157
 
160
- A list item is a combination of a <ListDataItem> and <ItemTemplate>. The list data item
161
- represents the actual data, while the item template represents the style elements of the item.
158
+ A list item is a combination of a <ListDataItem> and <ItemTemplate>. The list data item represents the actual data, while the item template represents the style elements of the item.
162
159
 
163
- You should not create `ListItem` objects with a JavaScript factory method, as you do other Titanium proxies.
164
- Instead, you should pass a <ListDataItem> array to the `setItems` method of a `ListSection`. The list data items
165
- contain the data you want to display in the list.
160
+ You should not create `ListItem` objects with a JavaScript factory method, as you do other Titanium proxies. Instead, you should pass a <ListDataItem> array to the `setItems` method of a `ListSection`. The list data items contain the data you want to display in the list.
166
161
 
167
- Alloy applications can use **`<ListItem>`** elements to create `ListItem` objects. `<ListItem>` elements
168
- must be nested inside a **`<ListSection>`** element, which itself is nested in a `<ListView>` element,
169
- as shown below:
162
+ Alloy applications can use **`<ListItem>`** elements to create `ListItem` objects. `<ListItem>` elements must be nested inside a **`<ListSection>`** element, which itself is nested in a `<ListView>` element, as shown below:
170
163
 
171
164
 
172
165
  ### Properties (unique: 26/28)
@@ -238,8 +231,7 @@ as shown below:
238
231
 
239
232
  Use the <Titanium.UI.createListSection> method or **`<ListSection>`** Alloy element to create a `ListSection`.
240
233
 
241
- List sections are used to manipulate and organize list items contained within it. For examples
242
- of using list sections, see the examples in <Titanium.UI.ListView> and <Titanium.UI.ListItem>.
234
+ List sections are used to manipulate and organize list items contained within it. For examples of using list sections, see the examples in <Titanium.UI.ListView> and <Titanium.UI.ListItem>.
243
235
 
244
236
  ### Properties (unique: 7/9)
245
237
  | Property | Type | Default | Platform | Description |
@@ -308,8 +300,7 @@ of using list sections, see the examples in <Titanium.UI.ListView> and <Titanium
308
300
  | ------- | --- |
309
301
  | ![Android](./tableview_android.png) | ![iOS](./tableview_ios.png) |
310
302
 
311
- A `TableView` object is a container for [TableViewSection](Titanium.UI.TableViewSection)
312
- objects that are, in turn, containers for [TableViewRow](Titanium.UI.TableViewRow) objects.
303
+ A `TableView` object is a container for [TableViewSection](Titanium.UI.TableViewSection) objects that are, in turn, containers for [TableViewRow](Titanium.UI.TableViewRow) objects.
313
304
 
314
305
  Use the <Titanium.UI.createTableView> method or **`<TableView>`** Alloy element to create a `TableView`.
315
306
 
@@ -460,20 +451,15 @@ There are few approaches to creating and using `TableView` object.
460
451
  > Extends Ti.UI.View
461
452
  > Platforms: both
462
453
 
463
- Use the <Titanium.UI.createTableViewRow> method or **`<TableViewRow>`** Alloy element to create
464
- a table view row.
454
+ Use the <Titanium.UI.createTableViewRow> method or **`<TableViewRow>`** Alloy element to create a table view row.
465
455
 
466
- These may be explicitly added to [TableViewSection](Titanium.UI.TableViewSection) objects, which are applied
467
- to a [TableView](Titanium.UI.TableView). If a table section is not specified, one will be
468
- automatically created.
456
+ These may be explicitly added to [TableViewSection](Titanium.UI.TableViewSection) objects, which are applied to a [TableView](Titanium.UI.TableView). If a table section is not specified, one will be automatically created.
469
457
 
470
- A row's contents can be as simple as a single line of text, or comprised of a completely
471
- customized layout of child views.
458
+ A row's contents can be as simple as a single line of text, or comprised of a completely customized layout of child views.
472
459
 
473
460
  ### Creating Table View Rows
474
461
 
475
- Rows may be created using the properties directly available on the `TableViewRow` object, to
476
- achieve the following:
462
+ Rows may be created using the properties directly available on the `TableViewRow` object, to achieve the following:
477
463
 
478
464
 
479
465
  *(See full overview in titanium-docs)*
@@ -539,20 +525,13 @@ achieve the following:
539
525
  > Extends Ti.Proxy
540
526
  > Platforms: both
541
527
 
542
- Use the <Titanium.UI.createTableViewSection> method or **`<TableViewSection>`** Alloy element to
543
- create a `TableViewSection`.
528
+ Use the <Titanium.UI.createTableViewSection> method or **`<TableViewSection>`** Alloy element to create a `TableViewSection`.
544
529
 
545
- Before the table is rendered, the `TableViewSection` [add](Titanium.UI.TableViewSection.add)
546
- method may be used to add [TableViewRow](Titanium.UI.TableViewRow) objects to a section. After
547
- it is rendered, one of the `TableView` [insertRowBefore](Titanium.UI.TableView.insertRowBefore),
548
- [insertRowAfter](Titanium.UI.TableView.insertRowAfter), or
549
- [appendRow](Titanium.UI.TableView.appendRow) methods must be used instead.
530
+ Before the table is rendered, the `TableViewSection` [add](Titanium.UI.TableViewSection.add) method may be used to add [TableViewRow](Titanium.UI.TableViewRow) objects to a section. After it is rendered, one of the `TableView` [insertRowBefore](Titanium.UI.TableView.insertRowBefore), [insertRowAfter](Titanium.UI.TableView.insertRowAfter), or [appendRow](Titanium.UI.TableView.appendRow) methods must be used instead.
550
531
 
551
- To remove a row from a section after the table is rendered, use the `TableView`
552
- [deleteRow](Titanium.UI.TableView.deleteRow) method.
532
+ To remove a row from a section after the table is rendered, use the `TableView` [deleteRow](Titanium.UI.TableView.deleteRow) method.
553
533
 
554
- In order for a section to be visible, either its `headerTitle` or `headerView` property must be
555
- configured.
534
+ In order for a section to be visible, either its `headerTitle` or `headerView` property must be configured.
556
535
 
557
536
 
558
537
  *(See full overview in titanium-docs)*
@@ -28,8 +28,7 @@ Use the <Titanium.UI.createTextField> method or **`<TextField>`** Alloy element
28
28
 
29
29
  ### `click` event in iOS
30
30
 
31
- In iOS 11+, `click` event in text field is not fired due to changes from apple.
32
- Use `touchstart` event instead of `click` event.
31
+ In iOS 11+, `click` event in text field is not fired due to changes from apple. Use `touchstart` event instead of `click` event.
33
32
 
34
33
  ### Properties (unique: 45/116)
35
34
  | Property | Type | Default | Platform | Description |
@@ -144,8 +143,7 @@ Use the <Titanium.UI.createTextArea> method or **&lt;TextArea&gt;** Alloy elemen
144
143
 
145
144
  ### `click` event in iOS
146
145
 
147
- In iOS 11+, `click` event in text area is not fired due to changes from apple.
148
- Use `touchstart` event instead of `click` event.
146
+ In iOS 11+, `click` event in text area is not fired due to changes from apple. Use `touchstart` event instead of `click` event.
149
147
 
150
148
  ### Properties (unique: 40/111)
151
149
  | Property | Type | Default | Platform | Description |
@@ -252,10 +250,7 @@ Use `touchstart` event instead of `click` event.
252
250
  | ------- | --- |
253
251
  | ![Android](./searchbar_android.png) | ![iOS](./searchbar_ios.png) |
254
252
 
255
- Search bars are most commonly used for filtering the rows in a [TableView](Titanium.UI.TableView) and
256
- [ListView](Titanium.UI.ListView). You can add a search bar to a table view via its
257
- [search](Titanium.UI.TableView.search) property. You can add a search bar to a list view via its
258
- [searchBar](Titanium.UI.SearchBar) property.
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.search) property. You can add a search bar to a list view via its [searchBar](Titanium.UI.SearchBar) property.
259
254
 
260
255
  A search bar can also be used on its own.
261
256
 
@@ -340,11 +335,9 @@ Use the <Titanium.UI.createSearchBar> method or Alloy **`<SearchBar>`** element
340
335
 
341
336
  The AttributedString proxy is created with the <Titanium.UI.createAttributedString> method.
342
337
 
343
- The `text` property must be set initially in the constructor when creating an attributed string.
344
- The [attributes](Titanium.UI.AttributedString.attributes) can either be set in the constructor or after it has been created.
338
+ The `text` property must be set initially in the constructor when creating an attributed string. The [attributes](Titanium.UI.AttributedString.attributes) can either be set in the constructor or after it has been created.
345
339
 
346
- For examples of Attributed Strings, see the
347
- [Attributed Strings guide](https://titaniumsdk.com/guide/Titanium_SDK/Titanium_SDK_How-tos/User_Interface_Deep_Dives/Attributed_Strings.html).
340
+ For examples of Attributed Strings, see the [Attributed Strings guide](https://titaniumsdk.com/guide/Titanium_SDK/Titanium_SDK_How-tos/User_Interface_Deep_Dives/Attributed_Strings.html).
348
341
 
349
342
  ### Properties (unique: 2/5)
350
343
  | Property | Type | Default | Platform | Description |
@@ -377,9 +370,7 @@ For examples of Attributed Strings, see the
377
370
  > Extends Ti.Proxy
378
371
  > Platforms: both
379
372
 
380
- This type may be used on iOS for assignment to any property typically taking a String color value.
381
- A developer is not expected to typically interact with a <Titanium.UI.Color> object, as we generate them
382
- under the hood when converting the passed in String representations. One major exception is use of the
373
+ This type may be used on iOS for assignment to any property typically taking a String color value. A developer is not expected to typically interact with a <Titanium.UI.Color> object, as we generate them under the hood when converting the passed in String representations. One major exception is use of the
383
374
 
384
375
 
385
376
  ### Methods (1)
@@ -396,18 +387,11 @@ under the hood when converting the passed in String representations. One major e
396
387
  > Platforms: both
397
388
  > Type: module
398
389
 
399
- The Clipboard is a temporary data store, used to save a single item of data that may then
400
- be accessed by the user using UI copy and paste interactions within an app or between apps.
390
+ The Clipboard is a temporary data store, used to save a single item of data that may then be accessed by the user using UI copy and paste interactions within an app or between apps.
401
391
 
402
- On iOS, the module's `setData()` and `getData()` methods enable multiple representations of the
403
- same data item to be stored together with their respective
404
- [MIME type](http://en.wikipedia.org/wiki/Internet_media_type) to describe their format. For
405
- example, `'text'` and `'text/plain'` for text, and `'image/jpg'` and `'image/png'` for an image.
406
- iOS Will report back the type of data representation in `getItems()` as
407
- [Universal Type Identifiers](https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/UTIRef/Articles/System-DeclaredUniformTypeIdentifiers.html).
392
+ On iOS, the module's `setData()` and `getData()` methods enable multiple representations of the same data item to be stored together with their respective [MIME type](http://en.wikipedia.org/wiki/Internet_media_type) to describe their format. For example, `'text'` and `'text/plain'` for text, and `'image/jpg'` and `'image/png'` for an image. iOS Will report back the type of data representation in `getItems()` as [Universal Type Identifiers](https://developer.apple.com/library/archive/documentation/Miscellaneous/Reference/UTIRef/Articles/System-DeclaredUniformTypeIdentifiers.html).
408
393
 
409
- When working with text, either of the `getData()`/`setData()` methods may be used with a `'text/plain'` type, or
410
- the `getText()`/`hasText()`/`setText()` methods without the need to specify the type.
394
+ When working with text, either of the `getData()`/`setData()` methods may be used with a `'text/plain'` type, or the `getText()`/`hasText()`/`setText()` methods without the need to specify the type.
411
395
 
412
396
  Android currently only supports text data to be stored.
413
397
 
@@ -464,15 +448,9 @@ Android currently only supports text data to be stored.
464
448
 
465
449
  Use the <Titanium.UI.createPicker> method or Alloy **`<Picker>`** element to create a picker control.
466
450
 
467
- On Android, the `useSpinner` property must be enabled to support multiple columns.
468
- By default, the spinner is automatically sized to fit its content and can overflow
469
- to additional spinner rows. The size of the picker can be adjusted with the `width`
470
- and `height` properties, but may omit picker columns or cut off picker rows
471
- if the size is set too small. This property is deprecated. Please use the default
472
- Android native "dropdown" style by not setting `useSpinner` to `true`.
451
+ On Android, the `useSpinner` property must be enabled to support multiple columns. By default, the spinner is automatically sized to fit its content and can overflow to additional spinner rows. The size of the picker can be adjusted with the `width` and `height` properties, but may omit picker columns or cut off picker rows if the size is set too small. This property is deprecated. Please use the default Android native "dropdown" style by not setting `useSpinner` to `true`.
473
452
 
474
- On iOS, the `height` property is only available in iOS 9 and later.
475
- By default, the size of the picker, including its background, is fixed at the
453
+ 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
476
454
 
477
455
  *(See full overview in titanium-docs)*
478
456
 
@@ -542,9 +520,7 @@ By default, the size of the picker, including its background, is fixed at the
542
520
  > Extends Ti.UI.View
543
521
  > Platforms: both
544
522
 
545
- Use the <Titanium.UI.createPickerColumn> method to create a picker column control. In an Alloy application,
546
- you can use a **`<PickerColumn>`** element inside a `<Picker>` element. You can also use `<Column>`
547
- as a shorthand for `<PickerColumn>` (see Examples).
523
+ Use the <Titanium.UI.createPickerColumn> method to create a picker column control. In an Alloy application, you can use a **`<PickerColumn>`** element inside a `<Picker>` element. You can also use `<Column>` as a shorthand for `<PickerColumn>` (see Examples).
548
524
 
549
525
  On Android, the `useSpinner` property must be enabled to support multiple columns.
550
526
 
@@ -585,9 +561,7 @@ See <Titanium.UI.Picker> for further examples of usage.
585
561
  > Extends Ti.UI.View
586
562
  > Platforms: both
587
563
 
588
- Use the <Titanium.UI.createPickerRow> method to create a picker row control. In an Alloy application,
589
- you can use a **`<PickerRow>`** element inside a `<PickerColumn>` element. You can also use `<Row>`
590
- as a shorthand for `<PickerRow>` (see Examples).
564
+ Use the <Titanium.UI.createPickerRow> method to create a picker row control. In an Alloy application, you can use a **`<PickerRow>`** element inside a `<PickerColumn>` element. You can also use `<Row>` as a shorthand for `<PickerRow>` (see Examples).
591
565
 
592
566
  Views added to picker rows is only supported on iOS.
593
567
 
@@ -20,13 +20,9 @@
20
20
 
21
21
  To create a window, use the <Titanium.UI.createWindow> method or a **`<Window>`** Alloy element.
22
22
 
23
- A window is a top-level container which can contain other views. Windows can
24
- be *opened* and *closed*. Opening a window causes the window and its child
25
- views to be added to the application's render stack, on top of any previously opened
26
- windows. Closing a window removes the window and its children from the render stack.
23
+ A window is a top-level container which can contain other views. Windows can be *opened* and *closed*. Opening a window causes the window and its child views to be added to the application's render stack, on top of any previously opened windows. Closing a window removes the window and its children from the render stack.
27
24
 
28
- Windows *contain* other views, but in general they are not *contained* inside
29
- other views. There are a few specialized views that manage windows:
25
+ Windows *contain* other views, but in general they are not *contained* inside other views. There are a few specialized views that manage windows:
30
26
 
31
27
  * [NavigationWindow](Titanium.UI.NavigationWindow)
32
28
  * [SplitWindow](Titanium.UI.iOS.SplitWindow)
@@ -202,13 +198,9 @@ This applies to Windows inside both standalone NavigationWindow and TabGroup (wh
202
198
  > Extends Ti.UI.Window
203
199
  > Platforms: both
204
200
 
205
- You create a `NavigationWindow` with the <Titanium.UI.createNavigationWindow> factory method or
206
- a `<NavigationWindow>` Alloy element.
201
+ You create a `NavigationWindow` with the <Titanium.UI.createNavigationWindow> factory method or a `<NavigationWindow>` Alloy element.
207
202
 
208
- All `NavigationWindow` objects must have at least one root window that cannot be removed. When
209
- creating a `NavigationWindow` with the factory method, you must set its `window` property to the
210
- root level window. Equivalently, in an Alloy application, insert a `<Window>` element as a child of the
211
- `<NavigationWindow>` element. See examples below.
203
+ All `NavigationWindow` objects must have at least one root window that cannot be removed. When creating a `NavigationWindow` with the factory method, you must set its `window` property to the root level window. Equivalently, in an Alloy application, insert a `<Window>` element as a child of the `<NavigationWindow>` element. See examples below.
212
204
 
213
205
  This object is not meant to be added to other windows. However, it can be used within a <Titanium.UI.iOS.SplitWindow>.
214
206
 
@@ -250,14 +242,11 @@ This object is not meant to be added to other windows. However, it can be used w
250
242
  | ------- | --- |
251
243
  | ![Android](./tabgroup_android.png) | |
252
244
 
253
- A tab group can contain one or more [Tab](Titanium.UI.Tab) objects, each of which has an
254
- associated tab control that is used to bring it into focus.
245
+ 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.
255
246
 
256
- Use the <Titanium.UI.createTabGroup> method or **`<TabGroup>`** Alloy element to create a tab group
257
- that, in turn, contains one or more `<Tab>` elements.
247
+ Use the <Titanium.UI.createTabGroup> method or **`<TabGroup>`** Alloy element to create a tab group that, in turn, contains one or more `<Tab>` elements.
258
248
 
259
- You can add tabs to the group using [addTab](Titanium.UI.TabGroup.addTab), and programmatically
260
- switch to a specific tab using [setActiveTab](Titanium.UI.TabGroup.setActiveTab).
249
+ You can add tabs to the group using [addTab](Titanium.UI.TabGroup.addTab), and programmatically switch to a specific tab using [setActiveTab](Titanium.UI.TabGroup.setActiveTab).
261
250
 
262
251
  ### Platform Implementation Notes
263
252
 
@@ -392,21 +381,17 @@ switch to a specific tab using [setActiveTab](Titanium.UI.TabGroup.setActiveTab)
392
381
  > Extends Ti.UI.View
393
382
  > Platforms: both
394
383
 
395
- A `TabGroup` tab instance. Each tab includes a button and one or more windows, which
396
- holds the "contents" of the tab. Users can select a tab by clicking on the tab button.
384
+ A `TabGroup` tab instance. Each tab includes a button and one or more windows, which holds the "contents" of the tab. Users can select a tab by clicking on the tab button.
397
385
 
398
386
  Use the <Titanium.UI.createTab> method or **`<Tab>`** Alloy element to create a tab.
399
387
 
400
- Use [TabGroup.setActiveTab](Titanium.UI.TabGroup.setActiveTab) to switch between tabs
401
- in a tab group.
388
+ Use [TabGroup.setActiveTab](Titanium.UI.TabGroup.setActiveTab) to switch between tabs in a tab group.
402
389
 
403
- The behavior of tabs and tab groups follows the platform's native navigation style,
404
- which varies significantly between platforms.
390
+ The behavior of tabs and tab groups follows the platform's native navigation style, which varies significantly between platforms.
405
391
 
406
392
  ### iOS Platform Implementation Notes
407
393
 
408
- On iOS, the tab maintains a stack of windows. Windows on top
409
- of the stack can partially or totally obscure windows lower in the stack. Calling
394
+ 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
410
395
 
411
396
  *(See full overview in titanium-docs)*
412
397
 
@@ -502,15 +487,11 @@ of the stack can partially or totally obscure windows lower in the stack. Calli
502
487
 
503
488
  An alert dialog is created using <Titanium.UI.createAlertDialog> or **`<AlertDialog>`** Alloy element.
504
489
 
505
- Although this dialog always appears in the middle of the display (not touching the edges),
506
- other aspects of its aesthetics and the way the user interacts with it are different for each
507
- platform, as described below.
490
+ Although this dialog always appears in the middle of the display (not touching the edges), other aspects of its aesthetics and the way the user interacts with it are different for each platform, as described below.
508
491
 
509
492
  ### Android
510
493
 
511
- On Android, the default alert dialog displays text information, via a title and message, without
512
- any buttons. As the user can use the system hardware `back` button to dismiss it, a button is
513
- optional.
494
+ 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.
514
495
 
515
496
  *(See full overview in titanium-docs)*
516
497
 
@@ -586,16 +567,13 @@ optional.
586
567
  | ------- | ------ | ---- |
587
568
  | ![Android](./optiondialog_android.png) | ![iPhone](./optiondialog_iphone.png) | ![iPad](./optiondialog_ipad.png) |
588
569
 
589
- An option dialog is created using <Titanium.UI.createOptionDialog> or Alloy `<OptionDialog>`
590
- element. See Examples below for usage.
570
+ An option dialog is created using <Titanium.UI.createOptionDialog> or Alloy `<OptionDialog>` element. See Examples below for usage.
591
571
 
592
572
  This dialog is presented differently on each platform, as described below.
593
573
 
594
574
  ### Android
595
575
 
596
- On Android, the dialog is shown in the middle of the display (not touching the edges),
597
- with the option items represented in a picker. The previously-selected, or default, item can be
598
- set on creation.
576
+ 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.
599
577
 
600
578
 
601
579
  *(See full overview in titanium-docs)*
@@ -659,13 +637,9 @@ set on creation.
659
637
  | ------- | --- |
660
638
  | ![Android](./toast_android.png) | |
661
639
 
662
- A toast notification is an unobtrusive, pop-up notification that does not
663
- block the UI. Use the <Titanium.UI.createNotification> method or **`<Notification>`** Alloy element
664
- to create a Toast notification.
640
+ 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.
665
641
 
666
- On Android, by default, a toast notification appears centered on the bottom half of the screen.
667
- On Windows Phone, by default, a toast notification appears over the status bar on the top part
668
- of the screen.
642
+ On Android, by default, a toast notification appears centered on the bottom half of the screen. On Windows Phone, by default, a toast notification appears over the status bar on the top part of the screen.
669
643
 
670
644
  ### Properties (unique: 7/10)
671
645
  | Property | Type | Default | Platform | Description |