Skip to content

Commit b4976dd

Browse files
manucorporatmanucorporat
committed
chore(): update docs
1 parent 90cb7b1 commit b4976dd

File tree

33 files changed

+226
-128
lines changed

33 files changed

+226
-128
lines changed

‎core/src/components.d.ts

Lines changed: 64 additions & 64 deletions
Large diffs are not rendered by default.

‎core/src/components/anchor/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ The Anchor component is used for navigating to a specified link. Similar to the
1212

1313
string
1414

15-
The color to use for the anchor.
15+
The color to use from your application's color palette.
16+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
17+
For more information on colors, see [theming](/docs/theming/basics).
1618

1719

1820
#### href
@@ -37,7 +39,9 @@ another page using `href`.
3739

3840
string
3941

40-
The color to use for the anchor.
42+
The color to use from your application's color palette.
43+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
44+
For more information on colors, see [theming](/docs/theming/basics).
4145

4246

4347
#### href

‎core/src/components/back-button/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ To change what is displayed in the back button, use the `text` and `icon` proper
1414

1515
string
1616

17-
The color the button should be.
17+
The color to use from your application's color palette.
18+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
19+
For more information on colors, see [theming](/docs/theming/basics).
1820

1921

2022
#### defaultHref
@@ -52,7 +54,9 @@ The text to display in the back button.
5254

5355
string
5456

55-
The color the button should be.
57+
The color to use from your application's color palette.
58+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
59+
For more information on colors, see [theming](/docs/theming/basics).
5660

5761

5862
#### default-href

‎core/src/components/badge/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Badges are inline block elements that usually appear near another element. Typic
1212

1313
string
1414

15-
The color the badge should be.
15+
The color to use from your application's color palette.
16+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
17+
For more information on colors, see [theming](/docs/theming/basics).
1618

1719

1820
#### mode
@@ -29,7 +31,9 @@ Possible values are: `"ios"` or `"md"`.
2931

3032
string
3133

32-
The color the badge should be.
34+
The color to use from your application's color palette.
35+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
36+
For more information on colors, see [theming](/docs/theming/basics).
3337

3438

3539
#### mode

‎core/src/components/button/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ Possible values are: `"button"`, `"bar-button"`.
4949

5050
string
5151

52-
The color to use for the button.
52+
The color to use from your application's color palette.
53+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
54+
For more information on colors, see [theming](/docs/theming/basics).
5355

5456

5557
#### disabled
@@ -146,7 +148,9 @@ Possible values are: `"button"`, `"bar-button"`.
146148

147149
string
148150

149-
The color to use for the button.
151+
The color to use from your application's color palette.
152+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
153+
For more information on colors, see [theming](/docs/theming/basics).
150154

151155

152156
#### disabled

‎core/src/components/card-header/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212

1313
string
1414

15-
The color to use for the background.
15+
The color to use from your application's color palette.
16+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
17+
For more information on colors, see [theming](/docs/theming/basics).
1618

1719

1820
#### mode
@@ -36,7 +38,9 @@ If true, the card header will be translucent. Defaults to `false`.
3638

3739
string
3840

39-
The color to use for the background.
41+
The color to use from your application's color palette.
42+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
43+
For more information on colors, see [theming](/docs/theming/basics).
4044

4145

4246
#### mode

‎core/src/components/card-subtitle/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111

1212
string
1313

14-
The color to use for the text color.
14+
The color to use from your application's color palette.
15+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
16+
For more information on colors, see [theming](/docs/theming/basics).
1517

1618

1719
#### mode
@@ -28,7 +30,9 @@ Possible values are: `"ios"` or `"md"`.
2830

2931
string
3032

31-
The color to use for the text color.
33+
The color to use from your application's color palette.
34+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
35+
For more information on colors, see [theming](/docs/theming/basics).
3236

3337

3438
#### mode

‎core/src/components/card-title/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212

1313
string
1414

15-
The color to use for the text color.
15+
The color to use from your application's color palette.
16+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
17+
For more information on colors, see [theming](/docs/theming/basics).
1618

1719

1820
#### mode
@@ -29,7 +31,9 @@ Possible values are: `"ios"` or `"md"`.
2931

3032
string
3133

32-
The color to use for the text color.
34+
The color to use from your application's color palette.
35+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
36+
For more information on colors, see [theming](/docs/theming/basics).
3337

3438

3539
#### mode

‎core/src/components/card/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ sub-components to reflect this. Please see `ion-card-content`,
1515

1616
string
1717

18-
The color to use for the background.
18+
The color to use from your application's color palette.
1919
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
20+
For more information on colors, see [theming](/docs/theming/basics).
2021

2122

2223
#### mode
@@ -33,8 +34,9 @@ Possible values are: `"ios"` or `"md"`.
3334

3435
string
3536

36-
The color to use for the background.
37+
The color to use from your application's color palette.
3738
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
39+
For more information on colors, see [theming](/docs/theming/basics).
3840

3941

4042
#### mode

‎core/src/components/checkbox/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ If true, the checkbox is selected. Defaults to `false`.
2121

2222
string
2323

24-
The color to use for the checkbox.
24+
The color to use from your application's color palette.
25+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
26+
For more information on colors, see [theming](/docs/theming/basics).
2527

2628

2729
#### disabled
@@ -66,7 +68,9 @@ If true, the checkbox is selected. Defaults to `false`.
6668

6769
string
6870

69-
The color to use for the checkbox.
71+
The color to use from your application's color palette.
72+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
73+
For more information on colors, see [theming](/docs/theming/basics).
7074

