Skip to content

Commit

Permalink
docs: mark properties as deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
garymathews authored and sgtcoolguy committed Mar 10, 2021
1 parent 9cf10cd commit 72068f4
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
40 changes: 40 additions & 0 deletions apidoc/Titanium/UI/ListItem.yml
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,37 @@ properties:
platforms: [android, iphone, ipad, macos]
accessors: false

- name: backgroundSelectedColor
summary: Background color of the view, as a color name or hex triplet when item is selected.
description: |
On Android, clicking on ListItem's sub-views will not trigger this unless these views have 'touchEnabled' set to false.
For information about color values, see the "Colors" section of <Titanium.UI>.
type: [String, Titanium.UI.Color]
since: 10.0.0
platforms: [android, iphone, ipad, macos]
default: Transparent
accessors: false

- name: backgroundSelectedImage
summary: Background image to render when the item is selected.
description: |
Must be a local resource.
On Android, clicking on ListItem's sub-views will not trigger this unless these views have 'touchEnabled' set to false.
type: String
since: 10.0.0
platforms: [android, iphone, ipad, macos]
accessors: false
deprecated:
since: "10.0.0"
notes: This property has been deprecated in favor of backgroundSelectedImage.

- name: backgroundSelectedGradient
summary: Background gradient to render when the item is selected.
type: Gradient
since: 10.0.0
platforms: [iphone, ipad, macos]
accessors: false

- name: selectedBackgroundColor
summary: Background color of the view, as a color name or hex triplet when item is selected.
description: |
Expand All @@ -158,6 +189,9 @@ properties:
platforms: [android, iphone, ipad, macos]
default: Transparent
accessors: false
deprecated:
since: "10.0.0"
notes: This property has been deprecated in favor of backgroundSelectedColor.

- name: selectedBackgroundImage
summary: Background image to render when the item is selected.
Expand All @@ -168,13 +202,19 @@ properties:
since: 3.2.0
platforms: [android, iphone, ipad, macos]
accessors: false
deprecated:
since: "10.0.0"
notes: This property has been deprecated in favor of backgroundSelectedImage.

- name: selectedBackgroundGradient
summary: Background gradient to render when the item is selected.
type: Gradient
since: 3.2.0
platforms: [iphone, ipad, macos]
accessors: false
deprecated:
since: "10.0.0"
notes: This property has been deprecated in favor of backgroundSelectedGradient.

- name: canEdit
summary: Specifies if the item can be deleted by a user initiated action.
Expand Down
18 changes: 18 additions & 0 deletions apidoc/Titanium/UI/TableViewRow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -323,15 +323,33 @@ properties:
summary: Image to render in the right image area of the row, specified as a local path or URL.
type: String

- name: backgroundSelectedColor
summary: Background color to render when the row is selected, as a color name or hex triplet.
description: |
For information about color values, see the "Colors" section of <Titanium.UI>.
type: [String, Titanium.UI.Color]
since: "10.0.0"

- name: backgroundSelectedImage
summary: Background image to render when the row is selected.
type: String
since: "10.0.0"

- name: selectedBackgroundColor
summary: Background color to render when the row is selected, as a color name or hex triplet.
description: |
For information about color values, see the "Colors" section of <Titanium.UI>.
type: [String, Titanium.UI.Color]
deprecated:
since: "10.0.0"
notes: This property has been deprecated in favor of backgroundSelectedColor.

- name: selectedBackgroundImage
summary: Background image to render when the row is selected.
type: String
deprecated:
since: "10.0.0"
notes: This property has been deprecated in favor of backgroundSelectedImage.

- name: selectedColor
summary: Color of the row text when the row is selected, as a color name or hex triplet.
Expand Down

0 comments on commit 72068f4

Please sign in to comment.