@coinbase/cds-mcp-server 8.43.0 → 8.43.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/dts/analytics.d.ts +6 -9
- package/dts/index.d.ts +1 -1
- package/dts/server.d.ts +1 -1
- package/dts/setup.d.ts +1 -1
- package/mcp-docs/mobile/components/Carousel.txt +12 -0
- package/mcp-docs/mobile/components/CheckboxCell.txt +11 -0
- package/mcp-docs/mobile/components/Chip.txt +8 -0
- package/mcp-docs/mobile/components/Combobox.txt +26 -0
- package/mcp-docs/mobile/components/ContentCell.txt +17 -0
- package/mcp-docs/mobile/components/DataCard.txt +11 -0
- package/mcp-docs/mobile/components/DotCount.txt +9 -0
- package/mcp-docs/mobile/components/Icon.txt +8 -0
- package/mcp-docs/mobile/components/ListCell.txt +23 -0
- package/mcp-docs/mobile/components/MediaCard.txt +12 -0
- package/mcp-docs/mobile/components/MessagingCard.txt +12 -0
- package/mcp-docs/mobile/components/PageHeader.txt +10 -0
- package/mcp-docs/mobile/components/ProgressBar.txt +8 -0
- package/mcp-docs/mobile/components/ProgressBarWithFixedLabels.txt +10 -0
- package/mcp-docs/mobile/components/ProgressBarWithFloatLabel.txt +9 -0
- package/mcp-docs/mobile/components/ProgressCircle.txt +12 -0
- package/mcp-docs/mobile/components/RadioCell.txt +11 -0
- package/mcp-docs/mobile/components/RollingNumber.txt +16 -0
- package/mcp-docs/mobile/components/SelectAlpha.txt +26 -0
- package/mcp-docs/mobile/components/SelectChipAlpha.txt +26 -0
- package/mcp-docs/mobile/components/SlideButton.txt +9 -0
- package/mcp-docs/mobile/components/Stepper.txt +13 -0
- package/mcp-docs/mobile/components/TabbedChipsAlpha.txt +8 -0
- package/mcp-docs/mobile/getting-started/styling.txt +6 -2
- package/mcp-docs/web/components/AvatarButton.txt +5 -5
- package/mcp-docs/web/components/Box.txt +5 -5
- package/mcp-docs/web/components/Button.txt +5 -5
- package/mcp-docs/web/components/Carousel.txt +12 -0
- package/mcp-docs/web/components/CheckboxCell.txt +11 -0
- package/mcp-docs/web/components/Chip.txt +8 -0
- package/mcp-docs/web/components/Combobox.txt +26 -0
- package/mcp-docs/web/components/ContentCard.txt +5 -5
- package/mcp-docs/web/components/ContentCardBody.txt +5 -5
- package/mcp-docs/web/components/ContentCardFooter.txt +5 -5
- package/mcp-docs/web/components/ContentCardHeader.txt +5 -5
- package/mcp-docs/web/components/ContentCell.txt +23 -5
- package/mcp-docs/web/components/DataCard.txt +11 -0
- package/mcp-docs/web/components/DotCount.txt +9 -0
- package/mcp-docs/web/components/Fallback.txt +5 -5
- package/mcp-docs/web/components/Grid.txt +5 -5
- package/mcp-docs/web/components/GridColumn.txt +5 -5
- package/mcp-docs/web/components/HStack.txt +5 -5
- package/mcp-docs/web/components/Icon.txt +8 -0
- package/mcp-docs/web/components/IconButton.txt +5 -5
- package/mcp-docs/web/components/Interactable.txt +5 -5
- package/mcp-docs/web/components/Link.txt +5 -5
- package/mcp-docs/web/components/ListCell.txt +25 -5
- package/mcp-docs/web/components/MediaCard.txt +12 -0
- package/mcp-docs/web/components/MessagingCard.txt +12 -0
- package/mcp-docs/web/components/MultiContentModule.txt +5 -5
- package/mcp-docs/web/components/NavigationBar.txt +271 -45
- package/mcp-docs/web/components/PageHeader.txt +10 -0
- package/mcp-docs/web/components/Pressable.txt +5 -5
- package/mcp-docs/web/components/ProgressBar.txt +8 -0
- package/mcp-docs/web/components/ProgressBarWithFixedLabels.txt +10 -0
- package/mcp-docs/web/components/ProgressBarWithFloatLabel.txt +9 -0
- package/mcp-docs/web/components/ProgressCircle.txt +10 -0
- package/mcp-docs/web/components/RadioCell.txt +11 -0
- package/mcp-docs/web/components/RollingNumber.txt +21 -5
- package/mcp-docs/web/components/Scrubber.txt +10 -0
- package/mcp-docs/web/components/SelectAlpha.txt +26 -0
- package/mcp-docs/web/components/SelectChipAlpha.txt +26 -0
- package/mcp-docs/web/components/Sidebar.txt +10 -0
- package/mcp-docs/web/components/Spacer.txt +5 -5
- package/mcp-docs/web/components/Stepper.txt +13 -0
- package/mcp-docs/web/components/TabbedChipsAlpha.txt +10 -0
- package/mcp-docs/web/components/Text.txt +5 -5
- package/mcp-docs/web/components/TileButton.txt +5 -5
- package/mcp-docs/web/components/VStack.txt +5 -5
- package/mcp-docs/web/getting-started/styling.txt +35 -12
- package/package.json +1 -1
|
@@ -103,17 +103,17 @@ Since this component is low-level, it doesn't require much accessibility out of
|
|
|
103
103
|
| `aria-colindextext` | `string \| undefined` | No | `-` | Defines a human readable text alternative of aria-colindex. |
|
|
104
104
|
| `aria-colspan` | `number \| undefined` | No | `-` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
|
|
105
105
|
| `aria-controls` | `string \| undefined` | No | `-` | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
|
|
106
|
-
| `aria-current` | `boolean \| true \| false \| page \| step \| location \| date \|
|
|
106
|
+
| `aria-current` | `boolean \| time \| true \| false \| page \| step \| location \| date \| undefined` | No | `-` | Indicates the element that represents the current item within a container or set of related elements. |
|
|
107
107
|
| `aria-describedby` | `string \| undefined` | No | `-` | Identifies the element (or elements) that describes the object. |
|
|
108
108
|
| `aria-description` | `string \| undefined` | No | `-` | Defines a string value that describes or annotates the current element. |
|
|
109
109
|
| `aria-details` | `string \| undefined` | No | `-` | Identifies the element that provides a detailed, extended description for the object. |
|
|
110
110
|
| `aria-disabled` | `Booleanish \| undefined` | No | `-` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
|
|
111
|
-
| `aria-dropeffect` | `
|
|
111
|
+
| `aria-dropeffect` | `link \| none \| copy \| execute \| move \| popup \| undefined` | No | `-` | Indicates what functions can be performed when a dragged object is released on the drop target. |
|
|
112
112
|
| `aria-errormessage` | `string \| undefined` | No | `-` | Identifies the element that provides an error message for the object. |
|
|
113
113
|
| `aria-expanded` | `Booleanish \| undefined` | No | `-` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
|
|
114
114
|
| `aria-flowto` | `string \| undefined` | No | `-` | Identifies the next element (or elements) in an alternate reading order of content which, at the users discretion, allows assistive technology to override the general default of reading in document source order. |
|
|
115
115
|
| `aria-grabbed` | `Booleanish \| undefined` | No | `-` | Indicates an elements grabbed state in a drag-and-drop operation. |
|
|
116
|
-
| `aria-haspopup` | `boolean \|
|
|
116
|
+
| `aria-haspopup` | `boolean \| grid \| dialog \| menu \| true \| false \| listbox \| tree \| undefined` | No | `-` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. |
|
|
117
117
|
| `aria-hidden` | `Booleanish \| undefined` | No | `-` | Indicates whether the element is exposed to an accessibility API. |
|
|
118
118
|
| `aria-invalid` | `boolean \| true \| false \| grammar \| spelling \| undefined` | No | `-` | Indicates the entered value does not conform to the format expected by the application. |
|
|
119
119
|
| `aria-keyshortcuts` | `string \| undefined` | No | `-` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
|
|
@@ -189,7 +189,7 @@ Since this component is low-level, it doesn't require much accessibility out of
|
|
|
189
189
|
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
190
190
|
| `draggable` | `Booleanish \| undefined` | No | `-` | - |
|
|
191
191
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
192
|
-
| `enterKeyHint` | `enter \| done \| go \| next \| previous \|
|
|
192
|
+
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
193
193
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
194
194
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
195
195
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -225,7 +225,7 @@ Since this component is low-level, it doesn't require much accessibility out of
|
|
|
225
225
|
| `hidden` | `boolean \| undefined` | No | `-` | - |
|
|
226
226
|
| `id` | `string \| undefined` | No | `-` | - |
|
|
227
227
|
| `inlist` | `any` | No | `-` | - |
|
|
228
|
-
| `inputMode` | `
|
|
228
|
+
| `inputMode` | `search \| text \| none \| tel \| url \| email \| numeric \| decimal \| undefined` | No | `-` | Hints at the type of data that might be entered by the user while editing the element or its contents |
|
|
229
229
|
| `is` | `string \| undefined` | No | `-` | Specify that a standard HTML element should behave like a defined custom built-in element |
|
|
230
230
|
| `itemID` | `string \| undefined` | No | `-` | - |
|
|
231
231
|
| `itemProp` | `string \| undefined` | No | `-` | - |
|
|
@@ -148,17 +148,17 @@ _The link text must have a 3:1 contrast ratio from the surrounding non-link text
|
|
|
148
148
|
| `aria-colindextext` | `string \| undefined` | No | `-` | Defines a human readable text alternative of aria-colindex. |
|
|
149
149
|
| `aria-colspan` | `number \| undefined` | No | `-` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
|
|
150
150
|
| `aria-controls` | `string \| undefined` | No | `-` | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
|
|
151
|
-
| `aria-current` | `boolean \| true \| false \| page \| step \| location \| date \|
|
|
151
|
+
| `aria-current` | `boolean \| time \| true \| false \| page \| step \| location \| date \| undefined` | No | `-` | Indicates the element that represents the current item within a container or set of related elements. |
|
|
152
152
|
| `aria-describedby` | `string \| undefined` | No | `-` | Identifies the element (or elements) that describes the object. |
|
|
153
153
|
| `aria-description` | `string \| undefined` | No | `-` | Defines a string value that describes or annotates the current element. |
|
|
154
154
|
| `aria-details` | `string \| undefined` | No | `-` | Identifies the element that provides a detailed, extended description for the object. |
|
|
155
155
|
| `aria-disabled` | `Booleanish \| undefined` | No | `-` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
|
|
156
|
-
| `aria-dropeffect` | `
|
|
156
|
+
| `aria-dropeffect` | `link \| none \| copy \| execute \| move \| popup \| undefined` | No | `-` | Indicates what functions can be performed when a dragged object is released on the drop target. |
|
|
157
157
|
| `aria-errormessage` | `string \| undefined` | No | `-` | Identifies the element that provides an error message for the object. |
|
|
158
158
|
| `aria-expanded` | `Booleanish \| undefined` | No | `-` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
|
|
159
159
|
| `aria-flowto` | `string \| undefined` | No | `-` | Identifies the next element (or elements) in an alternate reading order of content which, at the users discretion, allows assistive technology to override the general default of reading in document source order. |
|
|
160
160
|
| `aria-grabbed` | `Booleanish \| undefined` | No | `-` | Indicates an elements grabbed state in a drag-and-drop operation. |
|
|
161
|
-
| `aria-haspopup` | `boolean \|
|
|
161
|
+
| `aria-haspopup` | `boolean \| grid \| dialog \| menu \| true \| false \| listbox \| tree \| undefined` | No | `-` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. |
|
|
162
162
|
| `aria-hidden` | `Booleanish \| undefined` | No | `-` | Indicates whether the element is exposed to an accessibility API. |
|
|
163
163
|
| `aria-invalid` | `boolean \| true \| false \| grammar \| spelling \| undefined` | No | `-` | Indicates the entered value does not conform to the format expected by the application. |
|
|
164
164
|
| `aria-keyshortcuts` | `string \| undefined` | No | `-` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
|
|
@@ -235,7 +235,7 @@ _The link text must have a 3:1 contrast ratio from the surrounding non-link text
|
|
|
235
235
|
| `download` | `any` | No | `-` | - |
|
|
236
236
|
| `draggable` | `Booleanish \| undefined` | No | `-` | - |
|
|
237
237
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
238
|
-
| `enterKeyHint` | `enter \| done \| go \| next \| previous \|
|
|
238
|
+
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
239
239
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
240
240
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
241
241
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -268,7 +268,7 @@ _The link text must have a 3:1 contrast ratio from the surrounding non-link text
|
|
|
268
268
|
| `hrefLang` | `string \| undefined` | No | `-` | - |
|
|
269
269
|
| `id` | `string \| undefined` | No | `-` | - |
|
|
270
270
|
| `inlist` | `any` | No | `-` | - |
|
|
271
|
-
| `inputMode` | `
|
|
271
|
+
| `inputMode` | `search \| text \| none \| tel \| url \| email \| numeric \| decimal \| undefined` | No | `-` | Hints at the type of data that might be entered by the user while editing the element or its contents |
|
|
272
272
|
| `is` | `string \| undefined` | No | `-` | Specify that a standard HTML element should behave like a defined custom built-in element |
|
|
273
273
|
| `itemID` | `string \| undefined` | No | `-` | - |
|
|
274
274
|
| `itemProp` | `string \| undefined` | No | `-` | - |
|
|
@@ -667,17 +667,17 @@ Mapping to `styles` / `classNames` keys:
|
|
|
667
667
|
| `aria-colindextext` | `string \| undefined` | No | `-` | Defines a human readable text alternative of aria-colindex. |
|
|
668
668
|
| `aria-colspan` | `number \| undefined` | No | `-` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
|
|
669
669
|
| `aria-controls` | `string \| undefined` | No | `-` | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
|
|
670
|
-
| `aria-current` | `boolean \| true \| false \| page \| step \| location \| date \|
|
|
670
|
+
| `aria-current` | `boolean \| time \| true \| false \| page \| step \| location \| date \| undefined` | No | `-` | Indicates the element that represents the current item within a container or set of related elements. |
|
|
671
671
|
| `aria-describedby` | `string \| undefined` | No | `-` | Identifies the element (or elements) that describes the object. |
|
|
672
672
|
| `aria-description` | `string \| undefined` | No | `-` | Defines a string value that describes or annotates the current element. |
|
|
673
673
|
| `aria-details` | `string \| undefined` | No | `-` | Identifies the element that provides a detailed, extended description for the object. |
|
|
674
674
|
| `aria-disabled` | `Booleanish \| undefined` | No | `-` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
|
|
675
|
-
| `aria-dropeffect` | `
|
|
675
|
+
| `aria-dropeffect` | `link \| none \| copy \| execute \| move \| popup \| undefined` | No | `-` | Indicates what functions can be performed when a dragged object is released on the drop target. |
|
|
676
676
|
| `aria-errormessage` | `string \| undefined` | No | `-` | Identifies the element that provides an error message for the object. |
|
|
677
677
|
| `aria-expanded` | `Booleanish \| undefined` | No | `-` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
|
|
678
678
|
| `aria-flowto` | `string \| undefined` | No | `-` | Identifies the next element (or elements) in an alternate reading order of content which, at the users discretion, allows assistive technology to override the general default of reading in document source order. |
|
|
679
679
|
| `aria-grabbed` | `Booleanish \| undefined` | No | `-` | Indicates an elements grabbed state in a drag-and-drop operation. |
|
|
680
|
-
| `aria-haspopup` | `boolean \|
|
|
680
|
+
| `aria-haspopup` | `boolean \| grid \| dialog \| menu \| true \| false \| listbox \| tree \| undefined` | No | `-` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. |
|
|
681
681
|
| `aria-hidden` | `Booleanish \| undefined` | No | `-` | Indicates whether the element is exposed to an accessibility API. |
|
|
682
682
|
| `aria-invalid` | `boolean \| true \| false \| grammar \| spelling \| undefined` | No | `-` | Indicates the entered value does not conform to the format expected by the application. |
|
|
683
683
|
| `aria-keyshortcuts` | `string \| undefined` | No | `-` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
|
|
@@ -763,7 +763,7 @@ Mapping to `styles` / `classNames` keys:
|
|
|
763
763
|
| `draggable` | `Booleanish \| undefined` | No | `-` | - |
|
|
764
764
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
765
765
|
| `end` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | End-aligned content (e.g., CTA, form element, metric). Replacement for the deprecated action prop, and takes precedence over it. If the content is an action (like button, link, etc), we recommend avoiding use alongside onClick. If used alongside onClick, the end action is triggered first and then the onClick handler. |
|
|
766
|
-
| `enterKeyHint` | `enter \| done \| go \| next \| previous \|
|
|
766
|
+
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
767
767
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
768
768
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
769
769
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -795,7 +795,7 @@ Mapping to `styles` / `classNames` keys:
|
|
|
795
795
|
| `id` | `string \| undefined` | No | `-` | - |
|
|
796
796
|
| `inlist` | `any` | No | `-` | - |
|
|
797
797
|
| `innerSpacing` | `CellSpacing` | No | `-` | The spacing to use on the inner content of Cell |
|
|
798
|
-
| `inputMode` | `
|
|
798
|
+
| `inputMode` | `search \| text \| none \| tel \| url \| email \| numeric \| decimal \| undefined` | No | `-` | Hints at the type of data that might be entered by the user while editing the element or its contents |
|
|
799
799
|
| `intermediary` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | For internal use only. |
|
|
800
800
|
| `is` | `string \| undefined` | No | `-` | Specify that a standard HTML element should behave like a defined custom built-in element |
|
|
801
801
|
| `itemID` | `string \| undefined` | No | `-` | - |
|
|
@@ -1042,3 +1042,23 @@ Mapping to `styles` / `classNames` keys:
|
|
|
1042
1042
|
| `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
1043
1043
|
|
|
1044
1044
|
|
|
1045
|
+
## Styles
|
|
1046
|
+
|
|
1047
|
+
| Selector | Static class name | Description |
|
|
1048
|
+
| --- | --- | --- |
|
|
1049
|
+
| `root` | `-` | - |
|
|
1050
|
+
| `media` | `-` | - |
|
|
1051
|
+
| `intermediary` | `-` | - |
|
|
1052
|
+
| `end` | `-` | - |
|
|
1053
|
+
| `accessory` | `-` | - |
|
|
1054
|
+
| `contentContainer` | `-` | - |
|
|
1055
|
+
| `pressable` | `-` | - |
|
|
1056
|
+
| `titleStack` | `-` | Applied to the VStack of title/subtitle/description. |
|
|
1057
|
+
| `titleStackContainer` | `-` | Applied to the Box that Wrapped around titleStack (controls flex behavior). |
|
|
1058
|
+
| `mainContent` | `-` | - |
|
|
1059
|
+
| `helperText` | `-` | - |
|
|
1060
|
+
| `title` | `-` | - |
|
|
1061
|
+
| `subtitle` | `-` | - |
|
|
1062
|
+
| `description` | `-` | - |
|
|
1063
|
+
|
|
1064
|
+
|
|
@@ -557,3 +557,15 @@ Replace `FloatingAssetCard` with `MediaCard`. Note that the floating variation (
|
|
|
557
557
|
| `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
558
558
|
|
|
559
559
|
|
|
560
|
+
## Styles
|
|
561
|
+
|
|
562
|
+
| Selector | Static class name | Description |
|
|
563
|
+
| --- | --- | --- |
|
|
564
|
+
| `layoutContainer` | `-` | - |
|
|
565
|
+
| `contentContainer` | `-` | - |
|
|
566
|
+
| `textContainer` | `-` | - |
|
|
567
|
+
| `headerContainer` | `-` | - |
|
|
568
|
+
| `mediaContainer` | `-` | - |
|
|
569
|
+
| `root` | `-` | - |
|
|
570
|
+
|
|
571
|
+
|
|
@@ -1052,3 +1052,15 @@ Replace `UpsellCard` with `MessagingCard` using `type="upsell"`.
|
|
|
1052
1052
|
| `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
1053
1053
|
|
|
1054
1054
|
|
|
1055
|
+
## Styles
|
|
1056
|
+
|
|
1057
|
+
| Selector | Static class name | Description |
|
|
1058
|
+
| --- | --- | --- |
|
|
1059
|
+
| `layoutContainer` | `-` | - |
|
|
1060
|
+
| `contentContainer` | `-` | - |
|
|
1061
|
+
| `textContainer` | `-` | - |
|
|
1062
|
+
| `mediaContainer` | `-` | - |
|
|
1063
|
+
| `dismissButtonContainer` | `-` | - |
|
|
1064
|
+
| `root` | `-` | - |
|
|
1065
|
+
|
|
1066
|
+
|
|
@@ -294,17 +294,17 @@ function Example() {
|
|
|
294
294
|
| `aria-colindextext` | `string \| undefined` | No | `-` | Defines a human readable text alternative of aria-colindex. |
|
|
295
295
|
| `aria-colspan` | `number \| undefined` | No | `-` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
|
|
296
296
|
| `aria-controls` | `string \| undefined` | No | `-` | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
|
|
297
|
-
| `aria-current` | `boolean \| true \| false \| page \| step \| location \| date \|
|
|
297
|
+
| `aria-current` | `boolean \| time \| true \| false \| page \| step \| location \| date \| undefined` | No | `-` | Indicates the element that represents the current item within a container or set of related elements. |
|
|
298
298
|
| `aria-describedby` | `string \| undefined` | No | `-` | Identifies the element (or elements) that describes the object. |
|
|
299
299
|
| `aria-description` | `string \| undefined` | No | `-` | Defines a string value that describes or annotates the current element. |
|
|
300
300
|
| `aria-details` | `string \| undefined` | No | `-` | Identifies the element that provides a detailed, extended description for the object. |
|
|
301
301
|
| `aria-disabled` | `Booleanish \| undefined` | No | `-` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
|
|
302
|
-
| `aria-dropeffect` | `
|
|
302
|
+
| `aria-dropeffect` | `link \| none \| copy \| execute \| move \| popup \| undefined` | No | `-` | Indicates what functions can be performed when a dragged object is released on the drop target. |
|
|
303
303
|
| `aria-errormessage` | `string \| undefined` | No | `-` | Identifies the element that provides an error message for the object. |
|
|
304
304
|
| `aria-expanded` | `Booleanish \| undefined` | No | `-` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
|
|
305
305
|
| `aria-flowto` | `string \| undefined` | No | `-` | Identifies the next element (or elements) in an alternate reading order of content which, at the users discretion, allows assistive technology to override the general default of reading in document source order. |
|
|
306
306
|
| `aria-grabbed` | `Booleanish \| undefined` | No | `-` | Indicates an elements grabbed state in a drag-and-drop operation. |
|
|
307
|
-
| `aria-haspopup` | `boolean \|
|
|
307
|
+
| `aria-haspopup` | `boolean \| grid \| dialog \| menu \| true \| false \| listbox \| tree \| undefined` | No | `-` | Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. |
|
|
308
308
|
| `aria-hidden` | `Booleanish \| undefined` | No | `-` | Indicates whether the element is exposed to an accessibility API. |
|
|
309
309
|
| `aria-invalid` | `boolean \| true \| false \| grammar \| spelling \| undefined` | No | `-` | Indicates the entered value does not conform to the format expected by the application. |
|
|
310
310
|
| `aria-keyshortcuts` | `string \| undefined` | No | `-` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
|
|
@@ -379,7 +379,7 @@ function Example() {
|
|
|
379
379
|
| `draggable` | `Booleanish \| undefined` | No | `-` | - |
|
|
380
380
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
381
381
|
| `end` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | ReactNode to display at the end |
|
|
382
|
-
| `enterKeyHint` | `enter \| done \| go \| next \| previous \|
|
|
382
|
+
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
383
383
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
384
384
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
385
385
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -409,7 +409,7 @@ function Example() {
|
|
|
409
409
|
| `hidden` | `boolean \| undefined` | No | `-` | - |
|
|
410
410
|
| `id` | `string \| undefined` | No | `-` | - |
|
|
411
411
|
| `inlist` | `any` | No | `-` | - |
|
|
412
|
-
| `inputMode` | `
|
|
412
|
+
| `inputMode` | `search \| text \| none \| tel \| url \| email \| numeric \| decimal \| undefined` | No | `-` | Hints at the type of data that might be entered by the user while editing the element or its contents |
|
|
413
413
|
| `is` | `string \| undefined` | No | `-` | Specify that a standard HTML element should behave like a defined custom built-in element |
|
|
414
414
|
| `itemID` | `string \| undefined` | No | `-` | - |
|
|
415
415
|
| `itemProp` | `string \| undefined` | No | `-` | - |
|
|
@@ -10,47 +10,116 @@ import { NavigationBar } from '@coinbase/cds-web/navigation/NavigationBar'
|
|
|
10
10
|
|
|
11
11
|
## Examples
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
NavigationBar is a horizontal navigation component that provides a consistent header for application navigation and wayfinding. It supports flexible content areas, theming, and custom styling.
|
|
14
|
+
|
|
15
|
+
### Basics
|
|
16
|
+
|
|
17
|
+
```jsx live
|
|
18
|
+
<NavigationBar
|
|
19
|
+
start={<IconButton name="backArrow" accessibilityLabel="Back" />}
|
|
20
|
+
end={
|
|
21
|
+
<HStack gap={1} alignItems="center">
|
|
22
|
+
<IconButton name="bell" accessibilityLabel="Notifications" />
|
|
23
|
+
<Avatar size="xl" />
|
|
24
|
+
</HStack>
|
|
25
|
+
}
|
|
26
|
+
>
|
|
27
|
+
<NavigationTitle>Dashboard</NavigationTitle>
|
|
28
|
+
</NavigationBar>
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
#### With Tab Navigation
|
|
32
|
+
|
|
33
|
+
Use the `bottom` prop to add tab navigation below the main content.
|
|
34
|
+
|
|
35
|
+
```jsx live
|
|
36
|
+
function NavigationWithTabs() {
|
|
37
|
+
const tabs = [
|
|
38
|
+
{ id: 'all', label: 'All' },
|
|
39
|
+
{ id: 'watchlist', label: 'Watchlist' },
|
|
40
|
+
{ id: 'tradable', label: 'Tradable' },
|
|
41
|
+
{ id: 'gainers', label: 'Gainers' },
|
|
42
|
+
];
|
|
43
|
+
const [value, setValue] = useState(tabs[0].id);
|
|
44
|
+
|
|
45
|
+
return (
|
|
46
|
+
<NavigationBar
|
|
47
|
+
end={
|
|
48
|
+
<HStack gap={1} alignItems="center">
|
|
49
|
+
<IconButton name="bell" accessibilityLabel="Notifications" />
|
|
50
|
+
<Avatar size="xl" />
|
|
51
|
+
</HStack>
|
|
52
|
+
}
|
|
53
|
+
bottom={<TabNavigation tabs={tabs} value={value} onChange={setValue} />}
|
|
54
|
+
>
|
|
55
|
+
<NavigationTitle>Portfolio</NavigationTitle>
|
|
56
|
+
</NavigationBar>
|
|
57
|
+
);
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
#### With Search
|
|
62
|
+
|
|
63
|
+
```jsx live
|
|
64
|
+
function NavigationWithSearch() {
|
|
65
|
+
const [search, setSearch] = useState('');
|
|
66
|
+
|
|
67
|
+
return (
|
|
68
|
+
<NavigationBar
|
|
69
|
+
start={<IconButton name="backArrow" accessibilityLabel="Back" />}
|
|
70
|
+
end={<IconButton name="settings" accessibilityLabel="Settings" />}
|
|
71
|
+
>
|
|
72
|
+
<SearchInput
|
|
73
|
+
compact
|
|
74
|
+
accessibilityLabel="Search"
|
|
75
|
+
onChangeText={setSearch}
|
|
76
|
+
placeholder="Search assets..."
|
|
77
|
+
value={search}
|
|
78
|
+
/>
|
|
79
|
+
</NavigationBar>
|
|
80
|
+
);
|
|
81
|
+
}
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Accessibility
|
|
85
|
+
|
|
86
|
+
Use `accessibilityLabel` to provide context for screen readers. The default label is "main navigation".
|
|
14
87
|
|
|
15
88
|
```jsx live
|
|
16
|
-
|
|
89
|
+
<NavigationBar
|
|
90
|
+
accessibilityLabel="Primary site navigation"
|
|
91
|
+
start={<IconButton name="backArrow" accessibilityLabel="Go back to previous page" />}
|
|
92
|
+
end={<IconButton name="bell" accessibilityLabel="View notifications, 3 unread" />}
|
|
93
|
+
>
|
|
94
|
+
<NavigationTitle>Account Settings</NavigationTitle>
|
|
95
|
+
</NavigationBar>
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
When using interactive elements in the navigation bar, ensure each has appropriate accessibility labels describing their action.
|
|
99
|
+
|
|
100
|
+
### Composed Examples
|
|
101
|
+
|
|
102
|
+
#### Full Navigation with Back Button
|
|
103
|
+
|
|
104
|
+
A complete navigation example with dynamic back button visibility and tab navigation.
|
|
105
|
+
|
|
106
|
+
```jsx live
|
|
107
|
+
function FullNavigation() {
|
|
17
108
|
const tabs = [
|
|
18
|
-
{
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
},
|
|
22
|
-
{
|
|
23
|
-
id: 'watchlist',
|
|
24
|
-
label: 'Watchlist',
|
|
25
|
-
},
|
|
26
|
-
{
|
|
27
|
-
id: 'tradable',
|
|
28
|
-
label: 'Tradable',
|
|
29
|
-
},
|
|
30
|
-
{
|
|
31
|
-
id: 'gainers',
|
|
32
|
-
label: 'Gainers',
|
|
33
|
-
count: 2,
|
|
34
|
-
},
|
|
35
|
-
{
|
|
36
|
-
id: 'losers',
|
|
37
|
-
label: 'Losers',
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
id: 'trending',
|
|
41
|
-
label: 'Trending',
|
|
42
|
-
},
|
|
43
|
-
{
|
|
44
|
-
id: 'other',
|
|
45
|
-
label: 'Other',
|
|
46
|
-
},
|
|
109
|
+
{ id: 'all', label: 'All' },
|
|
110
|
+
{ id: 'watchlist', label: 'Watchlist' },
|
|
111
|
+
{ id: 'tradable', label: 'Tradable' },
|
|
112
|
+
{ id: 'gainers', label: 'Gainers' },
|
|
113
|
+
{ id: 'losers', label: 'Losers' },
|
|
47
114
|
];
|
|
48
115
|
const [search, setSearch] = useState('');
|
|
49
116
|
const [value, setValue] = useState(tabs[1].id);
|
|
50
117
|
const showBackButton = useMemo(() => value !== tabs[0].id, [value]);
|
|
118
|
+
|
|
51
119
|
const handleBackPress = useCallback(() => {
|
|
52
120
|
setValue(tabs[0].id);
|
|
53
121
|
}, []);
|
|
122
|
+
|
|
54
123
|
return (
|
|
55
124
|
<NavigationBar
|
|
56
125
|
start={
|
|
@@ -60,23 +129,80 @@ function NavigationWithPress() {
|
|
|
60
129
|
}
|
|
61
130
|
end={
|
|
62
131
|
<HStack gap={1} alignItems="center">
|
|
63
|
-
<IconButton accessibilityLabel="Language"
|
|
132
|
+
<IconButton accessibilityLabel="Language" name="globe" />
|
|
64
133
|
<IconButton accessibilityLabel="Notifications" active name="bell" />
|
|
65
134
|
</HStack>
|
|
66
135
|
}
|
|
67
136
|
bottom={<TabNavigation tabs={tabs} value={value} onChange={setValue} />}
|
|
68
137
|
>
|
|
69
|
-
<
|
|
70
|
-
|
|
138
|
+
<SearchInput
|
|
139
|
+
compact
|
|
140
|
+
accessibilityLabel="Search"
|
|
141
|
+
onChangeText={setSearch}
|
|
142
|
+
placeholder="Search"
|
|
143
|
+
value={search}
|
|
144
|
+
/>
|
|
145
|
+
</NavigationBar>
|
|
146
|
+
);
|
|
147
|
+
}
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
#### Responsive Navigation
|
|
151
|
+
|
|
152
|
+
A responsive navigation bar that adapts to screen size. On mobile, the search input collapses to an icon button.
|
|
153
|
+
|
|
154
|
+
```jsx live
|
|
155
|
+
function ResponsiveNavigation() {
|
|
156
|
+
const [search, setSearch] = useState('');
|
|
157
|
+
const [searchOpen, setSearchOpen] = useState(false);
|
|
158
|
+
const { isMobile } = useBreakpoints();
|
|
159
|
+
|
|
160
|
+
const handleSearchToggle = useCallback(() => {
|
|
161
|
+
setSearchOpen((prev) => !prev);
|
|
162
|
+
if (searchOpen) {
|
|
163
|
+
setSearch('');
|
|
164
|
+
}
|
|
165
|
+
}, [searchOpen]);
|
|
166
|
+
|
|
167
|
+
return (
|
|
168
|
+
<NavigationBar
|
|
169
|
+
background="bgSecondary"
|
|
170
|
+
start={<IconButton name="backArrow" accessibilityLabel="Back" />}
|
|
171
|
+
end={
|
|
172
|
+
<HStack gap={1} alignItems="center">
|
|
173
|
+
{isMobile && (
|
|
174
|
+
<IconButton
|
|
175
|
+
name="search"
|
|
176
|
+
accessibilityLabel="Search"
|
|
177
|
+
onClick={handleSearchToggle}
|
|
178
|
+
active={searchOpen}
|
|
179
|
+
/>
|
|
180
|
+
)}
|
|
181
|
+
<IconButton name="bell" accessibilityLabel="Notifications" />
|
|
182
|
+
<Avatar size="xl" />
|
|
183
|
+
</HStack>
|
|
184
|
+
}
|
|
185
|
+
>
|
|
186
|
+
{isMobile ? (
|
|
187
|
+
searchOpen && (
|
|
71
188
|
<SearchInput
|
|
72
189
|
compact
|
|
73
190
|
accessibilityLabel="Search"
|
|
74
191
|
onChangeText={setSearch}
|
|
75
|
-
placeholder="Search"
|
|
192
|
+
placeholder="Search..."
|
|
76
193
|
value={search}
|
|
77
194
|
/>
|
|
78
|
-
|
|
79
|
-
|
|
195
|
+
)
|
|
196
|
+
) : (
|
|
197
|
+
<SearchInput
|
|
198
|
+
compact
|
|
199
|
+
accessibilityLabel="Search"
|
|
200
|
+
onChangeText={setSearch}
|
|
201
|
+
placeholder="Search assets..."
|
|
202
|
+
value={search}
|
|
203
|
+
/>
|
|
204
|
+
)}
|
|
205
|
+
{!isMobile && !searchOpen && <NavigationTitle>Trading</NavigationTitle>}
|
|
80
206
|
</NavigationBar>
|
|
81
207
|
);
|
|
82
208
|
}
|
|
@@ -86,17 +212,117 @@ function NavigationWithPress() {
|
|
|
86
212
|
|
|
87
213
|
| Prop | Type | Required | Default | Description |
|
|
88
214
|
| --- | --- | --- | --- | --- |
|
|
89
|
-
| `
|
|
90
|
-
| `
|
|
91
|
-
| `
|
|
92
|
-
| `
|
|
215
|
+
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
216
|
+
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
217
|
+
| `alignSelf` | `ResponsiveProp<center \| normal \| auto \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
218
|
+
| `as` | `nav` | 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. |
|
|
219
|
+
| `aspectRatio` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
220
|
+
| `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 | `-` | - |
|
|
221
|
+
| `borderBottomLeftRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
222
|
+
| `borderBottomRightRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
223
|
+
| `borderBottomWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
224
|
+
| `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 | `-` | - |
|
|
225
|
+
| `borderEndWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
226
|
+
| `borderRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
227
|
+
| `borderStartWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
228
|
+
| `borderTopLeftRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
229
|
+
| `borderTopRightRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
|
|
230
|
+
| `borderTopWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
231
|
+
| `borderWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
|
|
232
|
+
| `bordered` | `boolean` | No | `-` | Add a border around all sides of the box. |
|
|
233
|
+
| `borderedBottom` | `boolean` | No | `-` | Add a border to the bottom side of the box. |
|
|
234
|
+
| `borderedEnd` | `boolean` | No | `-` | Add a border to the trailing side of the box. |
|
|
235
|
+
| `borderedHorizontal` | `boolean` | No | `-` | Add a border to the leading and trailing sides of the box. |
|
|
236
|
+
| `borderedStart` | `boolean` | No | `-` | Add a border to the leading side of the box. |
|
|
237
|
+
| `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
|
|
238
|
+
| `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
|
|
239
|
+
| `bottom` | `((Bottom<string \| number> \| { base?: Bottom<string \| number>; phone?: Bottom<string \| number> \| undefined; tablet?: Bottom<string \| number> \| undefined; desktop?: Bottom<string \| number> \| undefined; }) & (string \| number \| boolean \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal \| null)) \| undefined` | No | `-` | The bottom content. Use to render tabs |
|
|
240
|
+
| `children` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | The middle content. Use the children to render the page title |
|
|
241
|
+
| `classNames` | `{ readonly root?: string; readonly start?: string \| undefined; readonly content?: string \| undefined; } \| undefined` | No | `-` | - |
|
|
242
|
+
| `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 | `-` | - |
|
|
243
|
+
| `columnGap` | `((Space \| { base?: Space; phone?: Space \| undefined; tablet?: Space \| undefined; desktop?: Space \| undefined; }) & ResponsiveProp<Space>) \| undefined` | No | `2` | Space between the start, children, and end of the nav bar |
|
|
93
244
|
| `dangerouslyDisableOverflowHidden` | `boolean` | No | `-` | Disable the overflow: hidden style from being injected to the child Col |
|
|
245
|
+
| `dangerouslySetBackground` | `string` | No | `-` | - |
|
|
246
|
+
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
247
|
+
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
94
248
|
| `end` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Node (icons, avatar, etc) to display at the end of the nav bar |
|
|
95
|
-
| `
|
|
96
|
-
| `
|
|
97
|
-
| `
|
|
98
|
-
| `
|
|
249
|
+
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
250
|
+
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
251
|
+
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
252
|
+
| `flexShrink` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
253
|
+
| `flexWrap` | `ResponsiveProp<nowrap \| wrap \| wrap-reverse>` | No | `-` | - |
|
|
254
|
+
| `font` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
255
|
+
| `fontFamily` | `ResponsiveProp<FontFamily \| inherit>` | No | `-` | - |
|
|
256
|
+
| `fontSize` | `ResponsiveProp<FontSize \| inherit>` | No | `-` | - |
|
|
257
|
+
| `fontWeight` | `ResponsiveProp<FontWeight \| inherit>` | No | `-` | - |
|
|
258
|
+
| `gap` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
259
|
+
| `grid` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
260
|
+
| `gridArea` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
261
|
+
| `gridAutoColumns` | `ResponsiveProp<GridAutoColumns<string \| number>>` | No | `-` | - |
|
|
262
|
+
| `gridAutoFlow` | `inherit \| revert \| row \| column \| -moz-initial \| initial \| revert-layer \| unset \| dense` | No | `-` | - |
|
|
263
|
+
| `gridAutoRows` | `ResponsiveProp<GridAutoRows<string \| number>>` | No | `-` | - |
|
|
264
|
+
| `gridColumn` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
265
|
+
| `gridColumnEnd` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
266
|
+
| `gridColumnStart` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
267
|
+
| `gridRow` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
268
|
+
| `gridRowEnd` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
269
|
+
| `gridRowStart` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
270
|
+
| `gridTemplate` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
271
|
+
| `gridTemplateAreas` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
272
|
+
| `gridTemplateColumns` | `ResponsiveProp<GridTemplateColumns<string \| number>>` | No | `-` | - |
|
|
273
|
+
| `gridTemplateRows` | `ResponsiveProp<GridTemplateRows<string \| number>>` | No | `-` | - |
|
|
274
|
+
| `height` | `ResponsiveProp<Height<string \| number>>` | No | `-` | - |
|
|
275
|
+
| `justifyContent` | `ResponsiveProp<left \| right \| center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
276
|
+
| `key` | `Key \| null` | No | `-` | - |
|
|
277
|
+
| `left` | `ResponsiveProp<Left<string \| number>>` | No | `-` | - |
|
|
278
|
+
| `lineHeight` | `ResponsiveProp<LineHeight \| inherit>` | No | `-` | - |
|
|
279
|
+
| `margin` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
|
|
280
|
+
| `marginBottom` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
|
|
281
|
+
| `marginEnd` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
|
|
282
|
+
| `marginStart` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
|
|
283
|
+
| `marginTop` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
|
|
284
|
+
| `marginX` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
|
|
285
|
+
| `marginY` | `ResponsiveProp<0 \| -5 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1 \| -1.5 \| -2 \| -3 \| -4 \| -6 \| -7 \| -8 \| -9>` | No | `-` | - |
|
|
286
|
+
| `maxHeight` | `ResponsiveProp<MaxHeight<string \| number>>` | No | `-` | - |
|
|
287
|
+
| `maxWidth` | `ResponsiveProp<MaxWidth<string \| number>>` | No | `-` | - |
|
|
288
|
+
| `minHeight` | `ResponsiveProp<MinHeight<string \| number>>` | No | `-` | - |
|
|
289
|
+
| `minWidth` | `ResponsiveProp<MinWidth<string \| number>>` | No | `-` | - |
|
|
290
|
+
| `onChange` | `FormEventHandler<HTMLDivElement>` | No | `-` | - |
|
|
291
|
+
| `opacity` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
292
|
+
| `overflow` | `ResponsiveProp<hidden \| auto \| visible \| clip \| scroll>` | No | `-` | - |
|
|
293
|
+
| `padding` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
294
|
+
| `paddingBottom` | `((Space \| { base?: Space; phone?: Space \| undefined; tablet?: Space \| undefined; desktop?: Space \| undefined; }) & Space) \| undefined` | No | `2 if bottom is not provided` | - |
|
|
295
|
+
| `paddingEnd` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
296
|
+
| `paddingStart` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
297
|
+
| `paddingTop` | `((Space \| { base?: Space; phone?: Space \| undefined; tablet?: Space \| undefined; desktop?: Space \| undefined; }) & Space) \| undefined` | No | `2` | - |
|
|
298
|
+
| `paddingX` | `((Space \| { base?: Space; phone?: Space \| undefined; tablet?: Space \| undefined; desktop?: Space \| undefined; }) & Space) \| undefined` | No | `2` | - |
|
|
299
|
+
| `paddingY` | `0 \| 1 \| 2 \| 0.25 \| 0.5 \| 0.75 \| 1.5 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10` | No | `-` | - |
|
|
300
|
+
| `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
|
|
301
|
+
| `position` | `ResponsiveProp<fixed \| static \| relative \| absolute \| sticky>` | No | `-` | - |
|
|
302
|
+
| `ref` | `((instance: HTMLElement \| null) => void) \| RefObject<HTMLElement> \| null` | No | `-` | - |
|
|
303
|
+
| `right` | `ResponsiveProp<Right<string \| number>>` | No | `-` | - |
|
|
304
|
+
| `rowGap` | `((Space \| { base?: Space; phone?: Space \| undefined; tablet?: Space \| undefined; desktop?: Space \| undefined; }) & ResponsiveProp<Space>) \| undefined` | No | `2` | Space between bottom of the nav bar and the rest of its content |
|
|
99
305
|
| `start` | `null \| string \| number \| false \| true \| ReactElement<any, string \| JSXElementConstructor<any>> \| Iterable<ReactNode> \| ReactPortal` | No | `-` | Node (ie Back button) to display at the start of the nav bar |
|
|
306
|
+
| `style` | `CSSProperties` | No | `-` | - |
|
|
307
|
+
| `styles` | `{ readonly root?: CSSProperties; readonly start?: CSSProperties \| undefined; readonly content?: CSSProperties \| undefined; } \| undefined` | No | `-` | - |
|
|
100
308
|
| `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 |
|
|
309
|
+
| `textAlign` | `ResponsiveProp<center \| start \| end \| justify>` | No | `-` | - |
|
|
310
|
+
| `textDecoration` | `ResponsiveProp<none \| underline \| overline \| line-through \| underline overline \| underline double>` | No | `-` | - |
|
|
311
|
+
| `textTransform` | `ResponsiveProp<capitalize \| lowercase \| none \| uppercase>` | No | `-` | - |
|
|
312
|
+
| `top` | `ResponsiveProp<Top<string \| number>>` | No | `-` | - |
|
|
313
|
+
| `transform` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
314
|
+
| `userSelect` | `ResponsiveProp<text \| none \| auto \| all>` | No | `-` | - |
|
|
315
|
+
| `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
|
|
316
|
+
| `width` | `ResponsiveProp<Width<string \| number>>` | No | `-` | - |
|
|
317
|
+
| `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
## Styles
|
|
321
|
+
|
|
322
|
+
| Selector | Static class name | Description |
|
|
323
|
+
| --- | --- | --- |
|
|
324
|
+
| `root` | `cds-NavigationBar` | Root nav element containing the entire navigation bar |
|
|
325
|
+
| `start` | `cds-NavigationBar-start` | Container for the start slot (e.g., back button) |
|
|
326
|
+
| `content` | `cds-NavigationBar-content` | Container for the main children content (e.g., title) |
|
|
101
327
|
|
|
102
328
|
|
|
@@ -243,3 +243,13 @@ function Example() {
|
|
|
243
243
|
| `width` | `ResponsiveProp<Width<string \| number>>` | No | `-` | - |
|
|
244
244
|
|
|
245
245
|
|
|
246
|
+
## Styles
|
|
247
|
+
|
|
248
|
+
| Selector | Static class name | Description |
|
|
249
|
+
| --- | --- | --- |
|
|
250
|
+
| `start` | `-` | start element. |
|
|
251
|
+
| `end` | `-` | end element. |
|
|
252
|
+
| `title` | `-` | title element. |
|
|
253
|
+
| `root` | `-` | root element. |
|
|
254
|
+
|
|
255
|
+
|