@coinbase/cds-mcp-server 8.61.0 → 8.62.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 +8 -0
- package/mcp-docs/mobile/components/AvatarButton.txt +17 -4
- package/mcp-docs/mobile/components/ControlGroup.txt +3 -2
- package/mcp-docs/mobile/components/ModalBody.txt +1 -1
- package/mcp-docs/mobile/components/ModalFooter.txt +2 -2
- package/mcp-docs/mobile/components/ModalHeader.txt +3 -3
- package/mcp-docs/mobile/components/Numpad.txt +1 -1
- package/mcp-docs/mobile/components/RemoteImageGroup.txt +1 -1
- package/mcp-docs/mobile/components/TabbedChipsAlpha.txt +78 -4
- package/mcp-docs/mobile/components/Tabs.txt +1 -1
- package/mcp-docs/mobile/components/Tag.txt +2 -2
- package/mcp-docs/mobile/components/Tour.txt +2 -2
- package/mcp-docs/mobile/getting-started/theming.txt +96 -0
- package/mcp-docs/web/components/ControlGroup.txt +1 -0
- package/mcp-docs/web/components/DatePicker.txt +1 -1
- package/mcp-docs/web/components/Dropdown.txt +3 -3
- package/mcp-docs/web/components/FocusTrap.txt +7 -7
- package/mcp-docs/web/components/FullscreenModal.txt +3 -3
- package/mcp-docs/web/components/FullscreenModalLayout.txt +1 -1
- package/mcp-docs/web/components/Modal.txt +2 -2
- package/mcp-docs/web/components/ModalBody.txt +5 -5
- package/mcp-docs/web/components/ModalFooter.txt +7 -7
- package/mcp-docs/web/components/ModalHeader.txt +3 -3
- package/mcp-docs/web/components/NavigationTitleSelect.txt +102 -0
- package/mcp-docs/web/components/Overlay.txt +0 -1
- package/mcp-docs/web/components/Pagination.txt +8 -8
- package/mcp-docs/web/components/RemoteImageGroup.txt +1 -1
- package/mcp-docs/web/components/SelectChip.txt +3 -3
- package/mcp-docs/web/components/Switch.txt +2 -2
- package/mcp-docs/web/components/TabbedChipsAlpha.txt +90 -1
- package/mcp-docs/web/components/Table.txt +1 -0
- package/mcp-docs/web/components/TableCaption.txt +2 -0
- package/mcp-docs/web/components/TableCellFallback.txt +1 -0
- package/mcp-docs/web/components/TableRow.txt +3 -0
- package/mcp-docs/web/components/Tooltip.txt +5 -5
- package/mcp-docs/web/components/Tour.txt +3 -3
- package/mcp-docs/web/components/Tray.txt +2 -2
- package/mcp-docs/web/getting-started/theming.txt +98 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -8,6 +8,14 @@ All notable changes to this project will be documented in this file.
|
|
|
8
8
|
|
|
9
9
|
<!-- template-start -->
|
|
10
10
|
|
|
11
|
+
## 8.62.1 ((4/1/2026, 12:25 PM PST))
|
|
12
|
+
|
|
13
|
+
This is an artificial version bump with no new change.
|
|
14
|
+
|
|
15
|
+
## 8.62.0 ((3/30/2026, 06:52 PM PST))
|
|
16
|
+
|
|
17
|
+
This is an artificial version bump with no new change.
|
|
18
|
+
|
|
11
19
|
## 8.61.0 ((3/30/2026, 02:40 PM PST))
|
|
12
20
|
|
|
13
21
|
This is an artificial version bump with no new change.
|
|
@@ -150,6 +150,7 @@ AvatarButton can use fallback colors with names when no image source is provided
|
|
|
150
150
|
| `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
|
|
151
151
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
152
152
|
| `bottom` | `string \| number` | No | `-` | - |
|
|
153
|
+
| `children` | `((string \| number \| boolean \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal) & (string \| number \| boolean \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| ((state: PressableStateCallbackType) => ReactNode))) \| null` | No | `-` | Either children or a render prop that receives a boolean reflecting whether the component is currently pressed. |
|
|
153
154
|
| `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 | `-` | - |
|
|
154
155
|
| `colorScheme` | `blue \| green \| orange \| yellow \| gray \| indigo \| pink \| purple \| red \| teal \| chartreuse` | No | `blue` | Override the default fallback background and border color |
|
|
155
156
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
@@ -158,7 +159,7 @@ AvatarButton can use fallback colors with names when no image source is provided
|
|
|
158
159
|
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
159
160
|
| `debounceTime` | `number` | No | `500` | The amount of time to wait (in milliseconds) before invoking the debounced function. This prop is used in conjunction with the disableDebounce prop. The debounce function is configured to be invoked as soon as its called, but subsequent calls within the debounceTime period will be ignored. |
|
|
160
161
|
| `disableDebounce` | `boolean` | No | `-` | React Native is historically trash at debouncing touch events. This can cause a lot of unwanted behavior such as double navigations where we push a screen onto the stack 2 times. Debouncing the event 500 miliseconds, but taking the leading event prevents this effect and the accidental double-tap. |
|
|
161
|
-
| `disabled` | `boolean` | No | `-` | Is the element currently disabled. |
|
|
162
|
+
| `disabled` | `boolean` | No | `-` | Is the element currently disabled. Whether the press behavior is disabled. |
|
|
162
163
|
| `display` | `flex \| none` | No | `-` | - |
|
|
163
164
|
| `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. |
|
|
164
165
|
| `feedback` | `none \| light \| normal \| heavy` | No | `none` | Haptic feedback to trigger when being pressed. |
|
|
@@ -190,9 +191,21 @@ AvatarButton can use fallback colors with names when no image source is provided
|
|
|
190
191
|
| `minWidth` | `string \| number` | No | `-` | - |
|
|
191
192
|
| `name` | `string` | No | `-` | This is the name associated with the Avatars entity. It will be used to generate a fallback. |
|
|
192
193
|
| `noScaleOnPress` | `boolean` | No | `-` | Dont scale element on press. |
|
|
194
|
+
| `onPointerCancel` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
195
|
+
| `onPointerCancelCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
196
|
+
| `onPointerDown` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
197
|
+
| `onPointerDownCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
198
|
+
| `onPointerEnter` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
199
|
+
| `onPointerEnterCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
200
|
+
| `onPointerLeave` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
201
|
+
| `onPointerLeaveCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
202
|
+
| `onPointerMove` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
203
|
+
| `onPointerMoveCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
204
|
+
| `onPointerUp` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
205
|
+
| `onPointerUpCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
|
|
193
206
|
| `onPress` | `((event: GestureResponderEvent) => void) \| null` | No | `-` | Called when a single tap gesture is detected. |
|
|
194
|
-
| `onPressIn` | `((event: GestureResponderEvent) => void)` | No | `-` | Callback fired before onPress when button is pressed. |
|
|
195
|
-
| `onPressOut` | `((event: GestureResponderEvent) => void)` | No | `-` | Callback fired before onPress when button is released. |
|
|
207
|
+
| `onPressIn` | `(((event: GestureResponderEvent) => void) & ((event: GestureResponderEvent) => void))` | No | `-` | Callback fired before onPress when button is pressed. Called when a touch is engaged before onPress. |
|
|
208
|
+
| `onPressOut` | `(((event: GestureResponderEvent) => void) & ((event: GestureResponderEvent) => void))` | No | `-` | Callback fired before onPress when button is released. Called when a touch is released before onPress. |
|
|
196
209
|
| `opacity` | `number \| AnimatedNode` | No | `-` | - |
|
|
197
210
|
| `overflow` | `visible \| hidden \| scroll` | No | `-` | - |
|
|
198
211
|
| `padding` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
@@ -208,7 +221,7 @@ AvatarButton can use fallback colors with names when no image source is provided
|
|
|
208
221
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
209
222
|
| `shape` | `circle \| square \| hexagon` | No | `-` | Shape of Avatar. |
|
|
210
223
|
| `src` | `string` | No | `-` | Absolute url to the image that should be shown in the Avatar. If no src is provided then a generic fallback image is used. |
|
|
211
|
-
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. 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 |
|
|
224
|
+
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. 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 Used to locate this view in end-to-end tests. |
|
|
212
225
|
| `textAlign` | `left \| right \| auto \| center \| justify` | No | `-` | - |
|
|
213
226
|
| `textDecorationLine` | `none \| underline \| line-through \| underline line-through` | No | `-` | - |
|
|
214
227
|
| `textDecorationStyle` | `solid \| dotted \| dashed \| double` | No | `-` | - |
|
|
@@ -342,6 +342,7 @@ function CustomRadioButtonExample() {
|
|
|
342
342
|
| `ControlComponent` | `ComponentClass<ControlComponentProps, any> \| FunctionComponent<ControlComponentProps>` | Yes | `-` | The control component to render for each option. |
|
|
343
343
|
| `options` | `(ControlGroupOption<ControlComponentProps> & { value: ControlValue; })[]` | Yes | `-` | Control options for the group. |
|
|
344
344
|
| `value` | `string \| ControlValue[]` | Yes | `-` | Current selected value(s). Use a string for single-select (e.g., RadioGroup) and an array of strings for multi-select (e.g., CheckboxGroup). |
|
|
345
|
+
| `accessibilityLabel` | `string` | No | `-` | Accessibility label describing the group of items. Overrides the text thats read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space. |
|
|
345
346
|
| `alignContent` | `flex-start \| flex-end \| center \| stretch \| space-between \| space-around \| space-evenly` | No | `-` | - |
|
|
346
347
|
| `alignItems` | `flex-start \| flex-end \| center \| stretch \| baseline` | No | `-` | - |
|
|
347
348
|
| `alignSelf` | `auto \| FlexAlignType` | No | `-` | - |
|
|
@@ -425,11 +426,11 @@ function CustomRadioButtonExample() {
|
|
|
425
426
|
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
426
427
|
| `position` | `static \| relative \| fixed \| absolute \| sticky` | No | `-` | - |
|
|
427
428
|
| `ref` | `null \| (instance: View \| null) => void \| RefObject<View>` | No | `-` | - |
|
|
428
|
-
| `renderItem` | `((info: { Wrapper: ComponentType<PropsWithChildren<BoxProps>>; item: ReactChild; index: number; isFirst: boolean; isLast: boolean; }) => ReactChild)` | No | `Box component for given platform` | Control the layout of each item in a group. |
|
|
429
|
+
| `renderItem` | `(((info: { Wrapper: ComponentType<PropsWithChildren<BoxBaseProps>>; item: ReactChild; index: number; isFirst: boolean; isLast: boolean; }) => ReactChild) & ((info: { Wrapper: ComponentType<PropsWithChildren<BoxProps>>; item: ReactChild; index: number; isFirst: boolean; isLast: boolean; }) => ReactChild))` | No | `Box component for given platform` | Control the layout of each item in a group. |
|
|
429
430
|
| `right` | `string \| number` | No | `-` | - |
|
|
430
431
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
431
432
|
| `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 | `-` | - |
|
|
432
|
-
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Used to locate this
|
|
433
|
+
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. 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 Used to locate this view in end-to-end tests. |
|
|
433
434
|
| `textAlign` | `left \| right \| auto \| center \| justify` | No | `-` | - |
|
|
434
435
|
| `textDecorationLine` | `none \| underline \| line-through \| underline line-through` | No | `-` | - |
|
|
435
436
|
| `textDecorationStyle` | `solid \| dotted \| dashed \| double` | No | `-` | - |
|
|
@@ -131,7 +131,7 @@ function AccessibilityExample() {
|
|
|
131
131
|
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
132
132
|
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
133
133
|
| `paddingTop` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
134
|
-
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No |
|
|
134
|
+
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
135
135
|
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
136
136
|
| `testID` | `string` | No | `-` | Used to locate this view in end-to-end tests. |
|
|
137
137
|
|
|
@@ -249,8 +249,8 @@ function LoadingExample() {
|
|
|
249
249
|
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
250
250
|
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
251
251
|
| `paddingTop` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
252
|
-
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No |
|
|
253
|
-
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No |
|
|
252
|
+
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
253
|
+
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
254
254
|
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
255
255
|
| `position` | `static \| relative \| fixed \| absolute \| sticky` | No | `-` | - |
|
|
256
256
|
| `right` | `string \| number` | No | `-` | - |
|
|
@@ -194,7 +194,7 @@ function WizardExample() {
|
|
|
194
194
|
| Prop | Type | Required | Default | Description |
|
|
195
195
|
| --- | --- | --- | --- | --- |
|
|
196
196
|
| `alignContent` | `flex-start \| flex-end \| center \| stretch \| space-between \| space-around \| space-evenly` | No | `-` | - |
|
|
197
|
-
| `alignItems` | `flex-start \| flex-end \| center \| stretch \| baseline` | No |
|
|
197
|
+
| `alignItems` | `flex-start \| flex-end \| center \| stretch \| baseline` | No | `-` | - |
|
|
198
198
|
| `alignSelf` | `auto \| FlexAlignType` | No | `-` | - |
|
|
199
199
|
| `animated` | `boolean` | No | `-` | - |
|
|
200
200
|
| `aspectRatio` | `string \| number` | No | `-` | - |
|
|
@@ -272,8 +272,8 @@ function WizardExample() {
|
|
|
272
272
|
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
273
273
|
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
274
274
|
| `paddingTop` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
275
|
-
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No |
|
|
276
|
-
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No |
|
|
275
|
+
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
276
|
+
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
277
277
|
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
278
278
|
| `position` | `static \| relative \| fixed \| absolute \| sticky` | No | `-` | - |
|
|
279
279
|
| `right` | `string \| number` | No | `-` | - |
|
|
@@ -326,7 +326,7 @@ const TransactionalNumpadExample = () => {
|
|
|
326
326
|
| `separator` | `string` | No | `-` | - |
|
|
327
327
|
| `separatorAccessibilityLabel` | `string` | No | `-` | - |
|
|
328
328
|
| `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 | `-` | - |
|
|
329
|
-
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests.
|
|
329
|
+
| `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. 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 |
|
|
330
330
|
| `textAlign` | `left \| right \| auto \| center \| justify` | No | `-` | - |
|
|
331
331
|
| `textDecorationLine` | `none \| underline \| line-through \| underline line-through` | No | `-` | - |
|
|
332
332
|
| `textDecorationStyle` | `solid \| dotted \| dashed \| double` | No | `-` | - |
|
|
@@ -64,7 +64,7 @@ Use the `borderWidth` and `borderColor` props to change border style of the imag
|
|
|
64
64
|
|
|
65
65
|
| Prop | Type | Required | Default | Description |
|
|
66
66
|
| --- | --- | --- | --- | --- |
|
|
67
|
-
| `borderColor` | `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 |
|
|
67
|
+
| `borderColor` | `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 | `-` | - |
|
|
68
68
|
| `borderWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
69
69
|
| `children` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Children content |
|
|
70
70
|
| `max` | `number` | No | `4` | Indicates the number of remote image before it collapses |
|
|
@@ -192,14 +192,90 @@ render(<Example />);
|
|
|
192
192
|
| `tabs` | `TabbedChipProps<TabId>[]` | Yes | `-` | - |
|
|
193
193
|
| `TabComponent` | `FC<TabbedChipProps<TabId>>` | No | `-` | - |
|
|
194
194
|
| `TabsActiveIndicatorComponent` | `TabsActiveIndicatorComponent` | No | `-` | - |
|
|
195
|
+
| `alignContent` | `flex-start \| flex-end \| center \| stretch \| space-between \| space-around \| space-evenly` | No | `-` | - |
|
|
196
|
+
| `alignItems` | `flex-start \| flex-end \| center \| stretch \| baseline` | No | `-` | - |
|
|
197
|
+
| `alignSelf` | `auto \| FlexAlignType` | No | `-` | - |
|
|
198
|
+
| `animated` | `boolean` | No | `-` | - |
|
|
199
|
+
| `aspectRatio` | `string \| number` | No | `-` | - |
|
|
195
200
|
| `autoScrollOffset` | `number` | No | `30` | X position offset when auto-scrolling to active tab (to avoid active tab being covered by the overflow gradient on the left side, default: 30px) |
|
|
201
|
+
| `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 | `-` | - |
|
|
202
|
+
| `borderBottomLeftRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
203
|
+
| `borderBottomRightRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
204
|
+
| `borderBottomWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
205
|
+
| `borderColor` | `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 | `-` | - |
|
|
206
|
+
| `borderEndWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
207
|
+
| `borderRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
208
|
+
| `borderStartWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
209
|
+
| `borderTopLeftRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
210
|
+
| `borderTopRightRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
211
|
+
| `borderTopWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
212
|
+
| `borderWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
213
|
+
| `bordered` | `boolean` | No | `-` | Add a border around all sides of the box. |
|
|
214
|
+
| `borderedBottom` | `boolean` | No | `-` | Add a border to the bottom side of the box. |
|
|
215
|
+
| `borderedEnd` | `boolean` | No | `-` | Add a border to the trailing side of the box. |
|
|
216
|
+
| `borderedHorizontal` | `boolean` | No | `-` | Add a border to the leading and trailing sides of the box. |
|
|
217
|
+
| `borderedStart` | `boolean` | No | `-` | Add a border to the leading side of the box. |
|
|
218
|
+
| `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
|
|
219
|
+
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
220
|
+
| `bottom` | `string \| number` | No | `-` | - |
|
|
221
|
+
| `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 | `-` | - |
|
|
222
|
+
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
196
223
|
| `compact` | `boolean` | No | `false` | Turn on to use a compact Chip component for each tab. |
|
|
224
|
+
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
197
225
|
| `disabled` | `boolean` | No | `-` | Disable interactions on all the tabs. |
|
|
226
|
+
| `display` | `flex \| none` | No | `-` | - |
|
|
227
|
+
| `elevation` | `0 \| 1 \| 2` | No | `-` | Determines box shadow styles. Parent should have overflow set to visible to ensure styles are not clipped. |
|
|
228
|
+
| `flexBasis` | `string \| number` | No | `-` | - |
|
|
229
|
+
| `flexDirection` | `row \| column \| row-reverse \| column-reverse` | No | `-` | - |
|
|
230
|
+
| `flexGrow` | `number` | No | `-` | - |
|
|
231
|
+
| `flexShrink` | `number` | No | `-` | - |
|
|
232
|
+
| `flexWrap` | `wrap \| nowrap \| wrap-reverse` | No | `-` | - |
|
|
233
|
+
| `font` | `inherit \| FontFamily` | No | `-` | - |
|
|
234
|
+
| `fontFamily` | `inherit \| FontFamily` | No | `-` | - |
|
|
235
|
+
| `fontSize` | `inherit \| FontSize` | No | `-` | - |
|
|
236
|
+
| `fontWeight` | `inherit \| FontWeight` | No | `-` | - |
|
|
198
237
|
| `gap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `1` | The spacing between Tabs |
|
|
238
|
+
| `height` | `string \| number` | No | `-` | - |
|
|
239
|
+
| `justifyContent` | `flex-start \| flex-end \| center \| space-between \| space-around \| space-evenly` | No | `-` | - |
|
|
240
|
+
| `left` | `string \| number` | No | `-` | - |
|
|
241
|
+
| `lineHeight` | `inherit \| LineHeight` | No | `-` | - |
|
|
242
|
+
| `margin` | `0 \| -1 \| -2 \| -0.25 \| -0.5 \| -0.75 \| -1.5 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10` | No | `-` | - |
|
|
243
|
+
| `marginBottom` | `0 \| -1 \| -2 \| -0.25 \| -0.5 \| -0.75 \| -1.5 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10` | No | `-` | - |
|
|
244
|
+
| `marginEnd` | `0 \| -1 \| -2 \| -0.25 \| -0.5 \| -0.75 \| -1.5 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10` | No | `-` | - |
|
|
245
|
+
| `marginStart` | `0 \| -1 \| -2 \| -0.25 \| -0.5 \| -0.75 \| -1.5 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10` | No | `-` | - |
|
|
246
|
+
| `marginTop` | `0 \| -1 \| -2 \| -0.25 \| -0.5 \| -0.75 \| -1.5 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10` | No | `-` | - |
|
|
247
|
+
| `marginX` | `0 \| -1 \| -2 \| -0.25 \| -0.5 \| -0.75 \| -1.5 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10` | No | `-` | - |
|
|
248
|
+
| `marginY` | `0 \| -1 \| -2 \| -0.25 \| -0.5 \| -0.75 \| -1.5 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10` | No | `-` | - |
|
|
249
|
+
| `maxHeight` | `string \| number` | No | `-` | - |
|
|
250
|
+
| `maxWidth` | `string \| number` | No | `-` | - |
|
|
251
|
+
| `minHeight` | `string \| number` | No | `-` | - |
|
|
252
|
+
| `minWidth` | `string \| number` | No | `-` | - |
|
|
253
|
+
| `opacity` | `number \| AnimatedNode` | No | `-` | - |
|
|
254
|
+
| `overflow` | `visible \| hidden \| scroll` | No | `-` | - |
|
|
255
|
+
| `padding` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
256
|
+
| `paddingBottom` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
257
|
+
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
258
|
+
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
259
|
+
| `paddingTop` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
260
|
+
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
261
|
+
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
262
|
+
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
263
|
+
| `position` | `static \| relative \| fixed \| absolute \| sticky` | No | `-` | - |
|
|
199
264
|
| `ref` | `null \| (instance: View \| null) => void \| MutableRefObject<View \| null>` | No | `-` | - |
|
|
200
|
-
| `
|
|
201
|
-
| `
|
|
265
|
+
| `right` | `string \| number` | No | `-` | - |
|
|
266
|
+
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
267
|
+
| `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 | `-` | - |
|
|
268
|
+
| `styles` | `{ root?: StyleProp<ViewStyle>; tabs?: StyleProp<ViewStyle>; }` | No | `-` | - |
|
|
269
|
+
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. 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 |
|
|
270
|
+
| `textAlign` | `left \| right \| auto \| center \| justify` | No | `-` | - |
|
|
271
|
+
| `textDecorationLine` | `none \| underline \| line-through \| underline line-through` | No | `-` | - |
|
|
272
|
+
| `textDecorationStyle` | `solid \| dotted \| dashed \| double` | No | `-` | - |
|
|
273
|
+
| `textTransform` | `none \| capitalize \| uppercase \| lowercase` | No | `-` | - |
|
|
274
|
+
| `top` | `string \| number` | No | `-` | - |
|
|
275
|
+
| `transform` | `string \| (({ scaleX: AnimatableNumericValue; } & { scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ scaleY: AnimatableNumericValue; } & { scaleX?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ translateX: AnimatableNumericValue \| ${number}%; } & { scaleX?: undefined; scaleY?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ translateY: AnimatableNumericValue \| ${number}%; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ perspective: AnimatableNumericValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ rotate: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ rotateX: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ rotateY: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ rotateZ: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ scale: AnimatableNumericValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ skewX: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ skewY: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; matrix?: undefined; }) \| ({ matrix: AnimatableNumericValue[]; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; }))[]` | No | `-` | - |
|
|
276
|
+
| `userSelect` | `none \| auto \| text \| contain \| all` | No | `-` | - |
|
|
202
277
|
| `width` | `string \| number` | No | `-` | The width of the scroll container, defaults to 100% of the parent container If the tabs are wider than the width of the container, paddles will be shown to scroll the tabs. |
|
|
278
|
+
| `zIndex` | `number` | No | `-` | - |
|
|
203
279
|
|
|
204
280
|
|
|
205
281
|
## Styles
|
|
@@ -207,8 +283,6 @@ render(<Example />);
|
|
|
207
283
|
| Selector | Static class name | Description |
|
|
208
284
|
| --- | --- | --- |
|
|
209
285
|
| `root` | `-` | Root container element |
|
|
210
|
-
| `tab` | `-` | Tab element |
|
|
211
|
-
| `activeIndicator` | `-` | Active indicator element |
|
|
212
286
|
| `tabs` | `-` | Tabs root element |
|
|
213
287
|
|
|
214
288
|
|
|
@@ -350,7 +350,7 @@ function Example() {
|
|
|
350
350
|
| `right` | `string \| number` | No | `-` | - |
|
|
351
351
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
352
352
|
| `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 | `-` | - |
|
|
353
|
-
| `styles` | `{ root?: StyleProp<ViewStyle>; tab?: StyleProp<ViewStyle>; activeIndicator?: StyleProp<ViewStyle>; }` | No | `-` |
|
|
353
|
+
| `styles` | `{ root?: StyleProp<ViewStyle>; tab?: StyleProp<ViewStyle>; activeIndicator?: StyleProp<ViewStyle>; }` | No | `-` | - |
|
|
354
354
|
| `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. |
|
|
355
355
|
| `textAlign` | `left \| right \| auto \| center \| justify` | No | `-` | - |
|
|
356
356
|
| `textDecorationLine` | `none \| underline \| line-through \| underline line-through` | No | `-` | - |
|
|
@@ -242,7 +242,7 @@ function MarginExample() {
|
|
|
242
242
|
| `alignSelf` | `auto \| FlexAlignType` | No | `-` | - |
|
|
243
243
|
| `animated` | `boolean` | No | `-` | - |
|
|
244
244
|
| `aspectRatio` | `string \| number` | No | `-` | - |
|
|
245
|
-
| `background` | `blue0 \| blue5 \| blue10 \| blue15 \| blue20 \| blue100 \|
|
|
245
|
+
| `background` | `blue0 \| blue5 \| blue10 \| blue15 \| blue20 \| blue100 \| blue30 \| blue40 \| blue50 \| blue60 \| blue70 \| blue80 \| blue90 \| green0 \| green5 \| green10 \| green15 \| green20 \| green100 \| green30 \| green40 \| green50 \| green60 \| green70 \| green80 \| green90 \| orange0 \| orange5 \| orange10 \| orange15 \| orange20 \| orange100 \| orange30 \| orange40 \| orange50 \| orange60 \| orange70 \| orange80 \| orange90 \| yellow0 \| yellow5 \| yellow10 \| yellow15 \| yellow20 \| yellow100 \| yellow30 \| yellow40 \| yellow50 \| yellow60 \| yellow70 \| yellow80 \| yellow90 \| gray0 \| gray5 \| gray10 \| gray15 \| gray20 \| gray100 \| gray30 \| gray40 \| gray50 \| gray60 \| gray70 \| gray80 \| gray90 \| indigo0 \| indigo5 \| indigo10 \| indigo15 \| indigo20 \| indigo100 \| indigo30 \| indigo40 \| indigo50 \| indigo60 \| indigo70 \| indigo80 \| indigo90 \| pink0 \| pink5 \| pink10 \| pink15 \| pink20 \| pink100 \| pink30 \| pink40 \| pink50 \| pink60 \| pink70 \| pink80 \| pink90 \| purple0 \| purple5 \| purple10 \| purple15 \| purple20 \| purple100 \| purple30 \| purple40 \| purple50 \| purple60 \| purple70 \| purple80 \| purple90 \| red0 \| red5 \| red10 \| red15 \| red20 \| red100 \| red30 \| red40 \| red50 \| red60 \| red70 \| red80 \| red90 \| teal0 \| teal5 \| teal10 \| teal15 \| teal20 \| teal100 \| teal30 \| teal40 \| teal50 \| teal60 \| teal70 \| teal80 \| teal90 \| chartreuse0 \| chartreuse5 \| chartreuse10 \| chartreuse15 \| chartreuse20 \| chartreuse100 \| chartreuse30 \| chartreuse40 \| chartreuse50 \| chartreuse60 \| chartreuse70 \| chartreuse80 \| chartreuse90` | No | `-` | - |
|
|
246
246
|
| `borderBottomLeftRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
247
247
|
| `borderBottomRightRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
248
248
|
| `borderBottomWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
@@ -262,7 +262,7 @@ function MarginExample() {
|
|
|
262
262
|
| `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
|
|
263
263
|
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
264
264
|
| `bottom` | `string \| number` | No | `-` | - |
|
|
265
|
-
| `color` | `blue0 \| blue5 \| blue10 \| blue15 \| blue20 \| blue100 \|
|
|
265
|
+
| `color` | `blue0 \| blue5 \| blue10 \| blue15 \| blue20 \| blue100 \| blue30 \| blue40 \| blue50 \| blue60 \| blue70 \| blue80 \| blue90 \| green0 \| green5 \| green10 \| green15 \| green20 \| green100 \| green30 \| green40 \| green50 \| green60 \| green70 \| green80 \| green90 \| orange0 \| orange5 \| orange10 \| orange15 \| orange20 \| orange100 \| orange30 \| orange40 \| orange50 \| orange60 \| orange70 \| orange80 \| orange90 \| yellow0 \| yellow5 \| yellow10 \| yellow15 \| yellow20 \| yellow100 \| yellow30 \| yellow40 \| yellow50 \| yellow60 \| yellow70 \| yellow80 \| yellow90 \| gray0 \| gray5 \| gray10 \| gray15 \| gray20 \| gray100 \| gray30 \| gray40 \| gray50 \| gray60 \| gray70 \| gray80 \| gray90 \| indigo0 \| indigo5 \| indigo10 \| indigo15 \| indigo20 \| indigo100 \| indigo30 \| indigo40 \| indigo50 \| indigo60 \| indigo70 \| indigo80 \| indigo90 \| pink0 \| pink5 \| pink10 \| pink15 \| pink20 \| pink100 \| pink30 \| pink40 \| pink50 \| pink60 \| pink70 \| pink80 \| pink90 \| purple0 \| purple5 \| purple10 \| purple15 \| purple20 \| purple100 \| purple30 \| purple40 \| purple50 \| purple60 \| purple70 \| purple80 \| purple90 \| red0 \| red5 \| red10 \| red15 \| red20 \| red100 \| red30 \| red40 \| red50 \| red60 \| red70 \| red80 \| red90 \| teal0 \| teal5 \| teal10 \| teal15 \| teal20 \| teal100 \| teal30 \| teal40 \| teal50 \| teal60 \| teal70 \| teal80 \| teal90 \| chartreuse0 \| chartreuse5 \| chartreuse10 \| chartreuse15 \| chartreuse20 \| chartreuse100 \| chartreuse30 \| chartreuse40 \| chartreuse50 \| chartreuse60 \| chartreuse70 \| chartreuse80 \| chartreuse90` | No | `-` | - |
|
|
266
266
|
| `colorScheme` | `blue \| green \| yellow \| gray \| purple \| red` | No | `blue` | Specify the colorScheme of the Tag |
|
|
267
267
|
| `columnGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
268
268
|
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
@@ -486,12 +486,12 @@ function CallbacksExample() {
|
|
|
486
486
|
| `steps` | `TourStepValue<TourStepId>[]` | Yes | `-` | - |
|
|
487
487
|
| `TourMaskComponent` | `TourMaskComponent` | No | `DefaultTourMask` | The Component to render as a tour overlay and mask. |
|
|
488
488
|
| `TourStepArrowComponent` | `TourStepArrowComponent` | No | `DefaultTourStepArrow` | The default Component to render for each TourStep arrow element. |
|
|
489
|
-
| `hideOverlay` | `boolean` | No |
|
|
489
|
+
| `hideOverlay` | `boolean` | No | `-` | Hide overlay when tour is active |
|
|
490
490
|
| `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 |
|
|
491
491
|
| `tourMaskBorderRadius` | `string \| number` | No | `-` | Corner radius for the TourMasks content mask. Uses SVG rect elements rx and ry attributes https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/rx. |
|
|
492
492
|
| `tourMaskPadding` | `string \| number` | No | `-` | Padding to add around the edges of the TourMasks content mask. |
|
|
493
493
|
| `tourStepAutoPlacement` | `Partial<Partial<{ boundary: any; rootBoundary: RootBoundary; elementContext: ElementContext; altBoundary: boolean; padding: Padding; }> & { crossAxis: boolean; alignment: Alignment \| null; autoAlignment: boolean; allowedPlacements: Placement[]; }>` | No | `24` | Configures @floating-ui autoPlacement options for Tour Step component. See https://floating-ui.com/docs/autoplacement. |
|
|
494
|
-
| `tourStepOffset` | `number \| Partial<{ mainAxis: number; crossAxis: number; alignmentAxis: number \| null; }> \| Derivable<OffsetValue>` | No |
|
|
494
|
+
| `tourStepOffset` | `number \| Partial<{ mainAxis: number; crossAxis: number; alignmentAxis: number \| null; }> \| Derivable<OffsetValue>` | No | `-` | Configures @floating-ui offset options for Tour Step component. See https://floating-ui.com/docs/offset. |
|
|
495
495
|
| `tourStepShift` | `Partial<Partial<{ boundary: any; rootBoundary: RootBoundary; elementContext: ElementContext; altBoundary: boolean; padding: Padding; }> & { mainAxis: boolean; crossAxis: boolean; limiter: { fn: (state: MiddlewareState) => Coords; options?: any; }; }>` | No | `-` | Configures @floating-ui shift options for Tour Step component. See https://floating-ui.com/docs/shift. |
|
|
496
496
|
|
|
497
497
|
|
|
@@ -284,3 +284,99 @@ This adds `myCustomColor` to `ThemeVars.Color` - which enforces that this variab
|
|
|
284
284
|
|
|
285
285
|
Now that `myCustomColor` is defined in your theme the `useTheme` hook will include it in the return value.
|
|
286
286
|
|
|
287
|
+
### ComponentConfigProvider component
|
|
288
|
+
|
|
289
|
+
`ComponentConfigProvider` lets you set component-level default BaseProps for all matching component instances in its subtree. It should be used sparingly and you should avoid frequent updates.
|
|
290
|
+
|
|
291
|
+
This is **not recommended for most use cases**. In most cases, passing props directly to components is clearer and more efficient.
|
|
292
|
+
|
|
293
|
+
Also, it is not recommended to nest `ComponentConfigProvider`. If you nest `ComponentConfigProvider`, it will not inherit the parent provider's config. It will only use its own config.
|
|
294
|
+
|
|
295
|
+
Use `ComponentConfigProvider` when you need to set defaults across many instances of a component (for example, changing the default `borderRadius` of all `Button` components) and you do not want to change theme tokens.
|
|
296
|
+
|
|
297
|
+
```tsx
|
|
298
|
+
import { Button } from '@coinbase/cds-mobile/buttons/Button';
|
|
299
|
+
import { ComponentConfigProvider } from '@coinbase/cds-mobile/system/ComponentConfigProvider';
|
|
300
|
+
|
|
301
|
+
const App = () => (
|
|
302
|
+
<ComponentConfigProvider value={{ Button: { borderRadius: 200 } }}>
|
|
303
|
+
<Button>Primary action</Button>
|
|
304
|
+
<Button variant="secondary">Secondary action</Button>
|
|
305
|
+
</ComponentConfigProvider>
|
|
306
|
+
);
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
Property values being set for an individual component instance will override the default values set on the provider.
|
|
310
|
+
|
|
311
|
+
```tsx
|
|
312
|
+
<VStack gap={4}>
|
|
313
|
+
<ComponentConfigProvider value={{ Button: { borderRadius: 200 } }}>
|
|
314
|
+
<VStack gap={2}>
|
|
315
|
+
<Text font="label1">ComponentConfigProvider with custom default borderRadius</Text>
|
|
316
|
+
<HStack gap={2}>
|
|
317
|
+
<Button>Default button</Button>
|
|
318
|
+
<Button variant="secondary" borderRadius={0}>
|
|
319
|
+
Square button
|
|
320
|
+
</Button>
|
|
321
|
+
</HStack>
|
|
322
|
+
</VStack>
|
|
323
|
+
</ComponentConfigProvider>
|
|
324
|
+
<VStack gap={2}>
|
|
325
|
+
<Text font="label1">Default Button</Text>
|
|
326
|
+
<HStack gap={2}>
|
|
327
|
+
<Button>Default button</Button>
|
|
328
|
+
<Button variant="secondary" borderRadius={0}>
|
|
329
|
+
Square button
|
|
330
|
+
</Button>
|
|
331
|
+
</HStack>
|
|
332
|
+
</VStack>
|
|
333
|
+
</VStack>
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
#### Function-based defaults
|
|
337
|
+
|
|
338
|
+
`ComponentConfigProvider` can also accept a function to compute defaults from incoming component props.
|
|
339
|
+
|
|
340
|
+
When using function-based defaults, keep both the resolver and provider `value` stable with `useCallback` and `useMemo` to reduce avoidable work during rerenders.
|
|
341
|
+
|
|
342
|
+
```tsx
|
|
343
|
+
import { useCallback, useMemo } from 'react';
|
|
344
|
+
import type { ComponentConfig } from '@coinbase/cds-mobile/core/componentConfig';
|
|
345
|
+
import { Button } from '@coinbase/cds-mobile/buttons/Button';
|
|
346
|
+
import { ComponentConfigProvider } from '@coinbase/cds-mobile/system/ComponentConfigProvider';
|
|
347
|
+
|
|
348
|
+
const compactButtonDefaults = {
|
|
349
|
+
borderRadius: 200,
|
|
350
|
+
height: 24,
|
|
351
|
+
font: 'label1',
|
|
352
|
+
} as const;
|
|
353
|
+
|
|
354
|
+
const regularButtonDefaults = {
|
|
355
|
+
borderRadius: 200,
|
|
356
|
+
height: 32,
|
|
357
|
+
font: 'headline',
|
|
358
|
+
} as const;
|
|
359
|
+
|
|
360
|
+
const App = () => {
|
|
361
|
+
const buttonConfig = useCallback(
|
|
362
|
+
(props: { compact?: boolean }) =>
|
|
363
|
+
props.compact ? compactButtonDefaults : regularButtonDefaults,
|
|
364
|
+
[],
|
|
365
|
+
);
|
|
366
|
+
|
|
367
|
+
const componentConfig = useMemo<ComponentConfig>(
|
|
368
|
+
() => ({
|
|
369
|
+
Button: buttonConfig,
|
|
370
|
+
}),
|
|
371
|
+
[buttonConfig],
|
|
372
|
+
);
|
|
373
|
+
|
|
374
|
+
return (
|
|
375
|
+
<ComponentConfigProvider value={componentConfig}>
|
|
376
|
+
<Button>Default</Button>
|
|
377
|
+
<Button compact>Compact</Button>
|
|
378
|
+
</ComponentConfigProvider>
|
|
379
|
+
);
|
|
380
|
+
};
|
|
381
|
+
```
|
|
382
|
+
|
|
@@ -420,6 +420,7 @@ function CustomRadioButtonExample() {
|
|
|
420
420
|
| `position` | `ResponsiveProp<fixed \| static \| relative \| absolute \| sticky>` | No | `-` | - |
|
|
421
421
|
| `ref` | `RefObject<HTMLDivElement> \| ((instance: HTMLDivElement \| null) => void) \| null` | No | `-` | - |
|
|
422
422
|
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
|
|
423
|
+
| `role` | `group \| radiogroup` | No | `-` | The role for the group. Use radiogroup for radio buttons, group for other controls. |
|
|
423
424
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
424
425
|
| `style` | `CSSProperties` | No | `-` | - |
|
|
425
426
|
| `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 |
|
|
@@ -785,7 +785,7 @@ function Example() {
|
|
|
785
785
|
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
|
|
786
786
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
787
787
|
| `seedDate` | `Date` | No | `-` | Date used to generate the Calendar month when there is no value for the selectedDate prop, defaults to today. |
|
|
788
|
-
| `showOverlay` | `boolean` | No |
|
|
788
|
+
| `showOverlay` | `boolean` | No | `-` | Display an overlay over all content below the Popover menu |
|
|
789
789
|
| `start` | `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 |
|
|
790
790
|
| `styles` | `{ dateInput?: CSSProperties; calendar?: CSSProperties \| undefined; calendarHeader?: CSSProperties \| undefined; calendarTitle?: CSSProperties \| undefined; calendarNavigation?: CSSProperties \| undefined; calendarContent?: CSSProperties \| undefined; calendarDay?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the DateInput and Calendar subcomponents. |
|
|
791
791
|
| `suffix` | `string` | No | `-` | Adds suffix text to the end of input |
|
|
@@ -92,7 +92,7 @@ You can control the visibility of a Dropdown menu programmatically using the exp
|
|
|
92
92
|
| --- | --- | --- | --- | --- |
|
|
93
93
|
| `children` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | Yes | `-` | Subject of the Popover that when interacted with will toggle the visibility of the content |
|
|
94
94
|
| `content` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | Yes | `-` | - |
|
|
95
|
-
| `block` | `boolean` | No |
|
|
95
|
+
| `block` | `boolean` | No | `-` | Makes the Popover Subject fill the width of the parent container |
|
|
96
96
|
| `contentPosition` | `PopoverContentPositionConfig` | No | `-` | Override content positioning defaults |
|
|
97
97
|
| `controlledElementAccessibilityProps` | `{ id: string; accessibilityLabel?: string; } \| undefined` | No | `-` | - |
|
|
98
98
|
| `disableCloseOnOptionChange` | `boolean` | No | `-` | Prevent menu from closing when an option is selected |
|
|
@@ -109,9 +109,9 @@ You can control the visibility of a Dropdown menu programmatically using the exp
|
|
|
109
109
|
| `onCloseMenu` | `(() => void)` | No | `-` | Callback that fires when Dropdown is closed |
|
|
110
110
|
| `onOpenMenu` | `(() => void)` | No | `-` | Callback that fires when Dropdown is opened |
|
|
111
111
|
| `ref` | `((instance: DropdownRef \| null) => void) \| RefObject<DropdownRef> \| null` | No | `-` | - |
|
|
112
|
-
| `respectNegativeTabIndex` | `boolean` | No |
|
|
112
|
+
| `respectNegativeTabIndex` | `boolean` | No | `-` | If true, the focus trap will respect negative tabIndex values, removing them from the list of focusable elements. |
|
|
113
113
|
| `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 |
|
|
114
|
-
| `showOverlay` | `boolean` | No |
|
|
114
|
+
| `showOverlay` | `boolean` | No | `-` | Display an overlay over all content below the Popover menu |
|
|
115
115
|
| `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 |
|
|
116
116
|
| `value` | `string` | No | `-` | Default selected value, or preselected value |
|
|
117
117
|
| `width` | `Width<string \| number>` | No | `100%` | Width of input as a percentage string or number converted to pixels. |
|
|
@@ -139,15 +139,15 @@ function Example() {
|
|
|
139
139
|
|
|
140
140
|
| Prop | Type | Required | Default | Description |
|
|
141
141
|
| --- | --- | --- | --- | --- |
|
|
142
|
-
| `autoFocusDelay` | `number` | No |
|
|
143
|
-
| `disableArrowKeyNavigation` | `boolean` | No |
|
|
144
|
-
| `disableAutoFocus` | `boolean` | No |
|
|
142
|
+
| `autoFocusDelay` | `number` | No | `-` | The amount of time in milliseconds to wait before auto-focusing the first focusable element. |
|
|
143
|
+
| `disableArrowKeyNavigation` | `boolean` | No | `-` | If true, the focus trap will not allow arrow key navigation. |
|
|
144
|
+
| `disableAutoFocus` | `boolean` | No | `-` | If true, the focus trap will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. |
|
|
145
145
|
| `disableFocusTrap` | `boolean` | No | `-` | Disables the focus trap to allow normal keyboard navigation. |
|
|
146
146
|
| `disableTypeFocus` | `boolean` | No | `-` | Use for editable Search Input components to ensure focus is correctly applied |
|
|
147
|
-
| `focusTabIndexElements` | `boolean` | No |
|
|
148
|
-
| `includeTriggerInFocusTrap` | `boolean` | No |
|
|
147
|
+
| `focusTabIndexElements` | `boolean` | No | `-` | If true, the focus trap will include all elements with tabIndex values in the list of focusable elements. |
|
|
148
|
+
| `includeTriggerInFocusTrap` | `boolean` | No | `-` | If true, the focus trap will include the trigger in the focus trap. |
|
|
149
149
|
| `onEscPress` | `(() => void)` | No | `-` | - |
|
|
150
|
-
| `respectNegativeTabIndex` | `boolean` | No |
|
|
151
|
-
| `restoreFocusOnUnmount` | `boolean` | No |
|
|
150
|
+
| `respectNegativeTabIndex` | `boolean` | No | `-` | If true, the focus trap will respect negative tabIndex values, removing them from the list of focusable elements. |
|
|
151
|
+
| `restoreFocusOnUnmount` | `boolean` | No | `-` | If true, the focus trap will restore focus to the previously focused element when it unmounts. |
|
|
152
152
|
|
|
153
153
|
|
|
@@ -149,8 +149,8 @@ For more complex layouts, including three-column structures with custom headers
|
|
|
149
149
|
| `contentStyle` | `CSSProperties` | No | `-` | Apply styles to content. |
|
|
150
150
|
| `disableFocusTrap` | `boolean` | No | `-` | Disables the focus trap to allow normal keyboard navigation. |
|
|
151
151
|
| `disablePortal` | `boolean` | No | `-` | Disable React portal integration |
|
|
152
|
-
| `focusTabIndexElements` | `boolean` | No |
|
|
153
|
-
| `hideDivider` | `boolean` | No |
|
|
152
|
+
| `focusTabIndexElements` | `boolean` | No | `-` | If true, the focus trap will include all elements with tabIndex values in the list of focusable elements. |
|
|
153
|
+
| `hideDivider` | `boolean` | No | `-` | Hide header bottom divider |
|
|
154
154
|
| `logo` | `ReactElement` | No | `-` | The logo to display |
|
|
155
155
|
| `onDidClose` | `((() => void) & (() => void))` | No | `-` | Callback fired after the component is closed. |
|
|
156
156
|
| `primaryContentClassName` | `string` | No | `-` | Class applied to the primary content element |
|
|
@@ -159,7 +159,7 @@ For more complex layouts, including three-column structures with custom headers
|
|
|
159
159
|
| `secondaryContent` | `ReactElement` | No | `-` | Secondary content element. Secondary content is supplemental information. |
|
|
160
160
|
| `secondaryContentClassName` | `string` | No | `-` | Class applied to the secondary content element |
|
|
161
161
|
| `shouldCloseOnEscPress` | `boolean` | No | `true` | If pressing the esc key should close the modal |
|
|
162
|
-
| `showSecondaryContentDivider` | `boolean` | No |
|
|
162
|
+
| `showSecondaryContentDivider` | `boolean` | No | `-` | Show divider between primary and secondary content |
|
|
163
163
|
| `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 |
|
|
164
164
|
| `title` | `string` | No | `-` | Title displayed in the Fullscreen Modal header. |
|
|
165
165
|
|
|
@@ -373,7 +373,7 @@ function ThreeColumnExample() {
|
|
|
373
373
|
| `accessibilityLabelledBy` | `string` | No | `-` | On web, maps to aria-labelledby and lists the id(s) of the element(s) that label the element on which the attribute is set. On mobile (Android only), a reference to another element nativeID used to build complex forms. |
|
|
374
374
|
| `disableFocusTrap` | `boolean` | No | `-` | Disables the focus trap to allow normal keyboard navigation. |
|
|
375
375
|
| `disablePortal` | `boolean` | No | `-` | Disable React portal integration |
|
|
376
|
-
| `focusTabIndexElements` | `boolean` | No |
|
|
376
|
+
| `focusTabIndexElements` | `boolean` | No | `-` | If true, the focus trap will include all elements with tabIndex values in the list of focusable elements. |
|
|
377
377
|
| `key` | `Key \| null` | No | `-` | - |
|
|
378
378
|
| `onDidClose` | `((() => void) & (() => void))` | No | `-` | Callback fired after the component is closed. |
|
|
379
379
|
| `ref` | `RefObject<HTMLDivElement> \| ((instance: HTMLDivElement \| null) => void) \| null` | No | `-` | - |
|
|
@@ -263,7 +263,7 @@ function Example() {
|
|
|
263
263
|
| `dangerouslyDisableResponsiveness` | `boolean` | No | `false` | Disable responsiveness so it maintains the same UI across different viewports. |
|
|
264
264
|
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
265
265
|
| `dangerouslySetPosition` | `static \| relative \| fixed \| absolute \| sticky` | No | `-` | Set the position for the modal dialogue |
|
|
266
|
-
| `disableArrowKeyNavigation` | `boolean` | No |
|
|
266
|
+
| `disableArrowKeyNavigation` | `boolean` | No | `-` | If true, the focus trap will not allow arrow key navigation. |
|
|
267
267
|
| `disableFocusTrap` | `boolean` | No | `-` | Disables the focus trap to allow normal keyboard navigation. |
|
|
268
268
|
| `disableOverlayPress` | `boolean` | No | `false` | Disable overlay click that closes the Modal |
|
|
269
269
|
| `disablePortal` | `boolean` | No | `-` | Disable React portal integration |
|
|
@@ -274,7 +274,7 @@ function Example() {
|
|
|
274
274
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
275
275
|
| `flexShrink` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
276
276
|
| `flexWrap` | `ResponsiveProp<nowrap \| wrap \| wrap-reverse>` | No | `-` | - |
|
|
277
|
-
| `focusTabIndexElements` | `boolean` | No |
|
|
277
|
+
| `focusTabIndexElements` | `boolean` | No | `-` | If true, the focus trap will include all elements with tabIndex values in the list of focusable elements. |
|
|
278
278
|
| `font` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
279
279
|
| `fontFamily` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
280
280
|
| `fontSize` | `ResponsiveProp<FontSize \| inherit>` | No | `-` | - |
|
|
@@ -145,8 +145,8 @@ function AccessibilityExample() {
|
|
|
145
145
|
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
146
146
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
147
147
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
148
|
-
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No |
|
|
149
|
-
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No |
|
|
148
|
+
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
149
|
+
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
150
150
|
| `flexShrink` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
151
151
|
| `flexWrap` | `ResponsiveProp<nowrap \| wrap \| wrap-reverse>` | No | `-` | - |
|
|
152
152
|
| `font` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
@@ -187,17 +187,17 @@ function AccessibilityExample() {
|
|
|
187
187
|
| `minWidth` | `ResponsiveProp<MinWidth<string \| number>>` | No | `-` | - |
|
|
188
188
|
| `onChange` | `FormEventHandler<HTMLDivElement>` | No | `-` | - |
|
|
189
189
|
| `opacity` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
190
|
-
| `overflow` | `ResponsiveProp<hidden \| auto \| visible \| clip \| scroll>` | No |
|
|
190
|
+
| `overflow` | `ResponsiveProp<hidden \| auto \| visible \| clip \| scroll>` | No | `-` | - |
|
|
191
191
|
| `padding` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
192
192
|
| `paddingBottom` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
193
193
|
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
194
194
|
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
195
195
|
| `paddingTop` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
196
|
-
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No |
|
|
196
|
+
| `paddingX` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
197
197
|
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
198
198
|
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
199
199
|
| `position` | `ResponsiveProp<fixed \| static \| relative \| absolute \| sticky>` | No | `-` | - |
|
|
200
|
-
| `ref` | `
|
|
200
|
+
| `ref` | `RefObject<HTMLDivElement> \| ((instance: HTMLDivElement \| null) => void) \| null` | No | `-` | - |
|
|
201
201
|
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
|
|
202
202
|
| `rowGap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
203
203
|
| `style` | `CSSProperties` | No | `-` | - |
|