Skip to content

Commit 8668db4

Browse files
committed
docs(chip, spinner): clarify how defaults work
1 parent 3c5afb3 commit 8668db4

3 files changed

Lines changed: 15 additions & 15 deletions

File tree

core/src/components.d.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -874,11 +874,11 @@ export namespace Components {
874874
*/
875875
"disabled": boolean;
876876
/**
877-
* The fill for the chip. Set to `"outline"` for a chip with a border and background. Set to `"solid"` for a chip with a background. Defaults to `"solid"`.
877+
* The fill for the chip. Set to `"outline"` for a chip with a border and background. Set to `"solid"` for a chip with a background. Defaults to `"solid"` if both the fill property and theme config are unset.
878878
*/
879879
"fill"?: 'outline' | 'solid';
880880
/**
881-
* Set to `"bold"` for a chip with vibrant, bold colors or to `"subtle"` for a chip with muted, subtle colors. Defaults to `"subtle"`.
881+
* Set to `"bold"` for a chip with vibrant, bold colors or to `"subtle"` for a chip with muted, subtle colors. Defaults to `"subtle"` if both the hue property and theme config are unset.
882882
*/
883883
"hue"?: 'bold' | 'subtle';
884884
/**
@@ -892,11 +892,11 @@ export namespace Components {
892892
*/
893893
"outline": boolean;
894894
/**
895-
* Set to `"soft"` for a chip with slightly rounded corners, `"round"` for a chip with fully rounded corners, or `"rectangular"` for a chip without rounded corners. Defaults to `"round"`.
895+
* Set to `"soft"` for a chip with slightly rounded corners, `"round"` for a chip with fully rounded corners, or `"rectangular"` for a chip without rounded corners. Defaults to `"round"` if both the shape property and theme config are unset.
896896
*/
897897
"shape"?: 'soft' | 'round' | 'rectangular';
898898
/**
899-
* Set to `"small"` for a chip with less height and padding. Defaults to `"large"`.
899+
* Set to `"small"` for a chip with less height and padding. Defaults to `"large"` if both the size property and theme config are unset.
900900
*/
901901
"size"?: 'small' | 'large';
902902
}
@@ -3883,7 +3883,7 @@ export namespace Components {
38833883
*/
38843884
"paused": boolean;
38853885
/**
3886-
* Set to `"xsmall"` for the smallest size. Set to `"small"` for a smaller size. Set to `"medium"` for a medium size. Set to `"large"` for a large size. Set to `"xlarge"` for the largest size. Defaults to `"medium"`.
3886+
* Set to `"xsmall"` for the smallest size. Set to `"small"` for a smaller size. Set to `"medium"` for a medium size. Set to `"large"` for a large size. Set to `"xlarge"` for the largest size. Defaults to `"medium"` if both the size property and theme config are unset.
38873887
*/
38883888
"size"?: SpinnerSize;
38893889
}
@@ -6844,11 +6844,11 @@ declare namespace LocalJSX {
68446844
*/
68456845
"disabled"?: boolean;
68466846
/**
6847-
* The fill for the chip. Set to `"outline"` for a chip with a border and background. Set to `"solid"` for a chip with a background. Defaults to `"solid"`.
6847+
* The fill for the chip. Set to `"outline"` for a chip with a border and background. Set to `"solid"` for a chip with a background. Defaults to `"solid"` if both the fill property and theme config are unset.
68486848
*/
68496849
"fill"?: 'outline' | 'solid';
68506850
/**
6851-
* Set to `"bold"` for a chip with vibrant, bold colors or to `"subtle"` for a chip with muted, subtle colors. Defaults to `"subtle"`.
6851+
* Set to `"bold"` for a chip with vibrant, bold colors or to `"subtle"` for a chip with muted, subtle colors. Defaults to `"subtle"` if both the hue property and theme config are unset.
68526852
*/
68536853
"hue"?: 'bold' | 'subtle';
68546854
/**
@@ -6862,11 +6862,11 @@ declare namespace LocalJSX {
68626862
*/
68636863
"outline"?: boolean;
68646864
/**
6865-
* Set to `"soft"` for a chip with slightly rounded corners, `"round"` for a chip with fully rounded corners, or `"rectangular"` for a chip without rounded corners. Defaults to `"round"`.
6865+
* Set to `"soft"` for a chip with slightly rounded corners, `"round"` for a chip with fully rounded corners, or `"rectangular"` for a chip without rounded corners. Defaults to `"round"` if both the shape property and theme config are unset.
68666866
*/
68676867
"shape"?: 'soft' | 'round' | 'rectangular';
68686868
/**
6869-
* Set to `"small"` for a chip with less height and padding. Defaults to `"large"`.
6869+
* Set to `"small"` for a chip with less height and padding. Defaults to `"large"` if both the size property and theme config are unset.
68706870
*/
68716871
"size"?: 'small' | 'large';
68726872
}
@@ -9909,7 +9909,7 @@ declare namespace LocalJSX {
99099909
*/
99109910
"paused"?: boolean;
99119911
/**
9912-
* Set to `"xsmall"` for the smallest size. Set to `"small"` for a smaller size. Set to `"medium"` for a medium size. Set to `"large"` for a large size. Set to `"xlarge"` for the largest size. Defaults to `"medium"`.
9912+
* Set to `"xsmall"` for the smallest size. Set to `"small"` for a smaller size. Set to `"medium"` for a medium size. Set to `"large"` for a large size. Set to `"xlarge"` for the largest size. Defaults to `"medium"` if both the size property and theme config are unset.
99139913
*/
99149914
"size"?: SpinnerSize;
99159915
}

core/src/components/chip/chip.tsx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export class Chip implements ComponentInterface {
3737
* Set to `"outline"` for a chip with a border and background.
3838
* Set to `"solid"` for a chip with a background.
3939
*
40-
* Defaults to `"solid"`.
40+
* Defaults to `"solid"` if both the fill property and theme config are unset.
4141
*/
4242
@Prop() fill?: 'outline' | 'solid';
4343

@@ -50,7 +50,7 @@ export class Chip implements ComponentInterface {
5050
* Set to `"bold"` for a chip with vibrant, bold colors or to `"subtle"` for
5151
* a chip with muted, subtle colors.
5252
*
53-
* Defaults to `"subtle"`.
53+
* Defaults to `"subtle"` if both the hue property and theme config are unset.
5454
*/
5555
@Prop() hue?: 'bold' | 'subtle';
5656

@@ -59,15 +59,15 @@ export class Chip implements ComponentInterface {
5959
* `"round"` for a chip with fully rounded corners,
6060
* or `"rectangular"` for a chip without rounded corners.
6161
*
62-
* Defaults to `"round"`.
62+
* Defaults to `"round"` if both the shape property and theme config are unset.
6363
*/
6464
@Prop() shape?: 'soft' | 'round' | 'rectangular';
6565

6666
// TODO(FW-6266): Determine if `medium` size is needed.
6767
/**
6868
* Set to `"small"` for a chip with less height and padding.
6969
*
70-
* Defaults to `"large"`.
70+
* Defaults to `"large"` if both the size property and theme config are unset.
7171
*/
7272
@Prop() size?: 'small' | 'large';
7373

core/src/components/spinner/spinner.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export class Spinner implements ComponentInterface {
4949
* Set to `"large"` for a large size.
5050
* Set to `"xlarge"` for the largest size.
5151
*
52-
* Defaults to `"medium"`.
52+
* Defaults to `"medium"` if both the size property and theme config are unset.
5353
*/
5454
@Prop() size?: SpinnerSize;
5555

0 commit comments

Comments
 (0)