7175

7276
#### disabled

‎core/src/components/chip-button/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ A ChipButton is an inset button that is placed inside of a Chip. For more inform
1111

1212
string
1313

14-
The color to use.
14+
The color to use from your application's color palette.
1515
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
16+
For more information on colors, see [theming](/docs/theming/basics).
1617

1718

1819
#### disabled
@@ -51,8 +52,9 @@ Possible values are: `"ios"` or `"md"`.
5152

5253
string
5354

54-
The color to use.
55+
The color to use from your application's color palette.
5556
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
57+
For more information on colors, see [theming](/docs/theming/basics).
5658

5759

5860
#### disabled

‎core/src/components/chip-icon/readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@
1111

1212
string
1313

14-
The color to use.
14+
The color to use from your application's color palette.
1515
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
16+
For more information on colors, see [theming](/docs/theming/basics).
1617

1718

1819
#### mode
@@ -37,8 +38,9 @@ Possible values are the same as `"ion-icon"`.
3738

3839
string
3940

40-
The color to use.
41+
The color to use from your application's color palette.
4142
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
43+
For more information on colors, see [theming](/docs/theming/basics).
4244

4345

4446
#### mode

‎core/src/components/chip/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ Chips represent complex entities in small blocks, such as a contact. A chip can
1111

1212
string
1313

14-
The color to use.
14+
The color to use from your application's color palette.
15+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
16+
For more information on colors, see [theming](/docs/theming/basics).
1517

1618

1719
#### mode
@@ -28,7 +30,9 @@ Possible values are: `"ios"` or `"md"`.
2830

2931
string
3032

31-
The color to use.
33+
The color to use from your application's color palette.
34+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
35+
For more information on colors, see [theming](/docs/theming/basics).
3236

3337

3438
#### mode

‎core/src/components/fab-button/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ If true, the fab button will be show a close icon. Defaults to `false`.
2020

2121
string
2222

23-
The color to use for the button.
23+
The color to use from your application's color palette.
24+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
25+
For more information on colors, see [theming](/docs/theming/basics).
2426

2527

2628
#### disabled
@@ -73,7 +75,9 @@ If true, the fab button will be show a close icon. Defaults to `false`.
7375

7476
string
7577

76-
The color to use for the button.
78+
The color to use from your application's color palette.
79+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
80+
For more information on colors, see [theming](/docs/theming/basics).
7781

7882

7983
#### disabled

‎core/src/components/item-divider/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ Item Dividers are block elements that can be used to separate items in a list. T
1111

1212
string
1313

14-
The color to use for the item-divider
14+
The color to use from your application's color palette.
15+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
16+
For more information on colors, see [theming](/docs/theming/basics).
1517

1618

1719
#### mode
@@ -28,7 +30,9 @@ Possible values are: `"ios"` or `"md"`.
2830

2931
string
3032

31-
The color to use for the item-divider
33+
The color to use from your application's color palette.
34+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
35+
For more information on colors, see [theming](/docs/theming/basics).
3236

3337

3438
#### mode

‎core/src/components/item-option/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ action for the item.
1313

1414
string
1515

16-
The color to use for the option
16+
The color to use from your application's color palette.
17+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
18+
For more information on colors, see [theming](/docs/theming/basics).
1719

1820

1921
#### disabled
@@ -52,7 +54,9 @@ Possible values are: `"ios"` or `"md"`.
5254

5355
string
5456

55-
The color to use for the option
57+
The color to use from your application's color palette.
58+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
59+
For more information on colors, see [theming](/docs/theming/basics).
5660

5761

5862
#### disabled

‎core/src/components/item/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ If true, a button tag will be rendered and the item will be tappable. Defaults t
5656

5757
string
5858

59-
The color to use for the background of the item.
59+
The color to use from your application's color palette.
60+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
61+
For more information on colors, see [theming](/docs/theming/basics).
6062

6163

6264
#### detail
@@ -139,7 +141,9 @@ If true, a button tag will be rendered and the item will be tappable. Defaults t
139141

140142
string
141143

142-
The color to use for the background of the item.
144+
The color to use from your application's color palette.
145+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
146+
For more information on colors, see [theming](/docs/theming/basics).
143147

144148

145149
#### detail

‎core/src/components/label/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Label is a wrapper element that can be used in combination with `ion-item`, `ion
1212

1313
string
1414

15-
The color to use for the label's text
15+
The color to use from your application's color palette.
16+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
17+
For more information on colors, see [theming](/docs/theming/basics).
1618

1719

1820
#### mode
@@ -37,7 +39,9 @@ Possible values are: 'inline' | 'fixed' | 'stacked' | 'floating'
3739

3840
string
3941

40-
The color to use for the label's text
42+
The color to use from your application's color palette.
43+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
44+
For more information on colors, see [theming](/docs/theming/basics).
4145

4246

4347
#### mode

‎core/src/components/list-header/readme.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ Unlike ItemDivider, ListHeaders are styled to be stand-out from the rest of the
1313

1414
string
1515

16-
The color to use for the background.
16+
The color to use from your application's color palette.
17+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
18+
For more information on colors, see [theming](/docs/theming/basics).
1719

1820

1921
#### mode
@@ -30,7 +32,9 @@ Possible values are: `"ios"` or `"md"`.
3032

3133
string
3234

33-
The color to use for the background.
35+
The color to use from your application's color palette.
36+
Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
37+
For more information on colors, see [theming](/docs/theming/basics).
3438

3539

3640
#### mode

0 commit comments

Comments
 (0)