@coinbase/cds-mcp-server 8.44.0 → 8.44.1
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/CHANGELOG.md +4 -0
- package/mcp-docs/mobile/components/Alert.txt +0 -1
- package/mcp-docs/mobile/components/AvatarButton.txt +0 -2
- package/mcp-docs/mobile/components/Button.txt +0 -2
- package/mcp-docs/mobile/components/Carousel.txt +23 -17
- package/mcp-docs/mobile/components/CheckboxCell.txt +5 -7
- package/mcp-docs/mobile/components/Chip.txt +3 -5
- package/mcp-docs/mobile/components/Collapsible.txt +0 -7
- package/mcp-docs/mobile/components/Combobox.txt +20 -20
- package/mcp-docs/mobile/components/ContentCell.txt +12 -12
- package/mcp-docs/mobile/components/DataCard.txt +5 -7
- package/mcp-docs/mobile/components/DotCount.txt +5 -5
- package/mcp-docs/mobile/components/Icon.txt +3 -10
- package/mcp-docs/mobile/components/IconButton.txt +0 -2
- package/mcp-docs/mobile/components/InputChip.txt +1 -3
- package/mcp-docs/mobile/components/ListCell.txt +18 -18
- package/mcp-docs/mobile/components/MediaCard.txt +6 -8
- package/mcp-docs/mobile/components/MediaChip.txt +1 -3
- package/mcp-docs/mobile/components/MessagingCard.txt +6 -8
- package/mcp-docs/mobile/components/Modal.txt +0 -1
- package/mcp-docs/mobile/components/NudgeCard.txt +0 -5
- package/mcp-docs/mobile/components/PageFooter.txt +0 -6
- package/mcp-docs/mobile/components/PageHeader.txt +5 -11
- package/mcp-docs/mobile/components/Pressable.txt +0 -2
- package/mcp-docs/mobile/components/ProgressBar.txt +4 -4
- package/mcp-docs/mobile/components/ProgressBarWithFixedLabels.txt +6 -6
- package/mcp-docs/mobile/components/ProgressBarWithFloatLabel.txt +5 -5
- package/mcp-docs/mobile/components/ProgressCircle.txt +8 -8
- package/mcp-docs/mobile/components/RadioCell.txt +5 -7
- package/mcp-docs/mobile/components/RollingNumber.txt +11 -11
- package/mcp-docs/mobile/components/SectionHeader.txt +0 -7
- package/mcp-docs/mobile/components/SelectAlpha.txt +20 -20
- package/mcp-docs/mobile/components/SelectChip.txt +1 -3
- package/mcp-docs/mobile/components/SelectChipAlpha.txt +20 -20
- package/mcp-docs/mobile/components/SelectOption.txt +1 -1
- package/mcp-docs/mobile/components/SlideButton.txt +4 -6
- package/mcp-docs/mobile/components/Spacer.txt +0 -3
- package/mcp-docs/mobile/components/Stepper.txt +8 -8
- package/mcp-docs/mobile/components/TabbedChipsAlpha.txt +2 -2
- package/mcp-docs/mobile/components/UpsellCard.txt +0 -1
- package/mcp-docs/web/components/Alert.txt +0 -1
- package/mcp-docs/web/components/AvatarButton.txt +0 -2
- package/mcp-docs/web/components/Banner.txt +22 -0
- package/mcp-docs/web/components/Button.txt +0 -2
- package/mcp-docs/web/components/Carousel.txt +36 -36
- package/mcp-docs/web/components/CheckboxCell.txt +5 -7
- package/mcp-docs/web/components/Chip.txt +4 -6
- package/mcp-docs/web/components/Collapsible.txt +0 -7
- package/mcp-docs/web/components/Combobox.txt +21 -21
- package/mcp-docs/web/components/ContentCell.txt +14 -14
- package/mcp-docs/web/components/DataCard.txt +5 -7
- package/mcp-docs/web/components/DotCount.txt +7 -7
- package/mcp-docs/web/components/FullscreenModal.txt +0 -1
- package/mcp-docs/web/components/FullscreenModalLayout.txt +0 -1
- package/mcp-docs/web/components/Icon.txt +4 -4
- package/mcp-docs/web/components/IconButton.txt +0 -2
- package/mcp-docs/web/components/InputChip.txt +2 -4
- package/mcp-docs/web/components/Link.txt +0 -2
- package/mcp-docs/web/components/ListCell.txt +16 -16
- package/mcp-docs/web/components/MediaCard.txt +6 -8
- package/mcp-docs/web/components/MediaChip.txt +2 -4
- package/mcp-docs/web/components/MessagingCard.txt +6 -8
- package/mcp-docs/web/components/Modal.txt +0 -1
- package/mcp-docs/web/components/PageFooter.txt +0 -6
- package/mcp-docs/web/components/PageHeader.txt +6 -12
- package/mcp-docs/web/components/Pressable.txt +0 -2
- package/mcp-docs/web/components/ProgressBar.txt +6 -6
- package/mcp-docs/web/components/ProgressBarWithFixedLabels.txt +8 -8
- package/mcp-docs/web/components/ProgressBarWithFloatLabel.txt +7 -7
- package/mcp-docs/web/components/ProgressCircle.txt +8 -8
- package/mcp-docs/web/components/RadioCell.txt +5 -7
- package/mcp-docs/web/components/ReferenceLine.txt +2 -2
- package/mcp-docs/web/components/RollingNumber.txt +12 -12
- package/mcp-docs/web/components/Scrubber.txt +6 -6
- package/mcp-docs/web/components/SelectAlpha.txt +21 -21
- package/mcp-docs/web/components/SelectChip.txt +2 -4
- package/mcp-docs/web/components/SelectChipAlpha.txt +21 -21
- package/mcp-docs/web/components/SelectOption.txt +2 -2
- package/mcp-docs/web/components/Sidebar.txt +6 -6
- package/mcp-docs/web/components/SidebarItem.txt +0 -2
- package/mcp-docs/web/components/Stepper.txt +9 -9
- package/mcp-docs/web/components/TabbedChipsAlpha.txt +4 -4
- package/mcp-docs/web/components/TileButton.txt +0 -2
- package/mcp-docs/web/components/Tray.txt +2 -2
- package/mcp-docs/web/components/UpsellCard.txt +0 -1
- package/package.json +1 -1
|
@@ -269,15 +269,15 @@ function Example() {
|
|
|
269
269
|
|
|
270
270
|
| Prop | Type | Required | Default | Description |
|
|
271
271
|
| --- | --- | --- | --- | --- |
|
|
272
|
-
| `className` | `string` | No | `-` |
|
|
273
|
-
| `classNames` | `{ root?: string; labelContainer?: string \| undefined; startLabel?: string \| undefined; endLabel?: string \| undefined; } \| undefined` | No | `-` | Custom class names for
|
|
272
|
+
| `className` | `string` | No | `-` | - |
|
|
273
|
+
| `classNames` | `{ root?: string; labelContainer?: string \| undefined; startLabel?: string \| undefined; endLabel?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the ProgressBarWithFixedLabels component |
|
|
274
274
|
| `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
|
|
275
275
|
| `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
|
|
276
276
|
| `endLabel` | `number \| { value: number; render: (num: number, disabled?: boolean \| undefined) => ReactNode; }` | No | `-` | Label that is pinned to the end of the container. If a number is used then it will format it as a percentage. |
|
|
277
277
|
| `labelPlacement` | `above \| below \| beside` | No | `beside` | Position of label relative to the bar |
|
|
278
278
|
| `startLabel` | `number \| { value: number; render: (num: number, disabled?: boolean \| undefined) => ReactNode; }` | No | `-` | Label that is pinned to the start of the container. If a number is used then it will format it as a percentage. |
|
|
279
|
-
| `style` | `CSSProperties` | No | `-` |
|
|
280
|
-
| `styles` | `{ root?: CSSProperties; labelContainer?: CSSProperties \| undefined; startLabel?: CSSProperties \| undefined; endLabel?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for
|
|
279
|
+
| `style` | `CSSProperties` | No | `-` | - |
|
|
280
|
+
| `styles` | `{ root?: CSSProperties; labelContainer?: CSSProperties \| undefined; startLabel?: CSSProperties \| undefined; endLabel?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the ProgressBarWithFixedLabels component |
|
|
281
281
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
282
282
|
|
|
283
283
|
|
|
@@ -285,9 +285,9 @@ function Example() {
|
|
|
285
285
|
|
|
286
286
|
| Selector | Static class name | Description |
|
|
287
287
|
| --- | --- | --- |
|
|
288
|
-
| `root` | `-` |
|
|
289
|
-
| `labelContainer` | `-` |
|
|
290
|
-
| `startLabel` | `-` |
|
|
291
|
-
| `endLabel` | `-` |
|
|
288
|
+
| `root` | `-` | Root element |
|
|
289
|
+
| `labelContainer` | `-` | Label container element |
|
|
290
|
+
| `startLabel` | `-` | Start label element |
|
|
291
|
+
| `endLabel` | `-` | End label element |
|
|
292
292
|
|
|
293
293
|
|
|
@@ -240,13 +240,13 @@ function Example() {
|
|
|
240
240
|
| --- | --- | --- | --- | --- |
|
|
241
241
|
| `label` | `number \| { value: number; render: (num: number, disabled?: boolean \| undefined) => ReactNode; }` | Yes | `-` | Label that is floated at the end of the filled in bar. If a number is used then it will format it as a percentage. |
|
|
242
242
|
| `progress` | `number` | Yes | `-` | Number between 0-1 representing the progress percentage |
|
|
243
|
-
| `className` | `string` | No | `-` |
|
|
244
|
-
| `classNames` | `{ root?: string; labelContainer?: string \| undefined; label?: string \| undefined; } \| undefined` | No | `-` | Custom class names for
|
|
243
|
+
| `className` | `string` | No | `-` | - |
|
|
244
|
+
| `classNames` | `{ root?: string; labelContainer?: string \| undefined; label?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the ProgressBarWithFloatLabel component |
|
|
245
245
|
| `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
|
|
246
246
|
| `disabled` | `boolean` | No | `-` | Toggle used to show a disabled progress visualization |
|
|
247
247
|
| `labelPlacement` | `above \| below` | No | `above` | Position of label relative to the bar |
|
|
248
|
-
| `style` | `CSSProperties` | No | `-` |
|
|
249
|
-
| `styles` | `{ root?: CSSProperties; labelContainer?: CSSProperties \| undefined; label?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for
|
|
248
|
+
| `style` | `CSSProperties` | No | `-` | - |
|
|
249
|
+
| `styles` | `{ root?: CSSProperties; labelContainer?: CSSProperties \| undefined; label?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the ProgressBarWithFloatLabel component |
|
|
250
250
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
251
251
|
|
|
252
252
|
|
|
@@ -254,8 +254,8 @@ function Example() {
|
|
|
254
254
|
|
|
255
255
|
| Selector | Static class name | Description |
|
|
256
256
|
| --- | --- | --- |
|
|
257
|
-
| `root` | `-` |
|
|
258
|
-
| `labelContainer` | `-` |
|
|
259
|
-
| `label` | `-` |
|
|
257
|
+
| `root` | `-` | Root element |
|
|
258
|
+
| `labelContainer` | `-` | Label container element |
|
|
259
|
+
| `label` | `-` | Label element |
|
|
260
260
|
|
|
261
261
|
|
|
@@ -448,8 +448,8 @@ function Example() {
|
|
|
448
448
|
| Prop | Type | Required | Default | Description |
|
|
449
449
|
| --- | --- | --- | --- | --- |
|
|
450
450
|
| `progress` | `number` | Yes | `-` | Number between 0-1 representing the progress percentage |
|
|
451
|
-
| `className` | `string` | No | `-` |
|
|
452
|
-
| `classNames` | `{ root?: string; svg?: string \| undefined; circle?: string \| undefined; progress?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the
|
|
451
|
+
| `className` | `string` | No | `-` | - |
|
|
452
|
+
| `classNames` | `{ root?: string; svg?: string \| undefined; circle?: string \| undefined; progress?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the ProgressCircle component |
|
|
453
453
|
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `primary` | Custom progress color. |
|
|
454
454
|
| `contentNode` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Optional component to override the default content rendered inside the circle. |
|
|
455
455
|
| `disableAnimateOnMount` | `boolean` | No | `false` | Disable animation on component mount |
|
|
@@ -461,8 +461,8 @@ function Example() {
|
|
|
461
461
|
| `onAnimationStart` | `(() => void)` | No | `-` | Callback fired when the progress animation starts. |
|
|
462
462
|
| `ref` | `RefObject<HTMLDivElement> \| ((instance: HTMLDivElement \| null) => void) \| null` | No | `-` | - |
|
|
463
463
|
| `size` | `number` | No | `-` | Optional size in px for the visualization. This is useful if the visualization is used in an HStack. If this is omitted the visualization will fill the parent width or height. Since its a circular visualization it will fill the smaller of the parent width or height |
|
|
464
|
-
| `style` | `CSSProperties` | No | `-` |
|
|
465
|
-
| `styles` | `{ root?: CSSProperties; svg?: CSSProperties \| undefined; circle?: CSSProperties \| undefined; progress?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the
|
|
464
|
+
| `style` | `CSSProperties` | No | `-` | - |
|
|
465
|
+
| `styles` | `{ root?: CSSProperties; svg?: CSSProperties \| undefined; circle?: CSSProperties \| undefined; progress?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the ProgressCircle component |
|
|
466
466
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
467
467
|
| `weight` | `normal \| heavy \| thin \| semiheavy` | No | `normal` | Toggle used to change thickness of progress visualization |
|
|
468
468
|
|
|
@@ -471,9 +471,9 @@ function Example() {
|
|
|
471
471
|
|
|
472
472
|
| Selector | Static class name | Description |
|
|
473
473
|
| --- | --- | --- |
|
|
474
|
-
| `root` | `-` |
|
|
475
|
-
| `svg` | `-` |
|
|
476
|
-
| `circle` | `-` |
|
|
477
|
-
| `progress` | `-` |
|
|
474
|
+
| `root` | `-` | Root element |
|
|
475
|
+
| `svg` | `-` | SVG element |
|
|
476
|
+
| `circle` | `-` | Background circle element |
|
|
477
|
+
| `progress` | `-` | Foreground progress circle element |
|
|
478
478
|
|
|
479
479
|
|
|
@@ -98,7 +98,6 @@ function CustomRadioCellExample() {
|
|
|
98
98
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
99
99
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
100
100
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
101
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
102
101
|
| `as` | `label` | No | `-` | The underlying element or component the polymorphic component will render. Changing as also changes the inherited native props (e.g. href for as=a) and the expected ref type. |
|
|
103
102
|
| `aspectRatio` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
104
103
|
| `background` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `-` | Background color of the overlay (element being interacted with). |
|
|
@@ -134,7 +133,6 @@ function CustomRadioCellExample() {
|
|
|
134
133
|
| `disabled` | `boolean` | No | `-` | Is the element currently disabled. Disable user interaction. |
|
|
135
134
|
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
136
135
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
137
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
138
136
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
139
137
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
140
138
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -219,10 +217,10 @@ function CustomRadioCellExample() {
|
|
|
219
217
|
|
|
220
218
|
| Selector | Static class name | Description |
|
|
221
219
|
| --- | --- | --- |
|
|
222
|
-
| `root` | `-` |
|
|
223
|
-
| `radioContainer` | `-` |
|
|
224
|
-
| `title` | `-` |
|
|
225
|
-
| `description` | `-` |
|
|
226
|
-
| `contentContainer` | `-` |
|
|
220
|
+
| `root` | `-` | Root element |
|
|
221
|
+
| `radioContainer` | `-` | Radio input container element |
|
|
222
|
+
| `title` | `-` | Title text element |
|
|
223
|
+
| `description` | `-` | Description text element |
|
|
224
|
+
| `contentContainer` | `-` | Content container element |
|
|
227
225
|
|
|
228
226
|
|
|
@@ -582,7 +582,7 @@ function DraggablePriceTarget() {
|
|
|
582
582
|
| `beaconLabelPreferredSide` | `left \| right` | No | `'right'` | Preferred side for beacon labels. |
|
|
583
583
|
| `beaconStroke` | `string` | No | `'var(--color-bg)'` | Stroke color of the scrubber beacon circle. |
|
|
584
584
|
| `beaconTransitions` | `{ update?: Transition$1; pulse?: Transition$1 \| undefined; pulseRepeatDelay?: number \| undefined; } \| undefined` | No | `-` | Transition configuration for the scrubber beacon. |
|
|
585
|
-
| `classNames` | `{ overlay?: string; beacon?: string \| undefined; line?: string \| undefined; beaconLabel?: string \| undefined; } \| undefined` | No | `-` | Custom class names for
|
|
585
|
+
| `classNames` | `{ overlay?: string; beacon?: string \| undefined; line?: string \| undefined; beaconLabel?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Scrubber component |
|
|
586
586
|
| `hideBeaconLabels` | `boolean` | No | `-` | Hides the beacon labels while keeping the line label visible (if provided). |
|
|
587
587
|
| `hideLine` | `boolean` | No | `-` | Hides the scrubber line. |
|
|
588
588
|
| `hideOverlay` | `boolean` | No | `-` | Hides the overlay rect which obscures data beyond the scrubber position. |
|
|
@@ -596,7 +596,7 @@ function DraggablePriceTarget() {
|
|
|
596
596
|
| `overlayOffset` | `number` | No | `2` | Offset of the overlay rect relative to the drawing area. Useful for when scrubbing over lines, where the stroke width would cause part of the line to be visible. |
|
|
597
597
|
| `ref` | `((instance: ScrubberBeaconGroupRef \| null) => void) \| RefObject<ScrubberBeaconGroupRef> \| null` | No | `-` | - |
|
|
598
598
|
| `seriesIds` | `string[]` | No | `-` | Array of series IDs to highlight when scrubbing with scrubber beacons. By default, all series will be highlighted. |
|
|
599
|
-
| `styles` | `{ overlay?: CSSProperties; beacon?: CSSProperties \| undefined; line?: CSSProperties \| undefined; beaconLabel?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for
|
|
599
|
+
| `styles` | `{ overlay?: CSSProperties; beacon?: CSSProperties \| undefined; line?: CSSProperties \| undefined; beaconLabel?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Scrubber component |
|
|
600
600
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
601
601
|
|
|
602
602
|
|
|
@@ -1094,7 +1094,7 @@ ValueSection
|
|
|
1094
1094
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
1095
1095
|
| `children` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | - |
|
|
1096
1096
|
| `className` | `string \| undefined` | No | `-` | - |
|
|
1097
|
-
| `classNames` | `{ root?: string; visibleContent?: string \| undefined; formattedValueSection?: string \| undefined; prefix?: string \| undefined; suffix?: string \| undefined; i18nPrefix?: string \| undefined; i18nSuffix?: string \| undefined; integer?: string \| undefined; fraction?: string \| undefined; text?: string \| undefined; } \| undefined` | No | `-` |
|
|
1097
|
+
| `classNames` | `{ root?: string; visibleContent?: string \| undefined; formattedValueSection?: string \| undefined; prefix?: string \| undefined; suffix?: string \| undefined; i18nPrefix?: string \| undefined; i18nSuffix?: string \| undefined; integer?: string \| undefined; fraction?: string \| undefined; text?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the RollingNumber component |
|
|
1098
1098
|
| `color` | `((Color \| { base?: Color; phone?: Color \| undefined; tablet?: Color \| undefined; desktop?: Color \| undefined; }) & Color) \| undefined` | No | `'fg'` | Base text color token. When {@link colorPulseOnUpdate } is true, the color briefly pulses to a positive or negative mid color before returning to this base color. |
|
|
1099
1099
|
| `colorPulseOnUpdate` | `boolean` | No | `-` | Enables color pulsing on positive or negative changes. |
|
|
1100
1100
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
@@ -1364,7 +1364,7 @@ ValueSection
|
|
|
1364
1364
|
| `slot` | `string \| undefined` | No | `-` | - |
|
|
1365
1365
|
| `spellCheck` | `Booleanish \| undefined` | No | `-` | - |
|
|
1366
1366
|
| `style` | `CSSProperties` | No | `-` | - |
|
|
1367
|
-
| `styles` | `{ root?: CSSProperties; visibleContent?: CSSProperties \| undefined; formattedValueSection?: CSSProperties \| undefined; prefix?: CSSProperties \| undefined; suffix?: CSSProperties \| undefined; i18nPrefix?: CSSProperties \| undefined; i18nSuffix?: CSSProperties \| undefined; integer?: CSSProperties \| undefined; fraction?: CSSProperties \| undefined; text?: CSSProperties \| undefined; } \| undefined` | No | `-` |
|
|
1367
|
+
| `styles` | `{ root?: CSSProperties; visibleContent?: CSSProperties \| undefined; formattedValueSection?: CSSProperties \| undefined; prefix?: CSSProperties \| undefined; suffix?: CSSProperties \| undefined; i18nPrefix?: CSSProperties \| undefined; i18nSuffix?: CSSProperties \| undefined; integer?: CSSProperties \| undefined; fraction?: CSSProperties \| undefined; text?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the RollingNumber component |
|
|
1368
1368
|
| `suffix` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Content rendered after the formatted value. |
|
|
1369
1369
|
| `suppressContentEditableWarning` | `boolean \| undefined` | No | `-` | - |
|
|
1370
1370
|
| `suppressHydrationWarning` | `boolean \| undefined` | No | `-` | - |
|
|
@@ -1393,15 +1393,15 @@ ValueSection
|
|
|
1393
1393
|
|
|
1394
1394
|
| Selector | Static class name | Description |
|
|
1395
1395
|
| --- | --- | --- |
|
|
1396
|
-
| `root` | `-` |
|
|
1397
|
-
| `visibleContent` | `-` |
|
|
1398
|
-
| `formattedValueSection` | `-` |
|
|
1399
|
-
| `prefix` | `-` |
|
|
1400
|
-
| `suffix` | `-` |
|
|
1401
|
-
| `i18nPrefix` | `-` |
|
|
1402
|
-
| `i18nSuffix` | `-` |
|
|
1403
|
-
| `integer` | `-` |
|
|
1404
|
-
| `fraction` | `-` |
|
|
1405
|
-
| `text` | `-` |
|
|
1396
|
+
| `root` | `-` | Outer container element |
|
|
1397
|
+
| `visibleContent` | `-` | Animated visible content wrapper |
|
|
1398
|
+
| `formattedValueSection` | `-` | Formatted numeric value wrapper |
|
|
1399
|
+
| `prefix` | `-` | Prefix section (from props) |
|
|
1400
|
+
| `suffix` | `-` | Suffix section (from props) |
|
|
1401
|
+
| `i18nPrefix` | `-` | Prefix from Intl.NumberFormat (e.g. $ in $1,000) |
|
|
1402
|
+
| `i18nSuffix` | `-` | Suffix from Intl.NumberFormat (e.g. K in 100K) |
|
|
1403
|
+
| `integer` | `-` | Integer portion of formatted value |
|
|
1404
|
+
| `fraction` | `-` | Fractional portion of formatted value |
|
|
1405
|
+
| `text` | `-` | Text element for digits and symbols |
|
|
1406
1406
|
|
|
1407
1407
|
|
|
@@ -743,7 +743,7 @@ function PercentageBeaconLabels() {
|
|
|
743
743
|
| `beaconLabelPreferredSide` | `left \| right` | No | `'right'` | Preferred side for beacon labels. |
|
|
744
744
|
| `beaconStroke` | `string` | No | `'var(--color-bg)'` | Stroke color of the scrubber beacon circle. |
|
|
745
745
|
| `beaconTransitions` | `{ update?: Transition$1; pulse?: Transition$1 \| undefined; pulseRepeatDelay?: number \| undefined; } \| undefined` | No | `-` | Transition configuration for the scrubber beacon. |
|
|
746
|
-
| `classNames` | `{ overlay?: string; beacon?: string \| undefined; line?: string \| undefined; beaconLabel?: string \| undefined; } \| undefined` | No | `-` | Custom class names for
|
|
746
|
+
| `classNames` | `{ overlay?: string; beacon?: string \| undefined; line?: string \| undefined; beaconLabel?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Scrubber component |
|
|
747
747
|
| `hideBeaconLabels` | `boolean` | No | `-` | Hides the beacon labels while keeping the line label visible (if provided). |
|
|
748
748
|
| `hideLine` | `boolean` | No | `-` | Hides the scrubber line. |
|
|
749
749
|
| `hideOverlay` | `boolean` | No | `-` | Hides the overlay rect which obscures data beyond the scrubber position. |
|
|
@@ -757,7 +757,7 @@ function PercentageBeaconLabels() {
|
|
|
757
757
|
| `overlayOffset` | `number` | No | `2` | Offset of the overlay rect relative to the drawing area. Useful for when scrubbing over lines, where the stroke width would cause part of the line to be visible. |
|
|
758
758
|
| `ref` | `((instance: ScrubberBeaconGroupRef \| null) => void) \| RefObject<ScrubberBeaconGroupRef> \| null` | No | `-` | - |
|
|
759
759
|
| `seriesIds` | `string[]` | No | `-` | Array of series IDs to highlight when scrubbing with scrubber beacons. By default, all series will be highlighted. |
|
|
760
|
-
| `styles` | `{ overlay?: CSSProperties; beacon?: CSSProperties \| undefined; line?: CSSProperties \| undefined; beaconLabel?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for
|
|
760
|
+
| `styles` | `{ overlay?: CSSProperties; beacon?: CSSProperties \| undefined; line?: CSSProperties \| undefined; beaconLabel?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Scrubber component |
|
|
761
761
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
762
762
|
|
|
763
763
|
|
|
@@ -765,9 +765,9 @@ function PercentageBeaconLabels() {
|
|
|
765
765
|
|
|
766
766
|
| Selector | Static class name | Description |
|
|
767
767
|
| --- | --- | --- |
|
|
768
|
-
| `overlay` | `-` |
|
|
769
|
-
| `beacon` | `-` |
|
|
770
|
-
| `line` | `-` |
|
|
771
|
-
| `beaconLabel` | `-` |
|
|
768
|
+
| `overlay` | `-` | Overlay element |
|
|
769
|
+
| `beacon` | `-` | Beacon circle element |
|
|
770
|
+
| `line` | `-` | Scrubber line element |
|
|
771
|
+
| `beaconLabel` | `-` | Beacon label element |
|
|
772
772
|
|
|
773
773
|
|
|
@@ -1405,7 +1405,7 @@ function CustomComponentExamples() {
|
|
|
1405
1405
|
| `align` | `center \| start \| end` | No | `'start'` | Alignment of the value node. |
|
|
1406
1406
|
| `bordered` | `boolean` | No | `true` | Add a border around all sides of the box. Determines if the control should have a default border. |
|
|
1407
1407
|
| `className` | `string` | No | `-` | CSS class name for the root element |
|
|
1408
|
-
| `classNames` | `{ root?: string; control?: string \| undefined; controlStartNode?: string \| undefined; controlInputNode?: string \| undefined; controlValueNode?: string \| undefined; controlLabelNode?: string \| undefined; controlHelperTextNode?: string \| undefined; controlEndNode?: string \| undefined; dropdown?: string \| undefined; option?: string \| undefined; optionCell?: string \| undefined; optionContent?: string \| undefined; optionLabel?: string \| undefined; optionDescription?: string \| undefined; selectAllDivider?: string \| undefined; emptyContentsContainer?: string \| undefined; emptyContentsText?: string \| undefined; optionGroup?: string \| undefined; } \| undefined` | No | `-` | Custom class names for
|
|
1408
|
+
| `classNames` | `{ root?: string; control?: string \| undefined; controlStartNode?: string \| undefined; controlInputNode?: string \| undefined; controlValueNode?: string \| undefined; controlLabelNode?: string \| undefined; controlHelperTextNode?: string \| undefined; controlEndNode?: string \| undefined; dropdown?: string \| undefined; option?: string \| undefined; optionCell?: string \| undefined; optionContent?: string \| undefined; optionLabel?: string \| undefined; optionDescription?: string \| undefined; selectAllDivider?: string \| undefined; emptyContentsContainer?: string \| undefined; emptyContentsText?: string \| undefined; optionGroup?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Select component |
|
|
1409
1409
|
| `clearAllLabel` | `string` | No | `-` | Label for the Clear All option in multi-select mode |
|
|
1410
1410
|
| `compact` | `boolean` | No | `-` | Whether to use compact styling for the select |
|
|
1411
1411
|
| `controlAccessibilityLabel` | `string` | No | `-` | Accessibility label for the control |
|
|
@@ -1430,7 +1430,7 @@ function CustomComponentExamples() {
|
|
|
1430
1430
|
| `setOpen` | `((open: boolean \| ((open: boolean) => boolean)) => void)` | No | `-` | Callback to update the open state |
|
|
1431
1431
|
| `startNode` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Adds content to the start of the inner input. Refer to diagram for location of startNode in InputStack component |
|
|
1432
1432
|
| `style` | `CSSProperties` | No | `-` | Inline styles for the root element |
|
|
1433
|
-
| `styles` | `{ root?: CSSProperties; control?: CSSProperties \| undefined; controlStartNode?: CSSProperties \| undefined; controlInputNode?: CSSProperties \| undefined; controlValueNode?: CSSProperties \| undefined; controlLabelNode?: CSSProperties \| undefined; controlHelperTextNode?: CSSProperties \| undefined; controlEndNode?: CSSProperties \| undefined; controlBlendStyles?: InteractableBlendStyles \| undefined; dropdown?: CSSProperties \| undefined; option?: CSSProperties \| undefined; optionCell?: CSSProperties \| undefined; optionContent?: CSSProperties \| undefined; optionLabel?: CSSProperties \| undefined; optionDescription?: CSSProperties \| undefined; optionBlendStyles?: InteractableBlendStyles \| undefined; selectAllDivider?: CSSProperties \| undefined; emptyContentsContainer?: CSSProperties \| undefined; emptyContentsText?: CSSProperties \| undefined; optionGroup?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for
|
|
1433
|
+
| `styles` | `{ root?: CSSProperties; control?: CSSProperties \| undefined; controlStartNode?: CSSProperties \| undefined; controlInputNode?: CSSProperties \| undefined; controlValueNode?: CSSProperties \| undefined; controlLabelNode?: CSSProperties \| undefined; controlHelperTextNode?: CSSProperties \| undefined; controlEndNode?: CSSProperties \| undefined; controlBlendStyles?: InteractableBlendStyles \| undefined; dropdown?: CSSProperties \| undefined; option?: CSSProperties \| undefined; optionCell?: CSSProperties \| undefined; optionContent?: CSSProperties \| undefined; optionLabel?: CSSProperties \| undefined; optionDescription?: CSSProperties \| undefined; optionBlendStyles?: InteractableBlendStyles \| undefined; selectAllDivider?: CSSProperties \| undefined; emptyContentsContainer?: CSSProperties \| undefined; emptyContentsText?: CSSProperties \| undefined; optionGroup?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Select component |
|
|
1434
1434
|
| `testID` | `string` | No | `-` | Test ID for the root element |
|
|
1435
1435
|
| `type` | `multi \| single` | No | `-` | Whether the select allows single or multiple selections |
|
|
1436
1436
|
| `variant` | `primary \| secondary \| positive \| negative \| foregroundMuted \| foreground` | No | `foregroundMuted` | Determines the sentiment of the input. Because we allow startContent and endContent to be custom ReactNode, the content placed inside these slots will not change colors according to the variant. You will have to add that yourself |
|
|
@@ -1440,25 +1440,25 @@ function CustomComponentExamples() {
|
|
|
1440
1440
|
|
|
1441
1441
|
| Selector | Static class name | Description |
|
|
1442
1442
|
| --- | --- | --- |
|
|
1443
|
-
| `root` | `-` |
|
|
1444
|
-
| `control` | `-` |
|
|
1445
|
-
| `controlStartNode` | `-` |
|
|
1446
|
-
| `controlInputNode` | `-` |
|
|
1447
|
-
| `controlValueNode` | `-` |
|
|
1448
|
-
| `controlLabelNode` | `-` |
|
|
1449
|
-
| `controlHelperTextNode` | `-` |
|
|
1450
|
-
| `controlEndNode` | `-` |
|
|
1443
|
+
| `root` | `-` | Root container element |
|
|
1444
|
+
| `control` | `-` | Control element |
|
|
1445
|
+
| `controlStartNode` | `-` | Start node element |
|
|
1446
|
+
| `controlInputNode` | `-` | Input node element |
|
|
1447
|
+
| `controlValueNode` | `-` | Value node element |
|
|
1448
|
+
| `controlLabelNode` | `-` | Label node element |
|
|
1449
|
+
| `controlHelperTextNode` | `-` | Helper text node element |
|
|
1450
|
+
| `controlEndNode` | `-` | End node element |
|
|
1451
1451
|
| `controlBlendStyles` | `-` | Blend styles for control interactivity |
|
|
1452
|
-
| `dropdown` | `-` |
|
|
1453
|
-
| `option` | `-` |
|
|
1454
|
-
| `optionCell` | `-` |
|
|
1455
|
-
| `optionContent` | `-` |
|
|
1456
|
-
| `optionLabel` | `-` |
|
|
1457
|
-
| `optionDescription` | `-` |
|
|
1458
|
-
| `optionBlendStyles` | `-` |
|
|
1459
|
-
| `selectAllDivider` | `-` |
|
|
1460
|
-
| `emptyContentsContainer` | `-` |
|
|
1461
|
-
| `emptyContentsText` | `-` |
|
|
1462
|
-
| `optionGroup` | `-` |
|
|
1452
|
+
| `dropdown` | `-` | Dropdown container element |
|
|
1453
|
+
| `option` | `-` | Option element |
|
|
1454
|
+
| `optionCell` | `-` | Option cell element |
|
|
1455
|
+
| `optionContent` | `-` | Option content wrapper |
|
|
1456
|
+
| `optionLabel` | `-` | Option label element |
|
|
1457
|
+
| `optionDescription` | `-` | Option description element |
|
|
1458
|
+
| `optionBlendStyles` | `-` | Option blend styles for interactivity |
|
|
1459
|
+
| `selectAllDivider` | `-` | Select all divider element |
|
|
1460
|
+
| `emptyContentsContainer` | `-` | Empty contents container element |
|
|
1461
|
+
| `emptyContentsText` | `-` | Empty contents text element |
|
|
1462
|
+
| `optionGroup` | `-` | Option group element |
|
|
1463
1463
|
|
|
1464
1464
|
|
|
@@ -187,7 +187,6 @@ function SelectChipExample() {
|
|
|
187
187
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
188
188
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
189
189
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
190
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
191
190
|
| `as` | `button` | No | `-` | The underlying element or component the polymorphic component will render. Changing as also changes the inherited native props (e.g. href for as=a) and the expected ref type. |
|
|
192
191
|
| `aspectRatio` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
193
192
|
| `background` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `-` | Background color of the overlay (element being interacted with). |
|
|
@@ -213,7 +212,7 @@ function SelectChipExample() {
|
|
|
213
212
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
214
213
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
215
214
|
| `className` | `string` | No | `-` | Apply class names to the outer container. |
|
|
216
|
-
| `classNames` | `{ root?: string; content?: string \| undefined; } \| undefined` | No | `-` |
|
|
215
|
+
| `classNames` | `{ root?: string; content?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Chip component |
|
|
217
216
|
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `-` | - |
|
|
218
217
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
219
218
|
| `compact` | `boolean` | No | `-` | Reduces spacing around Chip content |
|
|
@@ -229,7 +228,6 @@ function SelectChipExample() {
|
|
|
229
228
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
230
229
|
| `enableMobileModal` | `boolean` | No | `-` | Enable to have Dropdown render its content inside a Modal as opposed to a relatively positioned Popover Ideal for mobile or smaller devices. |
|
|
231
230
|
| `end` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | ReactNode placed after the value |
|
|
232
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
233
231
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
234
232
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
235
233
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -299,7 +297,7 @@ function SelectChipExample() {
|
|
|
299
297
|
| `showOverlay` | `boolean` | No | `false` | Display an overlay over all content below the Popover menu |
|
|
300
298
|
| `start` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | ReactNode placed before the value |
|
|
301
299
|
| `style` | `CSSProperties` | No | `-` | - |
|
|
302
|
-
| `styles` | `{ root?: CSSProperties; content?: CSSProperties \| undefined; } \| undefined` | No | `-` |
|
|
300
|
+
| `styles` | `{ root?: CSSProperties; content?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Chip component |
|
|
303
301
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
304
302
|
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
|
|
305
303
|
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
|
|
@@ -460,7 +460,7 @@ function ExampleDisabled() {
|
|
|
460
460
|
| `align` | `center \| start \| end` | No | `'start'` | Alignment of the value node. |
|
|
461
461
|
| `bordered` | `boolean` | No | `true` | Add a border around all sides of the box. Determines if the control should have a default border. |
|
|
462
462
|
| `className` | `string` | No | `-` | CSS class name for the root element |
|
|
463
|
-
| `classNames` | `{ root?: string; control?: string \| undefined; controlStartNode?: string \| undefined; controlInputNode?: string \| undefined; controlValueNode?: string \| undefined; controlLabelNode?: string \| undefined; controlHelperTextNode?: string \| undefined; controlEndNode?: string \| undefined; dropdown?: string \| undefined; option?: string \| undefined; optionCell?: string \| undefined; optionContent?: string \| undefined; optionLabel?: string \| undefined; optionDescription?: string \| undefined; selectAllDivider?: string \| undefined; emptyContentsContainer?: string \| undefined; emptyContentsText?: string \| undefined; optionGroup?: string \| undefined; } \| undefined` | No | `-` | Custom class names for
|
|
463
|
+
| `classNames` | `{ root?: string; control?: string \| undefined; controlStartNode?: string \| undefined; controlInputNode?: string \| undefined; controlValueNode?: string \| undefined; controlLabelNode?: string \| undefined; controlHelperTextNode?: string \| undefined; controlEndNode?: string \| undefined; dropdown?: string \| undefined; option?: string \| undefined; optionCell?: string \| undefined; optionContent?: string \| undefined; optionLabel?: string \| undefined; optionDescription?: string \| undefined; selectAllDivider?: string \| undefined; emptyContentsContainer?: string \| undefined; emptyContentsText?: string \| undefined; optionGroup?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Select component |
|
|
464
464
|
| `clearAllLabel` | `string` | No | `-` | Label for the Clear All option in multi-select mode |
|
|
465
465
|
| `compact` | `boolean` | No | `-` | Whether to use compact styling for the select |
|
|
466
466
|
| `controlAccessibilityLabel` | `string` | No | `-` | Accessibility label for the control |
|
|
@@ -487,7 +487,7 @@ function ExampleDisabled() {
|
|
|
487
487
|
| `setOpen` | `((open: boolean \| ((open: boolean) => boolean)) => void)` | No | `-` | Callback to update the open state |
|
|
488
488
|
| `startNode` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Adds content to the start of the inner input. Refer to diagram for location of startNode in InputStack component |
|
|
489
489
|
| `style` | `CSSProperties` | No | `-` | Inline styles for the root element |
|
|
490
|
-
| `styles` | `{ root?: CSSProperties; control?: CSSProperties \| undefined; controlStartNode?: CSSProperties \| undefined; controlInputNode?: CSSProperties \| undefined; controlValueNode?: CSSProperties \| undefined; controlLabelNode?: CSSProperties \| undefined; controlHelperTextNode?: CSSProperties \| undefined; controlEndNode?: CSSProperties \| undefined; controlBlendStyles?: InteractableBlendStyles \| undefined; dropdown?: CSSProperties \| undefined; option?: CSSProperties \| undefined; optionCell?: CSSProperties \| undefined; optionContent?: CSSProperties \| undefined; optionLabel?: CSSProperties \| undefined; optionDescription?: CSSProperties \| undefined; optionBlendStyles?: InteractableBlendStyles \| undefined; selectAllDivider?: CSSProperties \| undefined; emptyContentsContainer?: CSSProperties \| undefined; emptyContentsText?: CSSProperties \| undefined; optionGroup?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for
|
|
490
|
+
| `styles` | `{ root?: CSSProperties; control?: CSSProperties \| undefined; controlStartNode?: CSSProperties \| undefined; controlInputNode?: CSSProperties \| undefined; controlValueNode?: CSSProperties \| undefined; controlLabelNode?: CSSProperties \| undefined; controlHelperTextNode?: CSSProperties \| undefined; controlEndNode?: CSSProperties \| undefined; controlBlendStyles?: InteractableBlendStyles \| undefined; dropdown?: CSSProperties \| undefined; option?: CSSProperties \| undefined; optionCell?: CSSProperties \| undefined; optionContent?: CSSProperties \| undefined; optionLabel?: CSSProperties \| undefined; optionDescription?: CSSProperties \| undefined; optionBlendStyles?: InteractableBlendStyles \| undefined; selectAllDivider?: CSSProperties \| undefined; emptyContentsContainer?: CSSProperties \| undefined; emptyContentsText?: CSSProperties \| undefined; optionGroup?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Select component |
|
|
491
491
|
| `testID` | `string` | No | `-` | Test ID for the root element |
|
|
492
492
|
| `type` | `multi \| single` | No | `-` | Whether the select allows single or multiple selections |
|
|
493
493
|
|
|
@@ -496,25 +496,25 @@ function ExampleDisabled() {
|
|
|
496
496
|
|
|
497
497
|
| Selector | Static class name | Description |
|
|
498
498
|
| --- | --- | --- |
|
|
499
|
-
| `root` | `-` |
|
|
500
|
-
| `control` | `-` |
|
|
501
|
-
| `controlStartNode` | `-` |
|
|
502
|
-
| `controlInputNode` | `-` |
|
|
503
|
-
| `controlValueNode` | `-` |
|
|
504
|
-
| `controlLabelNode` | `-` |
|
|
505
|
-
| `controlHelperTextNode` | `-` |
|
|
506
|
-
| `controlEndNode` | `-` |
|
|
499
|
+
| `root` | `-` | Root container element |
|
|
500
|
+
| `control` | `-` | Control element |
|
|
501
|
+
| `controlStartNode` | `-` | Start node element |
|
|
502
|
+
| `controlInputNode` | `-` | Input node element |
|
|
503
|
+
| `controlValueNode` | `-` | Value node element |
|
|
504
|
+
| `controlLabelNode` | `-` | Label node element |
|
|
505
|
+
| `controlHelperTextNode` | `-` | Helper text node element |
|
|
506
|
+
| `controlEndNode` | `-` | End node element |
|
|
507
507
|
| `controlBlendStyles` | `-` | Blend styles for control interactivity |
|
|
508
|
-
| `dropdown` | `-` |
|
|
509
|
-
| `option` | `-` |
|
|
510
|
-
| `optionCell` | `-` |
|
|
511
|
-
| `optionContent` | `-` |
|
|
512
|
-
| `optionLabel` | `-` |
|
|
513
|
-
| `optionDescription` | `-` |
|
|
514
|
-
| `optionBlendStyles` | `-` |
|
|
515
|
-
| `selectAllDivider` | `-` |
|
|
516
|
-
| `emptyContentsContainer` | `-` |
|
|
517
|
-
| `emptyContentsText` | `-` |
|
|
518
|
-
| `optionGroup` | `-` |
|
|
508
|
+
| `dropdown` | `-` | Dropdown container element |
|
|
509
|
+
| `option` | `-` | Option element |
|
|
510
|
+
| `optionCell` | `-` | Option cell element |
|
|
511
|
+
| `optionContent` | `-` | Option content wrapper |
|
|
512
|
+
| `optionLabel` | `-` | Option label element |
|
|
513
|
+
| `optionDescription` | `-` | Option description element |
|
|
514
|
+
| `optionBlendStyles` | `-` | Option blend styles for interactivity |
|
|
515
|
+
| `selectAllDivider` | `-` | Select all divider element |
|
|
516
|
+
| `emptyContentsContainer` | `-` | Empty contents container element |
|
|
517
|
+
| `emptyContentsText` | `-` | Empty contents text element |
|
|
518
|
+
| `optionGroup` | `-` | Option group element |
|
|
519
519
|
|
|
520
520
|
|
|
@@ -70,7 +70,7 @@ function DefaultSelect() {
|
|
|
70
70
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
71
71
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
72
72
|
| `bottomContent` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | The content to display below the main cell content |
|
|
73
|
-
| `classNames` | `{ root?: string; contentContainer?: string \| undefined; topContent?: string \| undefined; bottomContent?: string \| undefined; pressable?: string \| undefined; media?: string \| undefined; childrenContainer?: string \| undefined; intermediary?: string \| undefined; end?: string \| undefined; accessory?: string \| undefined; } \| undefined` | No | `-` |
|
|
73
|
+
| `classNames` | `{ root?: string; contentContainer?: string \| undefined; topContent?: string \| undefined; bottomContent?: string \| undefined; pressable?: string \| undefined; media?: string \| undefined; childrenContainer?: string \| undefined; intermediary?: string \| undefined; end?: string \| undefined; accessory?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Cell component |
|
|
74
74
|
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `-` | - |
|
|
75
75
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
76
76
|
| `compact` | `boolean` | No | `-` | - |
|
|
@@ -149,7 +149,7 @@ function DefaultSelect() {
|
|
|
149
149
|
| `shouldOverflow` | `boolean` | No | `-` | - |
|
|
150
150
|
| `shouldTruncate` | `boolean` | No | `true` | Controls whether the main content should truncate with an ellipsis. Defaults to true (truncates) when not provided. |
|
|
151
151
|
| `style` | `CSSProperties` | No | `-` | - |
|
|
152
|
-
| `styles` | `{ root?: CSSProperties; contentContainer?: CSSProperties \| undefined; topContent?: CSSProperties \| undefined; bottomContent?: CSSProperties \| undefined; pressable?: CSSProperties \| undefined; media?: CSSProperties \| undefined; childrenContainer?: CSSProperties \| undefined; intermediary?: CSSProperties \| undefined; end?: CSSProperties \| undefined; accessory?: CSSProperties \| undefined; } \| undefined` | No | `-` |
|
|
152
|
+
| `styles` | `{ root?: CSSProperties; contentContainer?: CSSProperties \| undefined; topContent?: CSSProperties \| undefined; bottomContent?: CSSProperties \| undefined; pressable?: CSSProperties \| undefined; media?: CSSProperties \| undefined; childrenContainer?: CSSProperties \| undefined; intermediary?: CSSProperties \| undefined; end?: CSSProperties \| undefined; accessory?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Cell component |
|
|
153
153
|
| `tabIndex` | `number` | No | `-` | Necessary to control roving tabindex for accessibility https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex |
|
|
154
154
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
155
155
|
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
|
|
@@ -723,7 +723,7 @@ function TradingInterface() {
|
|
|
723
723
|
| `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
|
|
724
724
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
725
725
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
726
|
-
| `classNames` | `{ root?: string; logo?: string \| undefined; content?: string \| undefined; end?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the
|
|
726
|
+
| `classNames` | `{ root?: string; logo?: string \| undefined; content?: string \| undefined; end?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Sidebar component |
|
|
727
727
|
| `collapsed` | `boolean` | No | `false` | Use collapsed to show only the logo |
|
|
728
728
|
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `-` | - |
|
|
729
729
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
@@ -789,7 +789,7 @@ function TradingInterface() {
|
|
|
789
789
|
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
|
|
790
790
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
791
791
|
| `style` | `CSSProperties` | No | `-` | - |
|
|
792
|
-
| `styles` | `{ root?: CSSProperties; logo?: CSSProperties \| undefined; content?: CSSProperties \| undefined; end?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the
|
|
792
|
+
| `styles` | `{ root?: CSSProperties; logo?: CSSProperties \| undefined; content?: CSSProperties \| undefined; end?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Sidebar component |
|
|
793
793
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
794
794
|
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
|
|
795
795
|
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
|
|
@@ -807,9 +807,9 @@ function TradingInterface() {
|
|
|
807
807
|
|
|
808
808
|
| Selector | Static class name | Description |
|
|
809
809
|
| --- | --- | --- |
|
|
810
|
-
| `root` | `-` |
|
|
811
|
-
| `logo` | `-` |
|
|
812
|
-
| `content` | `-` |
|
|
813
|
-
| `end` | `-` |
|
|
810
|
+
| `root` | `-` | Root sidebar container element |
|
|
811
|
+
| `logo` | `-` | Logo container element |
|
|
812
|
+
| `content` | `-` | Content container element (children list) |
|
|
813
|
+
| `end` | `-` | End container element (renderEnd) |
|
|
814
814
|
|
|
815
815
|
|
|
@@ -236,7 +236,6 @@ function Accessibility() {
|
|
|
236
236
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
237
237
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
238
238
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
239
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
240
239
|
| `as` | `button` | No | `-` | The underlying element or component the polymorphic component will render. Changing as also changes the inherited native props (e.g. href for as=a) and the expected ref type. |
|
|
241
240
|
| `aspectRatio` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
242
241
|
| `blendStyles` | `InteractableBlendStyles` | No | `-` | - |
|
|
@@ -267,7 +266,6 @@ function Accessibility() {
|
|
|
267
266
|
| `disabled` | `boolean` | No | `-` | Is the element currently disabled. |
|
|
268
267
|
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
269
268
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
270
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
271
269
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
272
270
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
273
271
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -736,7 +736,7 @@ It follows the same structure as `classNames`:
|
|
|
736
736
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
737
737
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
738
738
|
| `children` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | - |
|
|
739
|
-
| `classNames` | `{ root?: string; step?: string \| undefined; substepContainer?: string \| undefined; label?: string \| undefined; progress?: string \| undefined; icon?: string \| undefined; header?: string \| undefined; } \| undefined` | No | `-` |
|
|
739
|
+
| `classNames` | `{ root?: string; step?: string \| undefined; substepContainer?: string \| undefined; label?: string \| undefined; progress?: string \| undefined; icon?: string \| undefined; header?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Stepper component |
|
|
740
740
|
| `color` | `currentColor \| fg \| fgMuted \| fgInverse \| fgPrimary \| fgWarning \| fgPositive \| fgNegative \| bg \| bgAlternate \| bgInverse \| bgOverlay \| bgElevation1 \| bgElevation2 \| bgPrimary \| bgPrimaryWash \| bgSecondary \| bgTertiary \| bgSecondaryWash \| bgNegative \| bgNegativeWash \| bgPositive \| bgPositiveWash \| bgWarning \| bgWarningWash \| bgLine \| bgLineHeavy \| bgLineInverse \| bgLinePrimary \| bgLinePrimarySubtle \| accentSubtleRed \| accentBoldRed \| accentSubtleGreen \| accentBoldGreen \| accentSubtleBlue \| accentBoldBlue \| accentSubtlePurple \| accentBoldPurple \| accentSubtleYellow \| accentBoldYellow \| accentSubtleGray \| accentBoldGray \| transparent` | No | `-` | - |
|
|
741
741
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
742
742
|
| `complete` | `boolean` | No | `-` | Set this to true to visualize a completely filled/complete Stepper |
|
|
@@ -803,7 +803,7 @@ It follows the same structure as `classNames`:
|
|
|
803
803
|
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
|
|
804
804
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
805
805
|
| `style` | `CSSProperties` | No | `-` | - |
|
|
806
|
-
| `styles` | `{ root?: CSSProperties; step?: CSSProperties \| undefined; substepContainer?: CSSProperties \| undefined; label?: CSSProperties \| undefined; progress?: CSSProperties \| undefined; icon?: CSSProperties \| undefined; header?: CSSProperties \| undefined; } \| undefined` | No | `-` |
|
|
806
|
+
| `styles` | `{ root?: CSSProperties; step?: CSSProperties \| undefined; substepContainer?: CSSProperties \| undefined; label?: CSSProperties \| undefined; progress?: CSSProperties \| undefined; icon?: CSSProperties \| undefined; header?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Stepper component |
|
|
807
807
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
808
808
|
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
|
|
809
809
|
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
|
|
@@ -820,12 +820,12 @@ It follows the same structure as `classNames`:
|
|
|
820
820
|
|
|
821
821
|
| Selector | Static class name | Description |
|
|
822
822
|
| --- | --- | --- |
|
|
823
|
-
| `root` | `-` |
|
|
824
|
-
| `step` | `-` | Step subcomponent |
|
|
825
|
-
| `substepContainer` | `-` |
|
|
826
|
-
| `label` | `-` | Label subcomponent |
|
|
827
|
-
| `progress` | `-` | Progress subcomponent |
|
|
828
|
-
| `icon` | `-` | Icon subcomponent |
|
|
829
|
-
| `header` | `-` | Header subcomponent |
|
|
823
|
+
| `root` | `-` | Root Stepper container element |
|
|
824
|
+
| `step` | `-` | Step subcomponent element |
|
|
825
|
+
| `substepContainer` | `-` | Substep container element |
|
|
826
|
+
| `label` | `-` | Label subcomponent element |
|
|
827
|
+
| `progress` | `-` | Progress subcomponent element |
|
|
828
|
+
| `icon` | `-` | Icon subcomponent element |
|
|
829
|
+
| `header` | `-` | Header subcomponent element |
|
|
830
830
|
|
|
831
831
|
|
|
@@ -238,9 +238,9 @@ render(<Example />);
|
|
|
238
238
|
|
|
239
239
|
| Selector | Static class name | Description |
|
|
240
240
|
| --- | --- | --- |
|
|
241
|
-
| `root` | `-` |
|
|
242
|
-
| `scrollContainer` | `-` |
|
|
243
|
-
| `paddle` | `-` |
|
|
244
|
-
| `tabs` | `-` |
|
|
241
|
+
| `root` | `-` | Root container element |
|
|
242
|
+
| `scrollContainer` | `-` | Scroll container element |
|
|
243
|
+
| `paddle` | `-` | Paddle icon buttons |
|
|
244
|
+
| `tabs` | `-` | Tabs root element |
|
|
245
245
|
|
|
246
246
|
|
|
@@ -53,7 +53,6 @@ import { TileButton } from '@coinbase/cds-web/buttons/TileButton'
|
|
|
53
53
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
54
54
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
55
55
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
56
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
57
56
|
| `aria-activedescendant` | `string \| undefined` | No | `-` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
|
|
58
57
|
| `aria-atomic` | `Booleanish \| undefined` | No | `-` | Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. |
|
|
59
58
|
| `aria-autocomplete` | `none \| inline \| list \| both \| undefined` | No | `-` | Indicates whether inputting text could trigger display of one or more predictions of the users intended value for an input and specifies how predictions would be presented if they are made. |
|
|
@@ -154,7 +153,6 @@ import { TileButton } from '@coinbase/cds-web/buttons/TileButton'
|
|
|
154
153
|
| `draggable` | `Booleanish \| undefined` | No | `-` | - |
|
|
155
154
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
156
155
|
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
157
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
158
156
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
159
157
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
160
158
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -1140,7 +1140,7 @@ function ResponsiveTrayExample() {
|
|
|
1140
1140
|
| Prop | Type | Required | Default | Description |
|
|
1141
1141
|
| --- | --- | --- | --- | --- |
|
|
1142
1142
|
| `onCloseComplete` | `() => void` | Yes | `-` | Action that will happen when tray is dismissed |
|
|
1143
|
-
| `classNames` | `{ root?: string; overlay?: string \| undefined; container?: string \| undefined; header?: string \| undefined; title?: string \| undefined; content?: string \| undefined; handleBar?: string \| undefined; handleBarHandle?: string \| undefined; closeButton?: string \| undefined; } \| undefined` | No | `-` |
|
|
1143
|
+
| `classNames` | `{ readonly root?: string; readonly overlay?: string \| undefined; readonly container?: string \| undefined; readonly header?: string \| undefined; readonly title?: string \| undefined; readonly content?: string \| undefined; readonly handleBar?: string \| undefined; readonly handleBarHandle?: string \| undefined; readonly closeButton?: string \| undefined; } \| undefined` | No | `-` | - |
|
|
1144
1144
|
| `closeAccessibilityHint` | `string` | No | `-` | Sets an accessible hint or description for the close button. On web, maps to aria-describedby and lists the id(s) of the element(s) that describe the element on which the attribute is set. On mobile, a string that helps users understand what will happen when they perform an action on the accessibility element when that result is not clear from the accessibility label. |
|
|
1145
1145
|
| `closeAccessibilityLabel` | `string` | No | `-` | Sets an accessible label for the close button. On web, maps to aria-label and defines a string value that labels an interactive element. On mobile, VoiceOver will read this string when a user selects the associated element. |
|
|
1146
1146
|
| `focusTabIndexElements` | `boolean` | No | `-` | Allow any element with tabIndex attribute to be focusable in FocusTrap, rather than only focusing specific interactive element types like button. This can be useful when having long content in a Modal. |
|
|
@@ -1158,7 +1158,7 @@ function ResponsiveTrayExample() {
|
|
|
1158
1158
|
| `restoreFocusOnUnmount` | `boolean` | No | `true` | If true, the focus trap will restore focus to the previously focused element when it unmounts. WARNING: If you disable this, you need to ensure that focus is restored properly so it doesnt end up on the body |
|
|
1159
1159
|
| `role` | `dialog \| alertdialog` | No | `-` | WAI-ARIA Roles |
|
|
1160
1160
|
| `showHandleBar` | `boolean` | No | `-` | Show a handle bar indicator at the top of the tray. The handle bar is positioned inside the tray content area. |
|
|
1161
|
-
| `styles` | `{ root?: CSSProperties; overlay?: CSSProperties \| undefined; container?: CSSProperties \| undefined; header?: CSSProperties \| undefined; title?: CSSProperties \| undefined; content?: CSSProperties \| undefined; handleBar?: CSSProperties \| undefined; handleBarHandle?: CSSProperties \| undefined; closeButton?: CSSProperties \| undefined; } \| undefined` | No | `-` |
|
|
1161
|
+
| `styles` | `{ readonly root?: CSSProperties; readonly overlay?: CSSProperties \| undefined; readonly container?: CSSProperties \| undefined; readonly header?: CSSProperties \| undefined; readonly title?: CSSProperties \| undefined; readonly content?: CSSProperties \| undefined; readonly handleBar?: CSSProperties \| undefined; readonly handleBarHandle?: CSSProperties \| undefined; readonly closeButton?: CSSProperties \| undefined; } \| undefined` | No | `-` | - |
|
|
1162
1162
|
| `title` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Text or ReactNode for optional Tray title |
|
|
1163
1163
|
| `verticalDrawerPercentageOfView` | `string` | No | `"85%"` | Allow user of component to define maximum percentage of screen that can be taken up by the Drawer when pinned to the bottom or top. |
|
|
1164
1164
|
| `zIndex` | `number` | No | `-` | z-index for the tray overlay |
|