@coinbase/cds-mcp-server 8.44.0 → 8.44.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -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/Tray.txt +15 -0
- 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 +17 -2
- package/mcp-docs/web/components/UpsellCard.txt +0 -1
- package/package.json +1 -1
|
@@ -79,7 +79,7 @@ const SelectMobile = () => {
|
|
|
79
79
|
| `onPress` | `((event: GestureResponderEvent) => void) \| null` | No | `-` | Called when a single tap gesture is detected. |
|
|
80
80
|
| `outerSpacing` | `CellSpacing` | No | `-` | The spacing to use on the parent wrapper of Cell |
|
|
81
81
|
| `priority` | `end \| start \| middle \| (end \| start \| middle)[]` | No | `-` | Which piece of content has the highest priority in regards to text truncation, growing, and shrinking. |
|
|
82
|
-
| `styles` | `{ root?: StyleProp<ViewStyle>; contentContainer?: StyleProp<ViewStyle>; topContent?: StyleProp<ViewStyle>; bottomContent?: StyleProp<ViewStyle>; pressable?: StyleProp<ViewStyle>; media?: StyleProp<ViewStyle>; childrenContainer?: StyleProp<ViewStyle>; intermediary?: StyleProp<ViewStyle>; end?: StyleProp<ViewStyle>; accessory?: StyleProp<ViewStyle>; }` | No | `-` |
|
|
82
|
+
| `styles` | `{ root?: StyleProp<ViewStyle>; contentContainer?: StyleProp<ViewStyle>; topContent?: StyleProp<ViewStyle>; bottomContent?: StyleProp<ViewStyle>; pressable?: StyleProp<ViewStyle>; media?: StyleProp<ViewStyle>; childrenContainer?: StyleProp<ViewStyle>; intermediary?: StyleProp<ViewStyle>; end?: StyleProp<ViewStyle>; accessory?: StyleProp<ViewStyle>; }` | No | `-` | Custom styles for individual elements of the Cell component |
|
|
83
83
|
| `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 |
|
|
84
84
|
| `title` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Title of content. Max 1 line (with description) or 2 lines (without), otherwise will truncate. This prop is only intended to accept a string or Text component; other use cases, while allowed, are not supported and may result in unexpected behavior. For arbitrary content, use titleNode. |
|
|
85
85
|
|
|
@@ -231,7 +231,6 @@ function Example() {
|
|
|
231
231
|
| `alignContent` | `flex-start \| flex-end \| center \| stretch \| space-between \| space-around \| space-evenly` | No | `-` | - |
|
|
232
232
|
| `alignItems` | `flex-start \| flex-end \| center \| stretch \| baseline` | No | `-` | - |
|
|
233
233
|
| `alignSelf` | `auto \| FlexAlignType` | No | `-` | - |
|
|
234
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
235
234
|
| `aspectRatio` | `string \| number` | No | `-` | - |
|
|
236
235
|
| `autoCompleteSlideOnThresholdMet` | `boolean` | No | `-` | If true, the slide button will automatically complete the slide when the threshold is met. If false, the user must release to complete the action. |
|
|
237
236
|
| `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). |
|
|
@@ -270,7 +269,6 @@ function Example() {
|
|
|
270
269
|
| `display` | `flex \| none` | No | `-` | - |
|
|
271
270
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | Determines box shadow styles. Parent should have overflow set to visible to ensure styles are not clipped. Is the element elevated. |
|
|
272
271
|
| `endCheckedNode` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Custom end node to render for the checked state of the handle, to replace the default loading indicator. |
|
|
273
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
274
272
|
| `feedback` | `none \| light \| normal \| heavy` | No | `none` | Haptic feedback to trigger when being pressed. |
|
|
275
273
|
| `flexBasis` | `string \| number` | No | `-` | - |
|
|
276
274
|
| `flexDirection` | `row \| column \| row-reverse \| column-reverse` | No | `-` | - |
|
|
@@ -334,7 +332,7 @@ function Example() {
|
|
|
334
332
|
| `right` | `string \| number` | No | `-` | - |
|
|
335
333
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
336
334
|
| `startUncheckedNode` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Custom start node to render for the unchecked state of the handle, to replace the default arrow icon. |
|
|
337
|
-
| `styles` | `{ container?: StyleProp<ViewStyle>; background?: StyleProp<ViewStyle>; handle?: StyleProp<ViewStyle>; }` | No | `-` | Custom styles for the
|
|
335
|
+
| `styles` | `{ container?: StyleProp<ViewStyle>; background?: StyleProp<ViewStyle>; handle?: StyleProp<ViewStyle>; }` | No | `-` | Custom styles for individual elements of the SlideButton component |
|
|
338
336
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Used to locate this view in end-to-end tests. |
|
|
339
337
|
| `textAlign` | `left \| right \| auto \| center \| justify` | No | `-` | - |
|
|
340
338
|
| `textDecorationLine` | `none \| underline \| line-through \| underline line-through` | No | `-` | - |
|
|
@@ -356,8 +354,8 @@ function Example() {
|
|
|
356
354
|
|
|
357
355
|
| Selector | Static class name | Description |
|
|
358
356
|
| --- | --- | --- |
|
|
359
|
-
| `container` | `-` |
|
|
360
|
-
| `background` | `-` |
|
|
361
|
-
| `handle` | `-` |
|
|
357
|
+
| `container` | `-` | Container element |
|
|
358
|
+
| `background` | `-` | Background element |
|
|
359
|
+
| `handle` | `-` | Handle element |
|
|
362
360
|
|
|
363
361
|
|
|
@@ -59,9 +59,6 @@ import { Spacer } from '@coinbase/cds-mobile/layout/Spacer'
|
|
|
59
59
|
| Prop | Type | Required | Default | Description |
|
|
60
60
|
| --- | --- | --- | --- | --- |
|
|
61
61
|
| `animated` | `boolean` | No | `-` | - |
|
|
62
|
-
| `flexBasis` | `string \| number` | No | `-` | Sets the initial main flex size. |
|
|
63
|
-
| `flexGrow` | `number` | No | `-` | Set the grow factor of this flex item. |
|
|
64
|
-
| `flexShrink` | `number` | No | `-` | Set the shrink factor of this flex item. |
|
|
65
62
|
| `horizontal` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Padding in the horizontal direction |
|
|
66
63
|
| `maxHorizontal` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Max padding in the horizontal direction |
|
|
67
64
|
| `maxVertical` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Max padding in the vertical direction |
|
|
@@ -606,7 +606,7 @@ It accepts an object with the following optional keys:
|
|
|
606
606
|
| `right` | `string \| number` | No | `-` | - |
|
|
607
607
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
608
608
|
| `style` | `false \| RegisteredStyle<ViewStyle> \| Value \| AnimatedInterpolation<string \| number> \| WithAnimatedObject<ViewStyle> \| WithAnimatedArray<Falsy \| ViewStyle \| RegisteredStyle<ViewStyle> \| RecursiveArray<Falsy \| ViewStyle \| RegisteredStyle<ViewStyle>> \| readonly (Falsy \| ViewStyle \| RegisteredStyle<ViewStyle>)[]> \| null` | No | `-` | - |
|
|
609
|
-
| `styles` | `{ root?: StyleProp<ViewStyle>; step?: StyleProp<ViewStyle>; substepContainer?: StyleProp<ViewStyle>; label?: StyleProp<ViewStyle>; progress?: StyleProp<ViewStyle>; icon?: StyleProp<ViewStyle>; header?: StyleProp<ViewStyle>; }` | No | `-` |
|
|
609
|
+
| `styles` | `{ root?: StyleProp<ViewStyle>; step?: StyleProp<ViewStyle>; substepContainer?: StyleProp<ViewStyle>; label?: StyleProp<ViewStyle>; progress?: StyleProp<ViewStyle>; icon?: StyleProp<ViewStyle>; header?: StyleProp<ViewStyle>; }` | No | `-` | Custom styles for individual elements of the Stepper component |
|
|
610
610
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Used to locate this view in end-to-end tests. |
|
|
611
611
|
| `textAlign` | `left \| right \| auto \| center \| justify` | No | `-` | - |
|
|
612
612
|
| `textDecorationLine` | `none \| underline \| line-through \| underline line-through` | No | `-` | - |
|
|
@@ -623,12 +623,12 @@ It accepts an object with the following optional keys:
|
|
|
623
623
|
|
|
624
624
|
| Selector | Static class name | Description |
|
|
625
625
|
| --- | --- | --- |
|
|
626
|
-
| `root` | `-` |
|
|
627
|
-
| `step` | `-` | Step subcomponent |
|
|
628
|
-
| `substepContainer` | `-` |
|
|
629
|
-
| `label` | `-` | Label subcomponent |
|
|
630
|
-
| `progress` | `-` | Progress subcomponent |
|
|
631
|
-
| `icon` | `-` | Icon subcomponent |
|
|
632
|
-
| `header` | `-` | Header subcomponent |
|
|
626
|
+
| `root` | `-` | Root Stepper container element |
|
|
627
|
+
| `step` | `-` | Step subcomponent element |
|
|
628
|
+
| `substepContainer` | `-` | Substep container element |
|
|
629
|
+
| `label` | `-` | Label subcomponent element |
|
|
630
|
+
| `progress` | `-` | Progress subcomponent element |
|
|
631
|
+
| `icon` | `-` | Icon subcomponent element |
|
|
632
|
+
| `header` | `-` | Header subcomponent element |
|
|
633
633
|
|
|
634
634
|
|
|
@@ -206,7 +206,7 @@ render(<Example />);
|
|
|
206
206
|
|
|
207
207
|
| Selector | Static class name | Description |
|
|
208
208
|
| --- | --- | --- |
|
|
209
|
-
| `root` | `-` |
|
|
210
|
-
| `tabs` | `-` |
|
|
209
|
+
| `root` | `-` | Root container element |
|
|
210
|
+
| `tabs` | `-` | Tabs root element |
|
|
211
211
|
|
|
212
212
|
|
|
@@ -836,3 +836,18 @@ function Example() {
|
|
|
836
836
|
| `visible` | `boolean` | No | `-` | The visible prop determines whether your modal is visible. |
|
|
837
837
|
|
|
838
838
|
|
|
839
|
+
## Styles
|
|
840
|
+
|
|
841
|
+
| Selector | Static class name | Description |
|
|
842
|
+
| --- | --- | --- |
|
|
843
|
+
| `root` | `-` | Root container element |
|
|
844
|
+
| `overlay` | `-` | Overlay backdrop element |
|
|
845
|
+
| `container` | `-` | Animated sliding container element |
|
|
846
|
+
| `handleBar` | `-` | Handle bar container element |
|
|
847
|
+
| `handleBarHandle` | `-` | Handle bar indicator element |
|
|
848
|
+
| `drawer` | `-` | Drawer content wrapper element |
|
|
849
|
+
| `content` | `-` | Content area element |
|
|
850
|
+
| `header` | `-` | Header section element |
|
|
851
|
+
| `title` | `-` | Title text element |
|
|
852
|
+
|
|
853
|
+
|
|
@@ -317,6 +317,5 @@ function Example() {
|
|
|
317
317
|
| `onDismissPress` | `((event: GestureResponderEvent) => void) \| null` | No | `-` | Callback fired when the dismiss button is pressed |
|
|
318
318
|
| `onPress` | `((event: GestureResponderEvent) => void) \| null` | No | `-` | Callback fired when the card is pressed |
|
|
319
319
|
| `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 |
|
|
320
|
-
| `width` | `string \| number` | No | `-` | Set a fixed width. |
|
|
321
320
|
|
|
322
321
|
|
|
@@ -162,6 +162,5 @@ function AlertOnModalExample() {
|
|
|
162
162
|
| `ref` | `((instance: ModalRefBaseProps \| null) => void) \| RefObject<ModalRefBaseProps> \| null` | No | `-` | - |
|
|
163
163
|
| `stacked` | `boolean` | No | `-` | Indicating if Alert is stacked on top of Modal |
|
|
164
164
|
| `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 |
|
|
165
|
-
| `zIndex` | `number` | No | `-` | Adjust the z-index positioning layer. |
|
|
166
165
|
|
|
167
166
|
|
|
@@ -130,7 +130,6 @@ AvatarButton can use fallback colors with names when no image source is provided
|
|
|
130
130
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
131
131
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
132
132
|
| `alt` | `string` | No | `-` | This is the name associated with the entity in the Avatar. This is used in the image alt tag for accessibility. |
|
|
133
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
134
133
|
| `aria-activedescendant` | `string \| undefined` | No | `-` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
|
|
135
134
|
| `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. |
|
|
136
135
|
| `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. |
|
|
@@ -232,7 +231,6 @@ AvatarButton can use fallback colors with names when no image source is provided
|
|
|
232
231
|
| `draggable` | `Booleanish \| undefined` | No | `-` | - |
|
|
233
232
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
234
233
|
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
235
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
236
234
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
237
235
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
238
236
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -146,6 +146,28 @@ You can customize `borderRadius` to soften contextual and in-line banners.
|
|
|
146
146
|
Avoid setting `borderRadius` for `styleVariant="global"` so the vertical status bar remains aligned.
|
|
147
147
|
:::
|
|
148
148
|
|
|
149
|
+
### Bleed with Margin Props
|
|
150
|
+
|
|
151
|
+
When using negative `margin*` props to create a bleed effect, explicitly set `width` so the Banner expands beyond its container.
|
|
152
|
+
|
|
153
|
+
```tsx live
|
|
154
|
+
<VStack height={150} background="bgPositiveWash">
|
|
155
|
+
<Banner
|
|
156
|
+
marginX={-2}
|
|
157
|
+
startIcon="info"
|
|
158
|
+
startIconActive
|
|
159
|
+
styleVariant="contextual"
|
|
160
|
+
title="Bleeding banner"
|
|
161
|
+
variant="informational"
|
|
162
|
+
width="auto"
|
|
163
|
+
>
|
|
164
|
+
<Text as="p" font="label2">
|
|
165
|
+
Use with prop to override the default 100% width
|
|
166
|
+
</Text>
|
|
167
|
+
</Banner>
|
|
168
|
+
</VStack>
|
|
169
|
+
```
|
|
170
|
+
|
|
149
171
|
## Props
|
|
150
172
|
|
|
151
173
|
| Prop | Type | Required | Default | Description |
|
|
@@ -250,7 +250,6 @@ A full-width primary action with a compact secondary option.
|
|
|
250
250
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
251
251
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
252
252
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
253
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
254
253
|
| `aria-activedescendant` | `string \| undefined` | No | `-` | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
|
|
255
254
|
| `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. |
|
|
256
255
|
| `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. |
|
|
@@ -353,7 +352,6 @@ A full-width primary action with a compact secondary option.
|
|
|
353
352
|
| `endIcon` | `key \| search \| pin \| filter \| visible \| continuous \| auto \| loop \| warning \| error \| account \| activity \| add \| addPeople \| advancedMarketSelector \| advancedTradeProduct \| affiliates \| airdrop \| airdropAlt \| airdropCoins \| airdropParachute \| alien \| allTimeHigh \| allocation \| annotation \| api \| apiPlug \| apothecary \| appSwitcher \| apple \| appleLogo \| application \| arrowDown \| arrowLeft \| arrowRight \| arrowUp \| arrowsHorizontal \| arrowsUpDown \| arrowsVertical \| artwork \| assetHubProduct \| assetManagementProduct \| astronautHelmet \| atSign \| atomScience \| autoCar \| avatar \| average \| backArrow \| ballot \| ballotbox \| bandage \| bank \| barChartSimple \| barChartWindow \| base \| baseApps \| baseFeed \| baseNotification \| baseQuickBuy \| baseSquare \| baseTransact \| baseVerification \| baseWallet \| baseball \| basketball \| beaker \| beginningArrow \| bell \| bellCheck \| bellPlus \| birthcertificate \| block \| blockchain \| blog \| book \| bookmark \| borrowProduct \| boxing \| bridging \| briefcase \| briefcaseAlt \| browser \| bug \| building \| calculator \| calendar \| calendarBlank \| calendarDates \| calendarEmpty \| calendarHeart \| calendarMoney \| calendarStar \| camera \| candlesticks \| car \| card \| caret \| caretDown \| caretLeft \| caretRight \| caretUp \| cash \| cashAustralianDollar \| cashBrazilianReal \| cashBrazillianReal \| cashCanadianDollar \| cashCoins \| cashEUR \| cashGBP \| cashIndonesianRupiah \| cashJPY \| cashPhilippinePeso \| cashPolishZloty \| cashRupee \| cashSingaporeDollar \| cashSwissFranc \| cashThaiBaht \| cashTurkishLira \| cashUSD \| cashUaeDirham \| cashVietnameseDong \| chainLink \| chartBar \| chartCandles \| chartLine \| chartPie \| chartPieCircle \| chartVolume \| chatBotAgent \| chatBubble \| chatRequests \| checkboxChecked \| checkboxEmpty \| checkmark \| chess \| circleCheckmark \| circleCross \| circulatingSupply \| city \| clipboard \| clock \| clockOutline \| close \| closeCaption \| clothing \| cloud \| cloudPartial \| cloudProduct \| cluster \| coinbase \| coinbaseCardProduct \| coinbaseOne \| coinbaseOneCard \| coinbaseOneLogo \| coinbaseRewards \| coinsCrypto \| collapse \| collectibles \| collection \| comment \| commentPlus \| commerceProduct \| compass \| complianceProduct \| compose \| computerChip \| concierge \| conciergeBell \| config \| convert \| copy \| corporation \| creatorCoin \| cricket \| cross \| crossTrade \| crypto \| cryptobasics \| crystalBall \| crystalBallInsight \| currencies \| custodyProduct \| dashboard \| dataMarketplaceProduct \| dataStack \| defi \| delegateProduct \| deposit \| derivatives \| derivativesProduct \| derivativesProductNew \| developerAPIProduct \| developerPlatformProduct \| dex \| diagonalDownArrow \| diagonalRightArrow \| diagonalUpArrow \| diamond \| diamondIncentives \| dinnerPlate \| directDeposit \| directDepositIcon \| disabledPhone \| discordLogo \| distribution \| document \| documentation \| dot \| doubleChevronRight \| downArrow \| download \| drag \| drops \| earn \| earnProduct \| earnRewards \| earthquake \| educationBook \| educationPencil \| email \| endArrow \| entertainment \| ethereum \| eventContracts \| exchangeProduct \| exclamationMark \| expand \| expandAddress \| expandAll \| externalLink \| eye \| faceScan \| faces \| factory \| faucet \| fib \| filmStrip \| fingerprint \| flame \| folder \| folderArrow \| folderOpen \| followAdd \| following \| football \| fork \| forwardArrow \| fscsProtection \| gab \| games \| gaming \| gasFees \| gasFeesAlt \| gauge \| gaugeEmpty \| gaugeHigh \| gaugeHighLow \| gaugeHighMid \| gaugeLow \| gaugeLowHigh \| gaugeLowMid \| gaugeMedium \| gavel \| gear \| generalCharacter \| ghost \| gif \| giftBox \| giftCard \| gitHubLogo \| globe \| golf \| googleLogo \| greenEnergy \| grid \| group \| hamburger \| hammer \| heart \| helpCenterProduct \| helpCenterQuestionMark \| hiddenEye \| hockey \| home \| horizontalLine \| hospital \| hospitalCross \| hurricane \| ideal \| identityCard \| image \| info \| initiator \| instagramLogo \| instantUnstakingClock \| institute \| institutionalProduct \| interest \| invisible \| invoice \| keyboard \| laptop \| leadChart \| leadCoin \| learningRewardsProduct \| light \| lightbulb \| lightning \| lightningBolt \| lineChartCrypto \| list \| location \| lock \| login \| logout \| magnifyingGlass \| marketCap \| medal \| megaphone \| menu \| metaverse \| microphone \| microphoneCordless \| microscope \| mint \| minus \| mma \| moneyCardCoin \| moon \| more \| moreVertical \| motorsport \| music \| musicArticles \| needle \| newsFeed \| newsletter \| nft \| nftBuy \| nftOffer \| nftProduct \| nftSale \| noRocket \| noWifi \| nodeProduct \| oil \| options \| orderBook \| orderHistory \| outline \| pFPS \| paperAirplane \| paperclip \| participate \| participateProduct \| passKey \| passport \| pause \| pay \| payProduct \| paymentCard \| payments \| payouts \| paypal \| pencil \| peopleGroup \| peopleStar \| percentage \| perpetualSwap \| phone \| pieChartData \| pillBottle \| pillCapsule \| plane \| planet \| play \| playbutton \| plusMinus \| podiumStar \| politicsBuilding \| politicsCandidate \| politicsFlag \| politicsGavel \| politicsPodium \| politicsStar \| powerTool \| priceAlerts \| priceAlertsCheck \| primePoduct \| privateClientProduct \| proProduct \| profile \| protection \| pulse \| pyramid \| qrCode \| qrCodeAlt \| queryTransact \| questionMark \| quotation \| rain \| ratingsCheck \| ratingsChecks \| ratingsStar \| reCenter \| rectangle \| recurring \| refresh \| regulated \| regulatedFutures \| report \| rewardsProduct \| ribbon \| robot \| rocket \| rocketShip \| rollingSpot \| rosettaProduct \| rottenTomato \| royalty \| safe \| save \| savingsBank \| scanQrCode \| scienceAtom \| scienceBeaker \| scienceMoon \| securityKey \| securityShield \| seen \| sendReceive \| setPinCode \| settings \| share \| shield \| shieldOutline \| shoe \| shoppingCart \| signinProduct \| singleCoin \| singleNote \| singlecloud \| smartContract \| snow \| soccer \| socialChat \| socialReshare \| socialShare \| sofort \| sortDoubleArrow \| sortDown \| sortDownCenter \| sortUp \| sortUpCenter \| soundOff \| soundOn \| sparkle \| speaker \| speechBubble \| stableCoin \| stablecoinStack \| staggeredList \| stake \| staking \| star \| starAward \| starBubble \| starTrophy \| statusDot \| step0 \| step1 \| step2 \| step3 \| step4 \| step5 \| step6 \| step7 \| step8 \| step9 \| strategy \| sun \| support \| tag \| taxes \| taxesReceipt \| telephone \| tennis \| test \| thermometer \| thumbsDown \| thumbsDownOutline \| thumbsUp \| thumbsUpOutline \| tokenLaunchCoin \| tokenLaunchRocket \| tokenSales \| tornado \| trading \| transactions \| trashCan \| trophy \| trophyCup \| tshirt \| tv \| tvStand \| twitterLogo \| ultility \| umbrella \| undo \| unfollowPeople \| unknown \| unlock \| upArrow \| upload \| venturesProduct \| verifiedBadge \| verifiedPools \| verticalLine \| virus \| waasProduct \| wallet \| walletLogo \| walletProduct \| webhooks \| wellness \| wifi \| wind \| wireTransfer \| withdraw \| wrapToken \| xLogo` | No | `-` | Icon to render at the end of the button. |
|
|
354
353
|
| `endIconActive` | `boolean` | No | `-` | Whether the end icon is active |
|
|
355
354
|
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
356
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
357
355
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
358
356
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
359
357
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -53,7 +53,7 @@ function MyCarousel() {
|
|
|
53
53
|
title="Explore Assets"
|
|
54
54
|
styles={{
|
|
55
55
|
root: { paddingInline: 'var(--space-3)' },
|
|
56
|
-
carousel: { gap: 'var(--space-
|
|
56
|
+
carousel: { gap: 'var(--space-2)' },
|
|
57
57
|
}}
|
|
58
58
|
>
|
|
59
59
|
{Object.values(assets).map((asset, index) => (
|
|
@@ -85,8 +85,8 @@ Items can be given a width proportional to the carousel width.
|
|
|
85
85
|
:::tip Tip
|
|
86
86
|
|
|
87
87
|
If you have a gap between items, you should account for that in the width.
|
|
88
|
-
For example, if you have a gap of
|
|
89
|
-
you should give each item a width of `calc(50% -
|
|
88
|
+
For example, if you have a gap of 16px, and you want to show 2 items per page,
|
|
89
|
+
you should give each item a width of `calc(50% - 8px)`.
|
|
90
90
|
|
|
91
91
|
:::
|
|
92
92
|
|
|
@@ -100,8 +100,8 @@ function DynamicSizingCarousel() {
|
|
|
100
100
|
const [selectedItemsPerPage, setSelectedItemsPerPage] = useState(itemsPerPage[0]);
|
|
101
101
|
const itemWidths = {
|
|
102
102
|
one: '100%',
|
|
103
|
-
two: 'calc((100% - var(--space-
|
|
104
|
-
three: 'calc((100% - (2 * var(--space-
|
|
103
|
+
two: 'calc((100% - var(--space-2)) / 2)',
|
|
104
|
+
three: 'calc((100% - (2 * var(--space-2))) / 3)',
|
|
105
105
|
};
|
|
106
106
|
function NoopFn() {
|
|
107
107
|
console.log('pressed');
|
|
@@ -131,7 +131,7 @@ function DynamicSizingCarousel() {
|
|
|
131
131
|
title="Learn more"
|
|
132
132
|
styles={{
|
|
133
133
|
root: { paddingInline: 'var(--space-3)' },
|
|
134
|
-
carousel: { gap: 'var(--space-
|
|
134
|
+
carousel: { gap: 'var(--space-2)' },
|
|
135
135
|
}}
|
|
136
136
|
key={selectedItemsPerPage.id}
|
|
137
137
|
>
|
|
@@ -291,8 +291,8 @@ The carousel below will show per page 1 item on mobile, 2 items on tablet, and 3
|
|
|
291
291
|
function ResponsiveSizingCarousel() {
|
|
292
292
|
const itemWidth = {
|
|
293
293
|
phone: '100%',
|
|
294
|
-
tablet: 'calc((100% - var(--space-
|
|
295
|
-
desktop: 'calc((100% - (2 * var(--space-
|
|
294
|
+
tablet: 'calc((100% - var(--space-2)) / 2)',
|
|
295
|
+
desktop: 'calc((100% - (2 * var(--space-2))) / 3)',
|
|
296
296
|
};
|
|
297
297
|
function NoopFn() {
|
|
298
298
|
console.log('pressed');
|
|
@@ -317,7 +317,7 @@ function ResponsiveSizingCarousel() {
|
|
|
317
317
|
<Carousel
|
|
318
318
|
hidePagination
|
|
319
319
|
title="Learn more"
|
|
320
|
-
styles={{ root: { paddingInline: 'var(--space-3)' }, carousel: { gap: 'var(--space-
|
|
320
|
+
styles={{ root: { paddingInline: 'var(--space-3)' }, carousel: { gap: 'var(--space-2)' } }}
|
|
321
321
|
drag="free"
|
|
322
322
|
>
|
|
323
323
|
<CarouselItem id="earn-more-crypto" width={itemWidth}>
|
|
@@ -402,15 +402,15 @@ function VariedSizingCarousel() {
|
|
|
402
402
|
}
|
|
403
403
|
const itemWidth = {
|
|
404
404
|
phone: '100%',
|
|
405
|
-
tablet: 'calc((100% - var(--space-
|
|
406
|
-
desktop: 'calc((100% - var(--space-
|
|
405
|
+
tablet: 'calc((100% - var(--space-2)) / 2)',
|
|
406
|
+
desktop: 'calc((100% - var(--space-2)) / 2)',
|
|
407
407
|
};
|
|
408
408
|
return (
|
|
409
409
|
<Box marginX={-3}>
|
|
410
410
|
<Carousel
|
|
411
411
|
hidePagination
|
|
412
412
|
title="Varied Sizing"
|
|
413
|
-
styles={{ root: { paddingInline: 'var(--space-3)' }, carousel: { gap: 'var(--space-
|
|
413
|
+
styles={{ root: { paddingInline: 'var(--space-3)' }, carousel: { gap: 'var(--space-2)' } }}
|
|
414
414
|
>
|
|
415
415
|
<CarouselItem id="earn-more-crypto" width={itemWidth}>
|
|
416
416
|
{({ isVisible }) => (
|
|
@@ -507,7 +507,7 @@ function DragCarousel() {
|
|
|
507
507
|
drag={drag.id}
|
|
508
508
|
styles={{
|
|
509
509
|
root: { paddingInline: 'var(--space-3)' },
|
|
510
|
-
carousel: { gap: 'var(--space-
|
|
510
|
+
carousel: { gap: 'var(--space-2)' },
|
|
511
511
|
}}
|
|
512
512
|
snapMode="item"
|
|
513
513
|
key={drag.id}
|
|
@@ -573,7 +573,7 @@ function SnapModeCarousel() {
|
|
|
573
573
|
paginationVariant="dot"
|
|
574
574
|
styles={{
|
|
575
575
|
root: { paddingInline: 'var(--space-3)' },
|
|
576
|
-
carousel: { gap: 'var(--space-
|
|
576
|
+
carousel: { gap: 'var(--space-2)' },
|
|
577
577
|
}}
|
|
578
578
|
snapMode={snapMode.id}
|
|
579
579
|
key={snapMode.id}
|
|
@@ -637,7 +637,7 @@ function OverflowCarousel() {
|
|
|
637
637
|
snapMode="item"
|
|
638
638
|
styles={{
|
|
639
639
|
root: { paddingInline: 'var(--space-3)' },
|
|
640
|
-
carousel: { gap: 'var(--space-
|
|
640
|
+
carousel: { gap: 'var(--space-2)' },
|
|
641
641
|
}}
|
|
642
642
|
>
|
|
643
643
|
{Object.values(assets).map((asset, index) => (
|
|
@@ -691,7 +691,7 @@ function AutoplayCarousel() {
|
|
|
691
691
|
title="Trending Assets"
|
|
692
692
|
styles={{
|
|
693
693
|
root: { paddingInline: 'var(--space-3)' },
|
|
694
|
-
carousel: { gap: 'var(--space-
|
|
694
|
+
carousel: { gap: 'var(--space-2)' },
|
|
695
695
|
}}
|
|
696
696
|
>
|
|
697
697
|
{Object.values(assets).map((asset) => (
|
|
@@ -743,7 +743,7 @@ function LoopingCarousel() {
|
|
|
743
743
|
title="Infinite Scroll"
|
|
744
744
|
styles={{
|
|
745
745
|
root: { paddingInline: 'var(--space-3)' },
|
|
746
|
-
carousel: { gap: 'var(--space-
|
|
746
|
+
carousel: { gap: 'var(--space-2)' },
|
|
747
747
|
}}
|
|
748
748
|
>
|
|
749
749
|
{Object.values(assets).map((asset) => (
|
|
@@ -916,8 +916,8 @@ function CustomComponentsCarousel() {
|
|
|
916
916
|
}
|
|
917
917
|
const itemWidth = {
|
|
918
918
|
phone: '100%',
|
|
919
|
-
tablet: 'round(down, calc((100% - var(--space-
|
|
920
|
-
desktop: 'round(down, calc((100% - var(--space-
|
|
919
|
+
tablet: 'round(down, calc((100% - var(--space-2)) / 2), 1px)',
|
|
920
|
+
desktop: 'round(down, calc((100% - var(--space-2)) / 2), 1px)',
|
|
921
921
|
};
|
|
922
922
|
return (
|
|
923
923
|
<Box marginX={-3}>
|
|
@@ -926,7 +926,7 @@ function CustomComponentsCarousel() {
|
|
|
926
926
|
PaginationComponent={PaginationComponent}
|
|
927
927
|
styles={{
|
|
928
928
|
root: { paddingInline: 'var(--space-3)' },
|
|
929
|
-
carousel: { gap: 'var(--space-
|
|
929
|
+
carousel: { gap: 'var(--space-2)' },
|
|
930
930
|
}}
|
|
931
931
|
title={
|
|
932
932
|
<Text as="h3" font="headline">
|
|
@@ -1194,7 +1194,7 @@ function ComposedAutoplayCarousel() {
|
|
|
1194
1194
|
{showProgress && (
|
|
1195
1195
|
<m.div
|
|
1196
1196
|
animate={{ width: autoplay.isPlaying ? '100%' : `${progress * 100}%` }}
|
|
1197
|
-
initial={
|
|
1197
|
+
initial={{ width: '0%' }}
|
|
1198
1198
|
transition={{ duration: progressDuration, ease: 'linear' }}
|
|
1199
1199
|
style={{
|
|
1200
1200
|
height: '100%',
|
|
@@ -1366,7 +1366,7 @@ function DynamicContentCarousel() {
|
|
|
1366
1366
|
paginationVariant="dot"
|
|
1367
1367
|
styles={{
|
|
1368
1368
|
root: { paddingInline: 'var(--space-3)' },
|
|
1369
|
-
carousel: { gap: 'var(--space-
|
|
1369
|
+
carousel: { gap: 'var(--space-2)', height: '156px' },
|
|
1370
1370
|
}}
|
|
1371
1371
|
>
|
|
1372
1372
|
{items.map((asset, index) => (
|
|
@@ -1428,7 +1428,7 @@ function AnimatedCarousel() {
|
|
|
1428
1428
|
title="Explore Assets"
|
|
1429
1429
|
styles={{
|
|
1430
1430
|
root: { paddingInline: 'var(--space-3)' },
|
|
1431
|
-
carousel: { gap: 'var(--space-
|
|
1431
|
+
carousel: { gap: 'var(--space-2)' },
|
|
1432
1432
|
}}
|
|
1433
1433
|
snapMode="item"
|
|
1434
1434
|
hidePagination
|
|
@@ -1519,7 +1519,7 @@ function AnimatedSelectionCarousel() {
|
|
|
1519
1519
|
paginationVariant="dot"
|
|
1520
1520
|
styles={{
|
|
1521
1521
|
root: { paddingInline: 'var(--space-3)' },
|
|
1522
|
-
carousel: { gap: 'var(--space-
|
|
1522
|
+
carousel: { gap: 'var(--space-2)' },
|
|
1523
1523
|
}}
|
|
1524
1524
|
>
|
|
1525
1525
|
{Object.values(assets).map((asset, index) => (
|
|
@@ -1576,7 +1576,7 @@ function HideNavigationAndPaginationCarousel() {
|
|
|
1576
1576
|
snapMode="item"
|
|
1577
1577
|
styles={{
|
|
1578
1578
|
root: { paddingInline: 'var(--space-3)' },
|
|
1579
|
-
carousel: { gap: 'var(--space-
|
|
1579
|
+
carousel: { gap: 'var(--space-2)' },
|
|
1580
1580
|
}}
|
|
1581
1581
|
>
|
|
1582
1582
|
{Object.values(assets).map((asset, index) => (
|
|
@@ -1660,7 +1660,7 @@ function AnimatedPaginationCarousel() {
|
|
|
1660
1660
|
snapMode="page"
|
|
1661
1661
|
styles={{
|
|
1662
1662
|
root: { paddingInline: 'var(--space-3)' },
|
|
1663
|
-
carousel: { gap: 'var(--space-
|
|
1663
|
+
carousel: { gap: 'var(--space-2)' },
|
|
1664
1664
|
}}
|
|
1665
1665
|
title="Explore Assets"
|
|
1666
1666
|
>
|
|
@@ -1794,7 +1794,7 @@ function ImperativeApiCarousel() {
|
|
|
1794
1794
|
snapMode="item"
|
|
1795
1795
|
styles={{
|
|
1796
1796
|
root: { paddingInline: 'var(--space-3)' },
|
|
1797
|
-
carousel: { gap: 'var(--space-
|
|
1797
|
+
carousel: { gap: 'var(--space-2)' },
|
|
1798
1798
|
}}
|
|
1799
1799
|
title="Explore Assets"
|
|
1800
1800
|
>
|
|
@@ -1864,7 +1864,7 @@ You can use the `onChangePage`, `onDragStart`, and `onDragEnd` callbacks to list
|
|
|
1864
1864
|
| `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
|
|
1865
1865
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
1866
1866
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
1867
|
-
| `classNames` | `{ root?: string; title?: string \| undefined; navigation?: string \| undefined; pagination?: string \| undefined; carousel?: string \| undefined; carouselContainer?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the component
|
|
1867
|
+
| `classNames` | `{ root?: string; title?: string \| undefined; navigation?: string \| undefined; pagination?: string \| undefined; carousel?: string \| undefined; carouselContainer?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Carousel component |
|
|
1868
1868
|
| `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 | `-` | - |
|
|
1869
1869
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
1870
1870
|
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
@@ -1939,8 +1939,8 @@ You can use the `onChangePage`, `onDragStart`, and `onDragEnd` callbacks to list
|
|
|
1939
1939
|
| `snapMode` | `page \| item` | No | `'page'` | Specifies the pagination and navigation strategy for the carousel. item treats each item as a separate page for navigation, pagination, and snapping. page groups items into pages based on visible area for navigation, pagination, and snapping. This affects page calculation, navigation button behavior, and snap targets when dragging. |
|
|
1940
1940
|
| `startAutoplayAccessibilityLabel` | `string` | No | `'Play Carousel'` | Accessibility label for starting autoplay. |
|
|
1941
1941
|
| `stopAutoplayAccessibilityLabel` | `string` | No | `'Pause Carousel'` | Accessibility label for stopping autoplay. |
|
|
1942
|
-
| `style` | `CSSProperties` | No | `-` |
|
|
1943
|
-
| `styles` | `{ root?: CSSProperties; title?: CSSProperties \| undefined; navigation?: CSSProperties \| undefined; pagination?: CSSProperties \| undefined; carousel?: CSSProperties \| undefined; carouselContainer?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the component
|
|
1942
|
+
| `style` | `CSSProperties` | No | `-` | - |
|
|
1943
|
+
| `styles` | `{ root?: CSSProperties; title?: CSSProperties \| undefined; navigation?: CSSProperties \| undefined; pagination?: CSSProperties \| undefined; carousel?: CSSProperties \| undefined; carouselContainer?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Carousel component |
|
|
1944
1944
|
| `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 |
|
|
1945
1945
|
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
|
|
1946
1946
|
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
|
|
@@ -1958,11 +1958,11 @@ You can use the `onChangePage`, `onDragStart`, and `onDragEnd` callbacks to list
|
|
|
1958
1958
|
|
|
1959
1959
|
| Selector | Static class name | Description |
|
|
1960
1960
|
| --- | --- | --- |
|
|
1961
|
-
| `root` | `-` |
|
|
1962
|
-
| `title` | `-` |
|
|
1963
|
-
| `navigation` | `-` |
|
|
1964
|
-
| `pagination` | `-` |
|
|
1965
|
-
| `carousel` | `-` |
|
|
1966
|
-
| `carouselContainer` | `-` |
|
|
1961
|
+
| `root` | `-` | Root element |
|
|
1962
|
+
| `title` | `-` | Title text element |
|
|
1963
|
+
| `navigation` | `-` | Navigation controls element |
|
|
1964
|
+
| `pagination` | `-` | Pagination indicators element |
|
|
1965
|
+
| `carousel` | `-` | Main carousel track element |
|
|
1966
|
+
| `carouselContainer` | `-` | Outer carousel container element |
|
|
1967
1967
|
|
|
1968
1968
|
|
|
@@ -85,7 +85,6 @@ function CustomCheckboxCellExample() {
|
|
|
85
85
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
86
86
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
87
87
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
88
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
89
88
|
| `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. |
|
|
90
89
|
| `aspectRatio` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
91
90
|
| `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). |
|
|
@@ -121,7 +120,6 @@ function CustomCheckboxCellExample() {
|
|
|
121
120
|
| `disabled` | `boolean` | No | `-` | Is the element currently disabled. Disable user interaction. |
|
|
122
121
|
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
123
122
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
124
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
125
123
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
126
124
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
127
125
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -206,10 +204,10 @@ function CustomCheckboxCellExample() {
|
|
|
206
204
|
|
|
207
205
|
| Selector | Static class name | Description |
|
|
208
206
|
| --- | --- | --- |
|
|
209
|
-
| `root` | `-` |
|
|
210
|
-
| `checkboxContainer` | `-` |
|
|
211
|
-
| `title` | `-` |
|
|
212
|
-
| `description` | `-` |
|
|
213
|
-
| `contentContainer` | `-` |
|
|
207
|
+
| `root` | `-` | Root element |
|
|
208
|
+
| `checkboxContainer` | `-` | Checkbox input container element |
|
|
209
|
+
| `title` | `-` | Title text element |
|
|
210
|
+
| `description` | `-` | Description text element |
|
|
211
|
+
| `contentContainer` | `-` | Content container element |
|
|
214
212
|
|
|
215
213
|
|
|
@@ -81,7 +81,6 @@ function Example() {
|
|
|
81
81
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
82
82
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
83
83
|
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
84
|
-
| `analyticsId` | `string` | No | `-` | - |
|
|
85
84
|
| `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. |
|
|
86
85
|
| `aspectRatio` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
87
86
|
| `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). |
|
|
@@ -108,7 +107,7 @@ function Example() {
|
|
|
108
107
|
| `bottom` | `ResponsiveProp<Bottom<string \| number>>` | No | `-` | - |
|
|
109
108
|
| `children` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | ReactNode placed in the center of the Chip |
|
|
110
109
|
| `className` | `string` | No | `-` | Apply class names to the outer container. |
|
|
111
|
-
| `classNames` | `{ root?: string; content?: string \| undefined; } \| undefined` | No | `-` |
|
|
110
|
+
| `classNames` | `{ root?: string; content?: string \| undefined; } \| undefined` | No | `-` | Custom class names for individual elements of the Chip component |
|
|
112
111
|
| `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 | `-` | - |
|
|
113
112
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
114
113
|
| `compact` | `boolean` | No | `-` | Reduces spacing around Chip content |
|
|
@@ -118,7 +117,6 @@ function Example() {
|
|
|
118
117
|
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
119
118
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
120
119
|
| `end` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | ReactNode placed after the value |
|
|
121
|
-
| `eventConfig` | `EventHandlerCustomConfig` | No | `-` | - |
|
|
122
120
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
123
121
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
124
122
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -182,7 +180,7 @@ function Example() {
|
|
|
182
180
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
183
181
|
| `start` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | ReactNode placed before the value |
|
|
184
182
|
| `style` | `CSSProperties` | No | `-` | - |
|
|
185
|
-
| `styles` | `{ root?: CSSProperties; content?: CSSProperties \| undefined; } \| undefined` | No | `-` |
|
|
183
|
+
| `styles` | `{ root?: CSSProperties; content?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for individual elements of the Chip component |
|
|
186
184
|
| `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 |
|
|
187
185
|
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
|
|
188
186
|
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
|
|
@@ -202,7 +200,7 @@ function Example() {
|
|
|
202
200
|
|
|
203
201
|
| Selector | Static class name | Description |
|
|
204
202
|
| --- | --- | --- |
|
|
205
|
-
| `root` | `-` |
|
|
206
|
-
| `content` | `-` |
|
|
203
|
+
| `root` | `-` | Root element |
|
|
204
|
+
| `content` | `-` | Content element |
|
|
207
205
|
|
|
208
206
|
|
|
@@ -113,13 +113,6 @@ function Horizontal() {
|
|
|
113
113
|
| `key` | `Key \| null` | No | `-` | - |
|
|
114
114
|
| `maxHeight` | `ResponsiveProp<MaxHeight<string \| number>>` | No | `-` | Max height of the content. Overflow content will be scrollable. |
|
|
115
115
|
| `maxWidth` | `ResponsiveProp<MaxWidth<string \| number>>` | No | `-` | Max width of the content. Overflow content will be scrollable. |
|
|
116
|
-
| `padding` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Apply padding on all sides. |
|
|
117
|
-
| `paddingBottom` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Apply padding on the bottom side. |
|
|
118
|
-
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Apply padding on the end side. |
|
|
119
|
-
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Apply padding on the start side. |
|
|
120
|
-
| `paddingTop` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Apply padding on the top side. |
|
|
121
|
-
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Apply padding on the start and end sides. |
|
|
122
|
-
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | Apply padding on the top and bottom sides. |
|
|
123
116
|
| `ref` | `RefObject<HTMLDivElement> \| ((instance: HTMLDivElement \| null) => void) \| null` | No | `-` | - |
|
|
124
117
|
| `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 |
|
|
125
118
|
|