@coinbase/cds-mcp-server 8.42.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 +12 -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/Banner.txt +1 -1
- package/mcp-docs/mobile/components/Button.txt +2 -2
- package/mcp-docs/mobile/components/Carousel.txt +393 -72
- package/mcp-docs/mobile/components/CellMedia.txt +1 -1
- 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/DotSymbol.txt +1 -1
- package/mcp-docs/mobile/components/Icon.txt +9 -1
- package/mcp-docs/mobile/components/IconButton.txt +1 -1
- 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/Banner.txt +1 -1
- package/mcp-docs/web/components/Box.txt +5 -5
- package/mcp-docs/web/components/Button.txt +7 -7
- package/mcp-docs/web/components/Carousel.txt +358 -62
- package/mcp-docs/web/components/CellMedia.txt +1 -1
- package/mcp-docs/web/components/Checkbox.txt +1 -1
- package/mcp-docs/web/components/CheckboxCell.txt +12 -1
- package/mcp-docs/web/components/Chip.txt +9 -1
- 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/DateInput.txt +1 -1
- package/mcp-docs/web/components/DatePicker.txt +1 -1
- package/mcp-docs/web/components/DotCount.txt +9 -0
- package/mcp-docs/web/components/DotSymbol.txt +1 -1
- 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 +9 -1
- package/mcp-docs/web/components/IconButton.txt +6 -6
- package/mcp-docs/web/components/InputChip.txt +1 -1
- 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/MediaChip.txt +1 -1
- 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/Radio.txt +1 -1
- package/mcp-docs/web/components/RadioCell.txt +12 -1
- package/mcp-docs/web/components/RollingNumber.txt +21 -5
- package/mcp-docs/web/components/Scrubber.txt +10 -0
- package/mcp-docs/web/components/SearchInput.txt +1 -1
- package/mcp-docs/web/components/SelectAlpha.txt +26 -0
- package/mcp-docs/web/components/SelectChip.txt +1 -1
- package/mcp-docs/web/components/SelectChipAlpha.txt +26 -0
- package/mcp-docs/web/components/Sidebar.txt +10 -0
- package/mcp-docs/web/components/SidebarItem.txt +2 -2
- package/mcp-docs/web/components/Spacer.txt +5 -5
- package/mcp-docs/web/components/Stepper.txt +13 -0
- package/mcp-docs/web/components/Switch.txt +1 -1
- package/mcp-docs/web/components/TabbedChipsAlpha.txt +10 -0
- package/mcp-docs/web/components/Text.txt +5 -5
- package/mcp-docs/web/components/TextInput.txt +1 -1
- 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
|
@@ -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
|
+
|
|
@@ -101,17 +101,17 @@ On web, all [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Acces
|
|
|
101
101
|
| `aria-colindextext` | `string \| undefined` | No | `-` | Defines a human readable text alternative of aria-colindex. |
|
|
102
102
|
| `aria-colspan` | `number \| undefined` | No | `-` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
|
|
103
103
|
| `aria-controls` | `string \| undefined` | No | `-` | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
|
|
104
|
-
| `aria-current` | `boolean \| true \| false \| page \| step \| location \| date \|
|
|
104
|
+
| `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. |
|
|
105
105
|
| `aria-describedby` | `string \| undefined` | No | `-` | Identifies the element (or elements) that describes the object. |
|
|
106
106
|
| `aria-description` | `string \| undefined` | No | `-` | Defines a string value that describes or annotates the current element. |
|
|
107
107
|
| `aria-details` | `string \| undefined` | No | `-` | Identifies the element that provides a detailed, extended description for the object. |
|
|
108
108
|
| `aria-disabled` | `Booleanish \| undefined` | No | `-` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
|
|
109
|
-
| `aria-dropeffect` | `
|
|
109
|
+
| `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. |
|
|
110
110
|
| `aria-errormessage` | `string \| undefined` | No | `-` | Identifies the element that provides an error message for the object. |
|
|
111
111
|
| `aria-expanded` | `Booleanish \| undefined` | No | `-` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
|
|
112
112
|
| `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. |
|
|
113
113
|
| `aria-grabbed` | `Booleanish \| undefined` | No | `-` | Indicates an elements grabbed state in a drag-and-drop operation. |
|
|
114
|
-
| `aria-haspopup` | `boolean \|
|
|
114
|
+
| `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. |
|
|
115
115
|
| `aria-hidden` | `Booleanish \| undefined` | No | `-` | Indicates whether the element is exposed to an accessibility API. |
|
|
116
116
|
| `aria-invalid` | `boolean \| true \| false \| grammar \| spelling \| undefined` | No | `-` | Indicates the entered value does not conform to the format expected by the application. |
|
|
117
117
|
| `aria-keyshortcuts` | `string \| undefined` | No | `-` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
|
|
@@ -187,7 +187,7 @@ On web, all [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Acces
|
|
|
187
187
|
| `display` | `ResponsiveProp<grid \| revert \| none \| block \| inline \| inline-block \| flex \| inline-flex \| inline-grid \| contents \| flow-root \| list-item>` | No | `-` | - |
|
|
188
188
|
| `draggable` | `Booleanish \| undefined` | No | `-` | - |
|
|
189
189
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
190
|
-
| `enterKeyHint` | `enter \| done \| go \| next \| previous \|
|
|
190
|
+
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
191
191
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
192
192
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
193
193
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -224,7 +224,7 @@ On web, all [ARIA attributes](https://developer.mozilla.org/en-US/docs/Web/Acces
|
|
|
224
224
|
| `hidden` | `boolean \| undefined` | No | `-` | - |
|
|
225
225
|
| `id` | `string \| undefined` | No | `-` | - |
|
|
226
226
|
| `inlist` | `any` | No | `-` | - |
|
|
227
|
-
| `inputMode` | `
|
|
227
|
+
| `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 |
|
|
228
228
|
| `is` | `string \| undefined` | No | `-` | Specify that a standard HTML element should behave like a defined custom built-in element |
|
|
229
229
|
| `itemID` | `string \| undefined` | No | `-` | - |
|
|
230
230
|
| `itemProp` | `string \| undefined` | No | `-` | - |
|
|
@@ -179,3 +179,11 @@ function Example() {
|
|
|
179
179
|
| `weight` | `normal \| heavy \| thin \| semiheavy` | No | `normal` | Toggle used to change thickness of progress visualization |
|
|
180
180
|
|
|
181
181
|
|
|
182
|
+
## Styles
|
|
183
|
+
|
|
184
|
+
| Selector | Static class name | Description |
|
|
185
|
+
| --- | --- | --- |
|
|
186
|
+
| `root` | `-` | progress bar root. |
|
|
187
|
+
| `progress` | `-` | progress. |
|
|
188
|
+
|
|
189
|
+
|
|
@@ -281,3 +281,13 @@ function Example() {
|
|
|
281
281
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
282
282
|
|
|
283
283
|
|
|
284
|
+
## Styles
|
|
285
|
+
|
|
286
|
+
| Selector | Static class name | Description |
|
|
287
|
+
| --- | --- | --- |
|
|
288
|
+
| `root` | `-` | progress bar with fixed labels root. |
|
|
289
|
+
| `labelContainer` | `-` | label container. |
|
|
290
|
+
| `startLabel` | `-` | start label. |
|
|
291
|
+
| `endLabel` | `-` | end label. |
|
|
292
|
+
|
|
293
|
+
|
|
@@ -250,3 +250,12 @@ function Example() {
|
|
|
250
250
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
251
251
|
|
|
252
252
|
|
|
253
|
+
## Styles
|
|
254
|
+
|
|
255
|
+
| Selector | Static class name | Description |
|
|
256
|
+
| --- | --- | --- |
|
|
257
|
+
| `root` | `-` | progress bar with float label root. |
|
|
258
|
+
| `labelContainer` | `-` | label container. |
|
|
259
|
+
| `label` | `-` | label. |
|
|
260
|
+
|
|
261
|
+
|
|
@@ -467,3 +467,13 @@ function Example() {
|
|
|
467
467
|
| `weight` | `normal \| heavy \| thin \| semiheavy` | No | `normal` | Toggle used to change thickness of progress visualization |
|
|
468
468
|
|
|
469
469
|
|
|
470
|
+
## Styles
|
|
471
|
+
|
|
472
|
+
| Selector | Static class name | Description |
|
|
473
|
+
| --- | --- | --- |
|
|
474
|
+
| `root` | `-` | progress circle root. |
|
|
475
|
+
| `svg` | `-` | progress circle svg. |
|
|
476
|
+
| `circle` | `-` | background circle. |
|
|
477
|
+
| `progress` | `-` | foreground circle. |
|
|
478
|
+
|
|
479
|
+
|
|
@@ -214,7 +214,7 @@ function CustomStyledRadio() {
|
|
|
214
214
|
| `onChange` | `FormEventHandler<HTMLDivElement>` | No | `-` | - |
|
|
215
215
|
| `ref` | `null \| (instance: HTMLInputElement \| null) => void \| RefObject<HTMLInputElement>` | No | `-` | - |
|
|
216
216
|
| `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 |
|
|
217
|
-
| `type` | `button \|
|
|
217
|
+
| `type` | `button \| reset \| submit` | No | `-` | - |
|
|
218
218
|
| `value` | `string` | No | `-` | Value of the option. Useful for multiple choice. |
|
|
219
219
|
|
|
220
220
|
|
|
@@ -205,7 +205,7 @@ function CustomRadioCellExample() {
|
|
|
205
205
|
| `transform` | `inherit \| none \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
206
206
|
| `transparentWhileInactive` | `boolean` | No | `-` | Mark the background and border as transparent until the element is interacted with (hovered, pressed, etc). Must be used in conjunction with the pressed prop |
|
|
207
207
|
| `transparentWhilePressed` | `boolean` | No | `-` | Mark the background and border as transparent even while element is interacted with (elevation underlay issue). Must be used in conjunction with the pressed prop |
|
|
208
|
-
| `type` | `button \|
|
|
208
|
+
| `type` | `button \| reset \| submit` | No | `-` | - |
|
|
209
209
|
| `userSelect` | `ResponsiveProp<text \| none \| auto \| all>` | No | `-` | - |
|
|
210
210
|
| `value` | `string` | No | `-` | Value of the option. Useful for multiple choice. |
|
|
211
211
|
| `visibility` | `ResponsiveProp<hidden \| visible>` | No | `-` | - |
|
|
@@ -213,3 +213,14 @@ function CustomRadioCellExample() {
|
|
|
213
213
|
| `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
214
214
|
|
|
215
215
|
|
|
216
|
+
## Styles
|
|
217
|
+
|
|
218
|
+
| Selector | Static class name | Description |
|
|
219
|
+
| --- | --- | --- |
|
|
220
|
+
| `root` | `-` | - |
|
|
221
|
+
| `radioContainer` | `-` | - |
|
|
222
|
+
| `title` | `-` | - |
|
|
223
|
+
| `description` | `-` | - |
|
|
224
|
+
| `contentContainer` | `-` | - |
|
|
225
|
+
|
|
226
|
+
|
|
@@ -1024,17 +1024,17 @@ ValueSection
|
|
|
1024
1024
|
| `aria-colindextext` | `string \| undefined` | No | `-` | Defines a human readable text alternative of aria-colindex. |
|
|
1025
1025
|
| `aria-colspan` | `number \| undefined` | No | `-` | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
|
|
1026
1026
|
| `aria-controls` | `string \| undefined` | No | `-` | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
|
|
1027
|
-
| `aria-current` | `boolean \| true \| false \| page \| step \| location \| date \|
|
|
1027
|
+
| `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. |
|
|
1028
1028
|
| `aria-describedby` | `string \| undefined` | No | `-` | Identifies the element (or elements) that describes the object. |
|
|
1029
1029
|
| `aria-description` | `string \| undefined` | No | `-` | Defines a string value that describes or annotates the current element. |
|
|
1030
1030
|
| `aria-details` | `string \| undefined` | No | `-` | Identifies the element that provides a detailed, extended description for the object. |
|
|
1031
1031
|
| `aria-disabled` | `Booleanish \| undefined` | No | `-` | Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
|
|
1032
|
-
| `aria-dropeffect` | `
|
|
1032
|
+
| `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. |
|
|
1033
1033
|
| `aria-errormessage` | `string \| undefined` | No | `-` | Identifies the element that provides an error message for the object. |
|
|
1034
1034
|
| `aria-expanded` | `Booleanish \| undefined` | No | `-` | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
|
|
1035
1035
|
| `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. |
|
|
1036
1036
|
| `aria-grabbed` | `Booleanish \| undefined` | No | `-` | Indicates an elements grabbed state in a drag-and-drop operation. |
|
|
1037
|
-
| `aria-haspopup` | `boolean \|
|
|
1037
|
+
| `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. |
|
|
1038
1038
|
| `aria-hidden` | `Booleanish \| undefined` | No | `-` | Indicates whether the element is exposed to an accessibility API. |
|
|
1039
1039
|
| `aria-invalid` | `boolean \| true \| false \| grammar \| spelling \| undefined` | No | `-` | Indicates the entered value does not conform to the format expected by the application. |
|
|
1040
1040
|
| `aria-keyshortcuts` | `string \| undefined` | No | `-` | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
|
|
@@ -1114,7 +1114,7 @@ ValueSection
|
|
|
1114
1114
|
| `draggable` | `Booleanish \| undefined` | No | `-` | - |
|
|
1115
1115
|
| `elevation` | `0 \| 1 \| 2` | No | `-` | - |
|
|
1116
1116
|
| `enableSubscriptNotation` | `boolean` | No | `-` | Enables subscript notation for leading zeros in the fractional part (for example, {@code 0.00009 => 0.0₄9}). |
|
|
1117
|
-
| `enterKeyHint` | `enter \| done \| go \| next \| previous \|
|
|
1117
|
+
| `enterKeyHint` | `search \| enter \| done \| go \| next \| previous \| send \| undefined` | No | `-` | - |
|
|
1118
1118
|
| `flexBasis` | `ResponsiveProp<FlexBasis<string \| number>>` | No | `-` | - |
|
|
1119
1119
|
| `flexDirection` | `ResponsiveProp<column \| row \| row-reverse \| column-reverse>` | No | `-` | - |
|
|
1120
1120
|
| `flexGrow` | `inherit \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
@@ -1146,7 +1146,7 @@ ValueSection
|
|
|
1146
1146
|
| `hidden` | `boolean \| undefined` | No | `-` | - |
|
|
1147
1147
|
| `id` | `string \| undefined` | No | `-` | - |
|
|
1148
1148
|
| `inlist` | `any` | No | `-` | - |
|
|
1149
|
-
| `inputMode` | `
|
|
1149
|
+
| `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 |
|
|
1150
1150
|
| `is` | `string \| undefined` | No | `-` | Specify that a standard HTML element should behave like a defined custom built-in element |
|
|
1151
1151
|
| `itemID` | `string \| undefined` | No | `-` | - |
|
|
1152
1152
|
| `itemProp` | `string \| undefined` | No | `-` | - |
|
|
@@ -1389,3 +1389,19 @@ ValueSection
|
|
|
1389
1389
|
| `zIndex` | `inherit \| auto \| revert \| -moz-initial \| initial \| revert-layer \| unset` | No | `-` | - |
|
|
1390
1390
|
|
|
1391
1391
|
|
|
1392
|
+
## Styles
|
|
1393
|
+
|
|
1394
|
+
| Selector | Static class name | Description |
|
|
1395
|
+
| --- | --- | --- |
|
|
1396
|
+
| `root` | `-` | Inline style override applied to the outer container element. |
|
|
1397
|
+
| `visibleContent` | `-` | Inline style override applied to the animated content wrapper that is visually rendered. |
|
|
1398
|
+
| `formattedValueSection` | `-` | Inline style override applied to the wrapper for the formatted numeric value. |
|
|
1399
|
+
| `prefix` | `-` | Inline style override applied to the prefix section rendered from props. |
|
|
1400
|
+
| `suffix` | `-` | Inline style override applied to the suffix section rendered from props. |
|
|
1401
|
+
| `i18nPrefix` | `-` | The prefix generated by Intl.NumberFormat, for example, the $ in $1,000. |
|
|
1402
|
+
| `i18nSuffix` | `-` | The suffix generated by Intl.NumberFormat, for example, the K in 100K. |
|
|
1403
|
+
| `integer` | `-` | Inline styles applied to the integer portion of the formatted value. |
|
|
1404
|
+
| `fraction` | `-` | Inline styles applied to the fractional portion of the formatted value. |
|
|
1405
|
+
| `text` | `-` | Inline styles applied to the Text component rendering digits and symbols. |
|
|
1406
|
+
|
|
1407
|
+
|
|
@@ -761,3 +761,13 @@ function PercentageBeaconLabels() {
|
|
|
761
761
|
| `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
|
|
762
762
|
|
|
763
763
|
|
|
764
|
+
## Styles
|
|
765
|
+
|
|
766
|
+
| Selector | Static class name | Description |
|
|
767
|
+
| --- | --- | --- |
|
|
768
|
+
| `overlay` | `-` | - |
|
|
769
|
+
| `beacon` | `-` | - |
|
|
770
|
+
| `line` | `-` | - |
|
|
771
|
+
| `beaconLabel` | `-` | - |
|
|
772
|
+
|
|
773
|
+
|
|
@@ -110,7 +110,7 @@ function CustomEndSearchInput() {
|
|
|
110
110
|
| `startIconAccessibilityLabel` | `string` | No | `-` | Set the a11y label for the start icon |
|
|
111
111
|
| `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 |
|
|
112
112
|
| `testIDMap` | `{ start?: string; end?: string \| undefined; label?: string \| undefined; helperText?: string \| undefined; } \| undefined` | No | `-` | Add ability to test individual parts of the input |
|
|
113
|
-
| `type` | `button \|
|
|
113
|
+
| `type` | `button \| reset \| submit` | No | `-` | - |
|
|
114
114
|
| `value` | `string \| (readonly string[] & string)` | No | `-` | The **value** property of the HTMLInputElement interface represents the current value of the input element as a string. [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/value) |
|
|
115
115
|
| `width` | `((Width<string \| number> \| { base?: Width<string \| number>; phone?: Width<string \| number> \| undefined; tablet?: Width<string \| number> \| undefined; desktop?: Width<string \| number> \| undefined; }) & (string \| number)) \| undefined` | No | `100%` | Width of input as a percentage string. |
|
|
116
116
|
|
|
@@ -1436,3 +1436,29 @@ function CustomComponentExamples() {
|
|
|
1436
1436
|
| `variant` | `primary \| secondary \| positive \| negative \| foregroundMuted \| foreground` | No | `foregroundMuted` | Determines the sentiment of the input. Because we allow startContent and endContent to be custom ReactNode, the content placed inside these slots will not change colors according to the variant. You will have to add that yourself |
|
|
1437
1437
|
|
|
1438
1438
|
|
|
1439
|
+
## Styles
|
|
1440
|
+
|
|
1441
|
+
| Selector | Static class name | Description |
|
|
1442
|
+
| --- | --- | --- |
|
|
1443
|
+
| `root` | `-` | root container |
|
|
1444
|
+
| `control` | `-` | control element |
|
|
1445
|
+
| `controlStartNode` | `-` | start node element |
|
|
1446
|
+
| `controlInputNode` | `-` | input node element |
|
|
1447
|
+
| `controlValueNode` | `-` | value node element |
|
|
1448
|
+
| `controlLabelNode` | `-` | label node element |
|
|
1449
|
+
| `controlHelperTextNode` | `-` | helper text node element |
|
|
1450
|
+
| `controlEndNode` | `-` | end node element |
|
|
1451
|
+
| `controlBlendStyles` | `-` | Blend styles for control interactivity |
|
|
1452
|
+
| `dropdown` | `-` | dropdown container |
|
|
1453
|
+
| `option` | `-` | individual options |
|
|
1454
|
+
| `optionCell` | `-` | option cell element |
|
|
1455
|
+
| `optionContent` | `-` | option content wrapper |
|
|
1456
|
+
| `optionLabel` | `-` | option label element |
|
|
1457
|
+
| `optionDescription` | `-` | option description element |
|
|
1458
|
+
| `optionBlendStyles` | `-` | Blend styles for option interactivity |
|
|
1459
|
+
| `selectAllDivider` | `-` | select all divider element |
|
|
1460
|
+
| `emptyContentsContainer` | `-` | empty contents container element |
|
|
1461
|
+
| `emptyContentsText` | `-` | empty contents text element |
|
|
1462
|
+
| `optionGroup` | `-` | option group element |
|
|
1463
|
+
|
|
1464
|
+
|