@coinbase/cds-mcp-server 8.17.3 → 8.17.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/mcp-docs/mobile/components/Accordion.txt +11 -12
- package/mcp-docs/mobile/components/AccordionItem.txt +5 -6
- package/mcp-docs/mobile/components/Alert.txt +21 -22
- package/mcp-docs/mobile/components/AreaChart.txt +118 -119
- package/mcp-docs/mobile/components/Avatar.txt +82 -83
- package/mcp-docs/mobile/components/AvatarButton.txt +103 -104
- package/mcp-docs/mobile/components/Banner.txt +100 -101
- package/mcp-docs/mobile/components/BarChart.txt +120 -121
- package/mcp-docs/mobile/components/Box.txt +65 -66
- package/mcp-docs/mobile/components/BrowserBar.txt +38 -39
- package/mcp-docs/mobile/components/Button.txt +78 -79
- package/mcp-docs/mobile/components/ButtonGroup.txt +10 -11
- package/mcp-docs/mobile/components/Carousel.txt +103 -104
- package/mcp-docs/mobile/components/CartesianChart.txt +107 -108
- package/mcp-docs/mobile/components/CellMedia.txt +15 -16
- package/mcp-docs/mobile/components/Checkbox.txt +35 -36
- package/mcp-docs/mobile/components/CheckboxCell.txt +73 -74
- package/mcp-docs/mobile/components/CheckboxGroup.txt +24 -25
- package/mcp-docs/mobile/components/Chip.txt +67 -68
- package/mcp-docs/mobile/components/Coachmark.txt +42 -43
- package/mcp-docs/mobile/components/Collapsible.txt +15 -16
- package/mcp-docs/mobile/components/ContainedAssetCard.txt +16 -17
- package/mcp-docs/mobile/components/ContentCard.txt +99 -100
- package/mcp-docs/mobile/components/ContentCardBody.txt +23 -24
- package/mcp-docs/mobile/components/ContentCardFooter.txt +19 -20
- package/mcp-docs/mobile/components/ContentCardHeader.txt +33 -34
- package/mcp-docs/mobile/components/ContentCell.txt +102 -103
- package/mcp-docs/mobile/components/ControlGroup.txt +106 -107
- package/mcp-docs/mobile/components/DatePicker.txt +121 -122
- package/mcp-docs/mobile/components/Divider.txt +31 -32
- package/mcp-docs/mobile/components/DotCount.txt +15 -16
- package/mcp-docs/mobile/components/DotStatusColor.txt +12 -13
- package/mcp-docs/mobile/components/DotSymbol.txt +21 -22
- package/mcp-docs/mobile/components/Fallback.txt +49 -50
- package/mcp-docs/mobile/components/FloatingAssetCard.txt +13 -14
- package/mcp-docs/mobile/components/HStack.txt +99 -100
- package/mcp-docs/mobile/components/HeroSquare.txt +11 -12
- package/mcp-docs/mobile/components/Icon.txt +16 -17
- package/mcp-docs/mobile/components/IconButton.txt +104 -105
- package/mcp-docs/mobile/components/InputChip.txt +62 -63
- package/mcp-docs/mobile/components/Interactable.txt +72 -73
- package/mcp-docs/mobile/components/LineChart.txt +117 -118
- package/mcp-docs/mobile/components/Link.txt +113 -114
- package/mcp-docs/mobile/components/ListCell.txt +149 -128
- package/mcp-docs/mobile/components/LogoMark.txt +8 -9
- package/mcp-docs/mobile/components/LogoWordMark.txt +7 -8
- package/mcp-docs/mobile/components/Lottie.txt +39 -40
- package/mcp-docs/mobile/components/LottieStatusAnimation.txt +11 -12
- package/mcp-docs/mobile/components/Modal.txt +36 -37
- package/mcp-docs/mobile/components/ModalBody.txt +5 -6
- package/mcp-docs/mobile/components/ModalFooter.txt +5 -6
- package/mcp-docs/mobile/components/ModalHeader.txt +5 -6
- package/mcp-docs/mobile/components/MultiContentModule.txt +107 -108
- package/mcp-docs/mobile/components/NavigationTitle.txt +13 -14
- package/mcp-docs/mobile/components/NavigationTitleSelect.txt +20 -21
- package/mcp-docs/mobile/components/NudgeCard.txt +20 -21
- package/mcp-docs/mobile/components/Numpad.txt +108 -109
- package/mcp-docs/mobile/components/Overlay.txt +45 -46
- package/mcp-docs/mobile/components/PageFooter.txt +57 -58
- package/mcp-docs/mobile/components/PageHeader.txt +79 -80
- package/mcp-docs/mobile/components/PeriodSelector.txt +98 -99
- package/mcp-docs/mobile/components/Pictogram.txt +11 -12
- package/mcp-docs/mobile/components/Point.txt +21 -22
- package/mcp-docs/mobile/components/PortalProvider.txt +7 -8
- package/mcp-docs/mobile/components/Pressable.txt +67 -68
- package/mcp-docs/mobile/components/ProgressBar.txt +18 -19
- package/mcp-docs/mobile/components/ProgressBarWithFixedLabels.txt +13 -14
- package/mcp-docs/mobile/components/ProgressBarWithFloatLabel.txt +13 -14
- package/mcp-docs/mobile/components/ProgressCircle.txt +22 -23
- package/mcp-docs/mobile/components/Radio.txt +35 -36
- package/mcp-docs/mobile/components/RadioCell.txt +73 -74
- package/mcp-docs/mobile/components/RadioGroup.txt +35 -36
- package/mcp-docs/mobile/components/ReferenceLine.txt +15 -16
- package/mcp-docs/mobile/components/RemoteImage.txt +47 -48
- package/mcp-docs/mobile/components/RemoteImageGroup.txt +11 -12
- package/mcp-docs/mobile/components/RollingNumber.txt +130 -131
- package/mcp-docs/mobile/components/Scrubber.txt +19 -20
- package/mcp-docs/mobile/components/SearchInput.txt +77 -78
- package/mcp-docs/mobile/components/SectionHeader.txt +16 -17
- package/mcp-docs/mobile/components/SegmentedTabs.txt +105 -106
- package/mcp-docs/mobile/components/Select.txt +35 -36
- package/mcp-docs/mobile/components/SelectChip.txt +143 -144
- package/mcp-docs/mobile/components/SelectOption.txt +26 -27
- package/mcp-docs/mobile/components/SlideButton.txt +128 -129
- package/mcp-docs/mobile/components/Spacer.txt +27 -28
- package/mcp-docs/mobile/components/Sparkline.txt +18 -19
- package/mcp-docs/mobile/components/SparklineGradient.txt +18 -19
- package/mcp-docs/mobile/components/SparklineInteractive.txt +37 -38
- package/mcp-docs/mobile/components/SparklineInteractiveHeader.txt +12 -13
- package/mcp-docs/mobile/components/Spinner.txt +15 -16
- package/mcp-docs/mobile/components/SpotIcon.txt +11 -12
- package/mcp-docs/mobile/components/SpotRectangle.txt +11 -12
- package/mcp-docs/mobile/components/SpotSquare.txt +11 -12
- package/mcp-docs/mobile/components/Stepper.txt +113 -114
- package/mcp-docs/mobile/components/SubBrandLogoMark.txt +8 -9
- package/mcp-docs/mobile/components/SubBrandLogoWordMark.txt +8 -9
- package/mcp-docs/mobile/components/Switch.txt +35 -36
- package/mcp-docs/mobile/components/TabIndicator.txt +12 -13
- package/mcp-docs/mobile/components/TabLabel.txt +28 -29
- package/mcp-docs/mobile/components/TabNavigation.txt +41 -42
- package/mcp-docs/mobile/components/TabbedChips.txt +38 -39
- package/mcp-docs/mobile/components/Tabs.txt +76 -77
- package/mcp-docs/mobile/components/Tag.txt +102 -103
- package/mcp-docs/mobile/components/Text.txt +91 -92
- package/mcp-docs/mobile/components/TextInput.txt +107 -108
- package/mcp-docs/mobile/components/ThemeProvider.txt +8 -9
- package/mcp-docs/mobile/components/Toast.txt +82 -83
- package/mcp-docs/mobile/components/Tooltip.txt +20 -21
- package/mcp-docs/mobile/components/TopNavBar.txt +55 -56
- package/mcp-docs/mobile/components/Tour.txt +18 -19
- package/mcp-docs/mobile/components/Tray.txt +43 -44
- package/mcp-docs/mobile/components/UpsellCard.txt +16 -17
- package/mcp-docs/mobile/components/VStack.txt +99 -100
- package/mcp-docs/mobile/components/XAxis.txt +25 -26
- package/mcp-docs/mobile/components/YAxis.txt +26 -27
- package/mcp-docs/mobile/getting-started/{mcp-server.txt → ai-overview.txt} +51 -37
- package/mcp-docs/mobile/getting-started/installation.txt +57 -0
- package/mcp-docs/mobile/getting-started/introduction.txt +3 -0
- package/mcp-docs/mobile/getting-started/playground.txt +3 -0
- package/mcp-docs/mobile/getting-started/styling.txt +84 -0
- package/mcp-docs/mobile/getting-started/theming.txt +286 -0
- package/mcp-docs/mobile/hooks/useDimensions.txt +27 -2
- package/mcp-docs/mobile/hooks/useEventHandler.txt +120 -0
- package/mcp-docs/mobile/hooks/useMergeRefs.txt +116 -0
- package/mcp-docs/mobile/hooks/useOverlayContentContext.txt +67 -2
- package/mcp-docs/mobile/hooks/usePreviousValue.txt +74 -0
- package/mcp-docs/mobile/hooks/useRefMap.txt +178 -0
- package/mcp-docs/mobile/hooks/useTheme.txt +213 -2
- package/mcp-docs/mobile/routes.txt +8 -1
- package/mcp-docs/web/components/Accordion.txt +12 -13
- package/mcp-docs/web/components/AccordionItem.txt +5 -6
- package/mcp-docs/web/components/Alert.txt +24 -25
- package/mcp-docs/web/components/AreaChart.txt +137 -138
- package/mcp-docs/web/components/Avatar.txt +91 -92
- package/mcp-docs/web/components/AvatarButton.txt +113 -114
- package/mcp-docs/web/components/Banner.txt +101 -102
- package/mcp-docs/web/components/BarChart.txt +367 -368
- package/mcp-docs/web/components/Box.txt +65 -66
- package/mcp-docs/web/components/Button.txt +81 -82
- package/mcp-docs/web/components/ButtonGroup.txt +10 -11
- package/mcp-docs/web/components/Calendar.txt +56 -57
- package/mcp-docs/web/components/Carousel.txt +116 -117
- package/mcp-docs/web/components/CartesianChart.txt +357 -358
- package/mcp-docs/web/components/CellMedia.txt +14 -15
- package/mcp-docs/web/components/Checkbox.txt +22 -23
- package/mcp-docs/web/components/CheckboxCell.txt +70 -71
- package/mcp-docs/web/components/CheckboxGroup.txt +15 -16
- package/mcp-docs/web/components/Chip.txt +67 -68
- package/mcp-docs/web/components/Coachmark.txt +69 -70
- package/mcp-docs/web/components/Collapsible.txt +15 -16
- package/mcp-docs/web/components/ContainedAssetCard.txt +108 -109
- package/mcp-docs/web/components/ContentCard.txt +101 -102
- package/mcp-docs/web/components/ContentCardBody.txt +23 -24
- package/mcp-docs/web/components/ContentCardFooter.txt +19 -20
- package/mcp-docs/web/components/ContentCardHeader.txt +33 -34
- package/mcp-docs/web/components/ContentCell.txt +85 -86
- package/mcp-docs/web/components/ControlGroup.txt +108 -109
- package/mcp-docs/web/components/DatePicker.txt +59 -60
- package/mcp-docs/web/components/Divider.txt +31 -32
- package/mcp-docs/web/components/DotCount.txt +17 -18
- package/mcp-docs/web/components/DotStatusColor.txt +12 -13
- package/mcp-docs/web/components/DotSymbol.txt +24 -25
- package/mcp-docs/web/components/Dropdown.txt +31 -32
- package/mcp-docs/web/components/Fallback.txt +49 -50
- package/mcp-docs/web/components/FloatingAssetCard.txt +108 -109
- package/mcp-docs/web/components/FullscreenAlert.txt +20 -21
- package/mcp-docs/web/components/FullscreenModal.txt +28 -29
- package/mcp-docs/web/components/FullscreenModalLayout.txt +19 -20
- package/mcp-docs/web/components/Grid.txt +106 -107
- package/mcp-docs/web/components/GridColumn.txt +96 -97
- package/mcp-docs/web/components/HStack.txt +101 -102
- package/mcp-docs/web/components/HeroSquare.txt +12 -13
- package/mcp-docs/web/components/Icon.txt +27 -28
- package/mcp-docs/web/components/IconButton.txt +117 -118
- package/mcp-docs/web/components/InputChip.txt +62 -63
- package/mcp-docs/web/components/Interactable.txt +75 -76
- package/mcp-docs/web/components/LineChart.txt +366 -367
- package/mcp-docs/web/components/Link.txt +114 -115
- package/mcp-docs/web/components/ListCell.txt +157 -136
- package/mcp-docs/web/components/LogoMark.txt +8 -9
- package/mcp-docs/web/components/LogoWordMark.txt +7 -8
- package/mcp-docs/web/components/Lottie.txt +44 -45
- package/mcp-docs/web/components/LottieStatusAnimation.txt +11 -12
- package/mcp-docs/web/components/MediaQueryProvider.txt +7 -8
- package/mcp-docs/web/components/Modal.txt +69 -66
- package/mcp-docs/web/components/ModalBody.txt +5 -6
- package/mcp-docs/web/components/ModalFooter.txt +5 -6
- package/mcp-docs/web/components/ModalHeader.txt +5 -6
- package/mcp-docs/web/components/MultiContentModule.txt +109 -110
- package/mcp-docs/web/components/NavigationBar.txt +18 -19
- package/mcp-docs/web/components/NavigationTitle.txt +7 -8
- package/mcp-docs/web/components/NavigationTitleSelect.txt +9 -10
- package/mcp-docs/web/components/NudgeCard.txt +61 -62
- package/mcp-docs/web/components/Overlay.txt +57 -58
- package/mcp-docs/web/components/PageFooter.txt +77 -78
- package/mcp-docs/web/components/PageHeader.txt +107 -108
- package/mcp-docs/web/components/Pagination.txt +115 -116
- package/mcp-docs/web/components/PeriodSelector.txt +158 -159
- package/mcp-docs/web/components/Pictogram.txt +13 -14
- package/mcp-docs/web/components/Point.txt +169 -170
- package/mcp-docs/web/components/PortalProvider.txt +6 -7
- package/mcp-docs/web/components/Pressable.txt +73 -74
- package/mcp-docs/web/components/ProgressBar.txt +20 -21
- package/mcp-docs/web/components/ProgressBarWithFixedLabels.txt +15 -16
- package/mcp-docs/web/components/ProgressBarWithFloatLabel.txt +15 -16
- package/mcp-docs/web/components/ProgressCircle.txt +24 -25
- package/mcp-docs/web/components/Radio.txt +22 -23
- package/mcp-docs/web/components/RadioCell.txt +83 -84
- package/mcp-docs/web/components/RadioGroup.txt +22 -23
- package/mcp-docs/web/components/ReferenceLine.txt +22 -23
- package/mcp-docs/web/components/RemoteImage.txt +49 -50
- package/mcp-docs/web/components/RemoteImageGroup.txt +11 -12
- package/mcp-docs/web/components/RollingNumber.txt +131 -132
- package/mcp-docs/web/components/Scrubber.txt +22 -23
- package/mcp-docs/web/components/SearchInput.txt +29 -30
- package/mcp-docs/web/components/SectionHeader.txt +98 -99
- package/mcp-docs/web/components/SegmentedTabs.txt +109 -110
- package/mcp-docs/web/components/Select.txt +22 -23
- package/mcp-docs/web/components/SelectChip.txt +134 -135
- package/mcp-docs/web/components/SelectOption.txt +31 -32
- package/mcp-docs/web/components/Sidebar.txt +109 -110
- package/mcp-docs/web/components/SidebarItem.txt +6 -7
- package/mcp-docs/web/components/SidebarMoreMenu.txt +5 -6
- package/mcp-docs/web/components/Spacer.txt +57 -58
- package/mcp-docs/web/components/Sparkline.txt +18 -19
- package/mcp-docs/web/components/SparklineGradient.txt +18 -19
- package/mcp-docs/web/components/SparklineInteractive.txt +34 -35
- package/mcp-docs/web/components/SparklineInteractiveHeader.txt +12 -13
- package/mcp-docs/web/components/Spinner.txt +15 -16
- package/mcp-docs/web/components/SpotIcon.txt +12 -13
- package/mcp-docs/web/components/SpotRectangle.txt +12 -13
- package/mcp-docs/web/components/SpotSquare.txt +12 -13
- package/mcp-docs/web/components/Stepper.txt +119 -120
- package/mcp-docs/web/components/SubBrandLogoMark.txt +8 -9
- package/mcp-docs/web/components/SubBrandLogoWordMark.txt +8 -9
- package/mcp-docs/web/components/Switch.txt +23 -24
- package/mcp-docs/web/components/TabIndicator.txt +12 -13
- package/mcp-docs/web/components/TabLabel.txt +28 -29
- package/mcp-docs/web/components/TabNavigation.txt +41 -42
- package/mcp-docs/web/components/TabbedChips.txt +38 -39
- package/mcp-docs/web/components/Table.txt +17 -18
- package/mcp-docs/web/components/TableBody.txt +9 -10
- package/mcp-docs/web/components/TableCaption.txt +13 -14
- package/mcp-docs/web/components/TableCell.txt +21 -22
- package/mcp-docs/web/components/TableCellFallback.txt +16 -17
- package/mcp-docs/web/components/TableFooter.txt +9 -10
- package/mcp-docs/web/components/TableHeader.txt +10 -11
- package/mcp-docs/web/components/TableRow.txt +13 -14
- package/mcp-docs/web/components/Tabs.txt +94 -95
- package/mcp-docs/web/components/Tag.txt +106 -107
- package/mcp-docs/web/components/Text.txt +110 -111
- package/mcp-docs/web/components/TextInput.txt +32 -33
- package/mcp-docs/web/components/ThemeProvider.txt +27 -28
- package/mcp-docs/web/components/TileButton.txt +37 -38
- package/mcp-docs/web/components/Toast.txt +82 -83
- package/mcp-docs/web/components/Tooltip.txt +22 -23
- package/mcp-docs/web/components/Tour.txt +21 -22
- package/mcp-docs/web/components/Tray.txt +23 -24
- package/mcp-docs/web/components/UpsellCard.txt +16 -17
- package/mcp-docs/web/components/VStack.txt +101 -102
- package/mcp-docs/web/components/XAxis.txt +25 -26
- package/mcp-docs/web/components/YAxis.txt +26 -27
- package/mcp-docs/web/getting-started/{mcp-server.txt → ai-overview.txt} +51 -37
- package/mcp-docs/web/getting-started/installation.txt +103 -0
- package/mcp-docs/web/getting-started/introduction.txt +3 -0
- package/mcp-docs/web/getting-started/playground.txt +3 -0
- package/mcp-docs/web/getting-started/styling.txt +161 -0
- package/mcp-docs/web/getting-started/templates.txt +121 -0
- package/mcp-docs/web/getting-started/theming.txt +426 -0
- package/mcp-docs/web/hooks/useBreakpoints.txt +30 -2
- package/mcp-docs/web/hooks/useDimensions.txt +61 -2
- package/mcp-docs/web/hooks/useEventHandler.txt +120 -0
- package/mcp-docs/web/hooks/useHasMounted.txt +22 -2
- package/mcp-docs/web/hooks/useIsoEffect.txt +18 -2
- package/mcp-docs/web/hooks/useMediaQuery.txt +22 -2
- package/mcp-docs/web/hooks/useMergeRefs.txt +116 -0
- package/mcp-docs/web/hooks/useOverlayContentContext.txt +64 -2
- package/mcp-docs/web/hooks/usePreviousValue.txt +74 -0
- package/mcp-docs/web/hooks/useRefMap.txt +178 -0
- package/mcp-docs/web/hooks/useScrollBlocker.txt +21 -2
- package/mcp-docs/web/hooks/useTheme.txt +261 -2
- package/mcp-docs/web/routes.txt +9 -1
- package/package.json +1 -1
|
@@ -4,10 +4,122 @@ A pressable Avatar.
|
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
7
|
-
```
|
|
7
|
+
```tsx
|
|
8
8
|
import { AvatarButton } from '@coinbase/cds-web/buttons/AvatarButton'
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
## Examples
|
|
12
|
+
|
|
13
|
+
### Basic Example
|
|
14
|
+
|
|
15
|
+
```jsx live
|
|
16
|
+
<AvatarButton
|
|
17
|
+
src="https://avatars.slack-edge.com/2019-12-09/865473396980_e8c83b072b452e4d03f7_192.jpg"
|
|
18
|
+
accessibilityLabel="Sneezy"
|
|
19
|
+
/>
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Compact
|
|
23
|
+
|
|
24
|
+
AvatarButton can be compact.
|
|
25
|
+
|
|
26
|
+
```jsx live
|
|
27
|
+
<HStack gap={2} alignItems="center">
|
|
28
|
+
<AvatarButton
|
|
29
|
+
src="https://avatars.slack-edge.com/2019-12-09/865473396980_e8c83b072b452e4d03f7_192.jpg"
|
|
30
|
+
accessibilityLabel="Sneezy"
|
|
31
|
+
/>
|
|
32
|
+
<AvatarButton
|
|
33
|
+
src="https://avatars.slack-edge.com/2019-12-09/865473396980_e8c83b072b452e4d03f7_192.jpg"
|
|
34
|
+
compact
|
|
35
|
+
accessibilityLabel="Sneezy Compact"
|
|
36
|
+
/>
|
|
37
|
+
</HStack>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Shapes
|
|
41
|
+
|
|
42
|
+
AvatarButton supports three different shapes: `circle`, `square`, and `hexagon`. The default shape is `circle`.
|
|
43
|
+
|
|
44
|
+
```jsx live
|
|
45
|
+
<HStack gap={2} alignItems="center">
|
|
46
|
+
<AvatarButton name="Alice" colorScheme="blue" shape="circle" accessibilityLabel="Alice Profile" />
|
|
47
|
+
<AvatarButton name="Bob" colorScheme="purple" shape="square" accessibilityLabel="Bob Profile" />
|
|
48
|
+
<AvatarButton
|
|
49
|
+
name="Charlie"
|
|
50
|
+
colorScheme="green"
|
|
51
|
+
shape="hexagon"
|
|
52
|
+
accessibilityLabel="Charlie Profile"
|
|
53
|
+
/>
|
|
54
|
+
</HStack>
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Selected State
|
|
58
|
+
|
|
59
|
+
AvatarButtons can show a selected state with a border indicator.
|
|
60
|
+
|
|
61
|
+
```jsx live
|
|
62
|
+
<HStack gap={2}>
|
|
63
|
+
<AvatarButton name="Alice" colorScheme="blue" accessibilityLabel="Alice Profile" />
|
|
64
|
+
<AvatarButton
|
|
65
|
+
name="Alice"
|
|
66
|
+
colorScheme="blue"
|
|
67
|
+
selected
|
|
68
|
+
accessibilityLabel="Alice Profile Selected"
|
|
69
|
+
/>
|
|
70
|
+
<AvatarButton name="Bob" colorScheme="purple" shape="square" accessibilityLabel="Bob Profile" />
|
|
71
|
+
<AvatarButton
|
|
72
|
+
name="Bob"
|
|
73
|
+
colorScheme="purple"
|
|
74
|
+
shape="square"
|
|
75
|
+
selected
|
|
76
|
+
accessibilityLabel="Bob Profile Selected"
|
|
77
|
+
/>
|
|
78
|
+
</HStack>
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Loading State
|
|
82
|
+
|
|
83
|
+
AvatarButtons can show a loading state while content is being fetched.
|
|
84
|
+
|
|
85
|
+
```jsx live
|
|
86
|
+
<HStack gap={2}>
|
|
87
|
+
<AvatarButton name="Alice" colorScheme="blue" accessibilityLabel="Alice Profile" />
|
|
88
|
+
<AvatarButton
|
|
89
|
+
name="Alice"
|
|
90
|
+
colorScheme="blue"
|
|
91
|
+
loading
|
|
92
|
+
accessibilityLabel="Alice Profile Loading"
|
|
93
|
+
/>
|
|
94
|
+
</HStack>
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Fallback Image
|
|
98
|
+
|
|
99
|
+
If you do not provide a src or if the provided src does not resolve, AvatarButton will surface a placeholder image.
|
|
100
|
+
|
|
101
|
+
```jsx live
|
|
102
|
+
<HStack gap={2} alignItems="center">
|
|
103
|
+
<AvatarButton accessibilityLabel="Default Avatar" />
|
|
104
|
+
<AvatarButton selected accessibilityLabel="Default Avatar Selected" />
|
|
105
|
+
</HStack>
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Fallback with Colors
|
|
109
|
+
|
|
110
|
+
AvatarButton can use fallback colors with names when no image source is provided.
|
|
111
|
+
|
|
112
|
+
```jsx live
|
|
113
|
+
<HStack gap={2} alignItems="center">
|
|
114
|
+
<AvatarButton name="Alice" colorScheme="blue" accessibilityLabel="Alice Profile" />
|
|
115
|
+
<AvatarButton name="Bob" colorScheme="purple" accessibilityLabel="Bob Profile" />
|
|
116
|
+
<AvatarButton name="Charlie" colorScheme="green" accessibilityLabel="Charlie Profile" />
|
|
117
|
+
<AvatarButton name="Diana" colorScheme="teal" accessibilityLabel="Diana Profile" />
|
|
118
|
+
<AvatarButton name="Eve" colorScheme="pink" accessibilityLabel="Eve Profile" />
|
|
119
|
+
<AvatarButton name="Frank" colorScheme="gray" accessibilityLabel="Frank Profile" />
|
|
120
|
+
</HStack>
|
|
121
|
+
```
|
|
122
|
+
|
|
11
123
|
## Props
|
|
12
124
|
|
|
13
125
|
| Prop | Type | Required | Default | Description |
|
|
@@ -126,116 +238,3 @@ import { AvatarButton } from '@coinbase/cds-web/buttons/AvatarButton'
|
|
|
126
238
|
| `zIndex` | `-moz-initial \| inherit \| initial \| revert \| revert-layer \| unset \| auto` | No | `-` | - |
|
|
127
239
|
|
|
128
240
|
|
|
129
|
-
## Examples
|
|
130
|
-
|
|
131
|
-
### Basic Example
|
|
132
|
-
|
|
133
|
-
```jsx live
|
|
134
|
-
<AvatarButton
|
|
135
|
-
src="https://avatars.slack-edge.com/2019-12-09/865473396980_e8c83b072b452e4d03f7_192.jpg"
|
|
136
|
-
accessibilityLabel="Sneezy"
|
|
137
|
-
/>
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
### Compact
|
|
141
|
-
|
|
142
|
-
AvatarButton can be compact.
|
|
143
|
-
|
|
144
|
-
```jsx live
|
|
145
|
-
<HStack gap={2} alignItems="center">
|
|
146
|
-
<AvatarButton
|
|
147
|
-
src="https://avatars.slack-edge.com/2019-12-09/865473396980_e8c83b072b452e4d03f7_192.jpg"
|
|
148
|
-
accessibilityLabel="Sneezy"
|
|
149
|
-
/>
|
|
150
|
-
<AvatarButton
|
|
151
|
-
src="https://avatars.slack-edge.com/2019-12-09/865473396980_e8c83b072b452e4d03f7_192.jpg"
|
|
152
|
-
compact
|
|
153
|
-
accessibilityLabel="Sneezy Compact"
|
|
154
|
-
/>
|
|
155
|
-
</HStack>
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### Shapes
|
|
159
|
-
|
|
160
|
-
AvatarButton supports three different shapes: `circle`, `square`, and `hexagon`. The default shape is `circle`.
|
|
161
|
-
|
|
162
|
-
```jsx live
|
|
163
|
-
<HStack gap={2} alignItems="center">
|
|
164
|
-
<AvatarButton name="Alice" colorScheme="blue" shape="circle" accessibilityLabel="Alice Profile" />
|
|
165
|
-
<AvatarButton name="Bob" colorScheme="purple" shape="square" accessibilityLabel="Bob Profile" />
|
|
166
|
-
<AvatarButton
|
|
167
|
-
name="Charlie"
|
|
168
|
-
colorScheme="green"
|
|
169
|
-
shape="hexagon"
|
|
170
|
-
accessibilityLabel="Charlie Profile"
|
|
171
|
-
/>
|
|
172
|
-
</HStack>
|
|
173
|
-
```
|
|
174
|
-
|
|
175
|
-
### Selected State
|
|
176
|
-
|
|
177
|
-
AvatarButtons can show a selected state with a border indicator.
|
|
178
|
-
|
|
179
|
-
```jsx live
|
|
180
|
-
<HStack gap={2}>
|
|
181
|
-
<AvatarButton name="Alice" colorScheme="blue" accessibilityLabel="Alice Profile" />
|
|
182
|
-
<AvatarButton
|
|
183
|
-
name="Alice"
|
|
184
|
-
colorScheme="blue"
|
|
185
|
-
selected
|
|
186
|
-
accessibilityLabel="Alice Profile Selected"
|
|
187
|
-
/>
|
|
188
|
-
<AvatarButton name="Bob" colorScheme="purple" shape="square" accessibilityLabel="Bob Profile" />
|
|
189
|
-
<AvatarButton
|
|
190
|
-
name="Bob"
|
|
191
|
-
colorScheme="purple"
|
|
192
|
-
shape="square"
|
|
193
|
-
selected
|
|
194
|
-
accessibilityLabel="Bob Profile Selected"
|
|
195
|
-
/>
|
|
196
|
-
</HStack>
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
### Loading State
|
|
200
|
-
|
|
201
|
-
AvatarButtons can show a loading state while content is being fetched.
|
|
202
|
-
|
|
203
|
-
```jsx live
|
|
204
|
-
<HStack gap={2}>
|
|
205
|
-
<AvatarButton name="Alice" colorScheme="blue" accessibilityLabel="Alice Profile" />
|
|
206
|
-
<AvatarButton
|
|
207
|
-
name="Alice"
|
|
208
|
-
colorScheme="blue"
|
|
209
|
-
loading
|
|
210
|
-
accessibilityLabel="Alice Profile Loading"
|
|
211
|
-
/>
|
|
212
|
-
</HStack>
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
### Fallback Image
|
|
216
|
-
|
|
217
|
-
If you do not provide a src or if the provided src does not resolve, AvatarButton will surface a placeholder image.
|
|
218
|
-
|
|
219
|
-
```jsx live
|
|
220
|
-
<HStack gap={2} alignItems="center">
|
|
221
|
-
<AvatarButton accessibilityLabel="Default Avatar" />
|
|
222
|
-
<AvatarButton selected accessibilityLabel="Default Avatar Selected" />
|
|
223
|
-
</HStack>
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
### Fallback with Colors
|
|
227
|
-
|
|
228
|
-
AvatarButton can use fallback colors with names when no image source is provided.
|
|
229
|
-
|
|
230
|
-
```jsx live
|
|
231
|
-
<HStack gap={2} alignItems="center">
|
|
232
|
-
<AvatarButton name="Alice" colorScheme="blue" accessibilityLabel="Alice Profile" />
|
|
233
|
-
<AvatarButton name="Bob" colorScheme="purple" accessibilityLabel="Bob Profile" />
|
|
234
|
-
<AvatarButton name="Charlie" colorScheme="green" accessibilityLabel="Charlie Profile" />
|
|
235
|
-
<AvatarButton name="Diana" colorScheme="teal" accessibilityLabel="Diana Profile" />
|
|
236
|
-
<AvatarButton name="Eve" colorScheme="pink" accessibilityLabel="Eve Profile" />
|
|
237
|
-
<AvatarButton name="Frank" colorScheme="gray" accessibilityLabel="Frank Profile" />
|
|
238
|
-
</HStack>
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
|
|
@@ -4,15 +4,114 @@ Displays important messages and actions to users.
|
|
|
4
4
|
|
|
5
5
|
## Import
|
|
6
6
|
|
|
7
|
-
```
|
|
7
|
+
```tsx
|
|
8
8
|
import { Banner } from '@coinbase/cds-web/banner/Banner'
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
## Examples
|
|
12
|
+
|
|
13
|
+
### Global Warning Banner
|
|
14
|
+
|
|
15
|
+
The global warning banner is used to communicate important alerts or warnings to users across the entire platform, ensuring universal visibility and building trust.
|
|
16
|
+
|
|
17
|
+
```jsx live
|
|
18
|
+
<Banner
|
|
19
|
+
showDismiss
|
|
20
|
+
label="Message last updated today at 3:33pm"
|
|
21
|
+
startIcon="warning"
|
|
22
|
+
startIconActive
|
|
23
|
+
styleVariant="global"
|
|
24
|
+
title="Some features are temporarily unavailable"
|
|
25
|
+
variant="warning"
|
|
26
|
+
primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
|
|
27
|
+
secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
|
|
28
|
+
>
|
|
29
|
+
<TextLabel2 as="p">
|
|
30
|
+
Your funds are safe. We’re looking into it and expect our usual service to return soon.
|
|
31
|
+
<Link to="https://www.coinbase.com">Learn more</Link>
|
|
32
|
+
</TextLabel2>
|
|
33
|
+
</Banner>
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### In-line Error Banner
|
|
37
|
+
|
|
38
|
+
The In-line Error Banner is used to display specific error messages directly beneath the relevant section headers. Use in-line banners to help users identify exactly where the error or outage is located.
|
|
39
|
+
|
|
40
|
+
```jsx live
|
|
41
|
+
<Banner
|
|
42
|
+
startIcon="info"
|
|
43
|
+
startIconActive
|
|
44
|
+
styleVariant="inline"
|
|
45
|
+
title="Some features are temporarily unavailable"
|
|
46
|
+
variant="error"
|
|
47
|
+
primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
|
|
48
|
+
secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
|
|
49
|
+
>
|
|
50
|
+
<TextLabel2 as="p">
|
|
51
|
+
Your funds are safe. We’re looking into it and expect our usual service to return soon.
|
|
52
|
+
<Link to="https://www.coinbase.com">Learn more</Link>
|
|
53
|
+
</TextLabel2>
|
|
54
|
+
</Banner>
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Contextual Promotional Banner
|
|
58
|
+
|
|
59
|
+
The Contextual Promotional Banner is used to highlight special offers, promotions, or announcements within a specific context or section of the platform. It is used to increase user engagement and drive conversions.
|
|
60
|
+
|
|
61
|
+
```jsx live
|
|
62
|
+
<Banner
|
|
63
|
+
startIcon="info"
|
|
64
|
+
startIconActive
|
|
65
|
+
styleVariant="contextual"
|
|
66
|
+
title="Some features are temporarily unavailable"
|
|
67
|
+
variant="promotional"
|
|
68
|
+
>
|
|
69
|
+
<TextLabel2 as="p">
|
|
70
|
+
Your funds are safe. We’re looking into it and expect our usual service to return soon.
|
|
71
|
+
<Link to="https://www.coinbase.com">Learn more</Link>
|
|
72
|
+
</TextLabel2>
|
|
73
|
+
</Banner>
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### In-line Informational Banner
|
|
77
|
+
|
|
78
|
+
The in-line Informational Banner is used to provide users with additional information or helpful tips directly within the content or interface, providing relevant guidance.
|
|
79
|
+
|
|
80
|
+
```jsx live
|
|
81
|
+
<VStack gap={2}>
|
|
82
|
+
<Banner
|
|
83
|
+
startIcon="info"
|
|
84
|
+
startIconActive
|
|
85
|
+
styleVariant="inline"
|
|
86
|
+
title="Some features are temporarily unavailable"
|
|
87
|
+
variant="informational"
|
|
88
|
+
primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
|
|
89
|
+
secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
|
|
90
|
+
>
|
|
91
|
+
<TextLabel2 as="p">
|
|
92
|
+
Your funds are safe. We’re looking into it and expect our usual service to return soon.
|
|
93
|
+
<Link to="https://www.coinbase.com">Learn more</Link>
|
|
94
|
+
</TextLabel2>
|
|
95
|
+
</Banner>
|
|
96
|
+
<Banner
|
|
97
|
+
startIcon="warning"
|
|
98
|
+
startIconActive
|
|
99
|
+
styleVariant="inline"
|
|
100
|
+
title="Some features are temporarily unavailable"
|
|
101
|
+
variant="warning"
|
|
102
|
+
>
|
|
103
|
+
<TextLabel2 as="p">
|
|
104
|
+
<Link to="https://www.coinbase.com">Retry</Link>
|
|
105
|
+
</TextLabel2>
|
|
106
|
+
</Banner>
|
|
107
|
+
</VStack>
|
|
108
|
+
```
|
|
109
|
+
|
|
11
110
|
## Props
|
|
12
111
|
|
|
13
112
|
| Prop | Type | Required | Default | Description |
|
|
14
113
|
| --- | --- | --- | --- | --- |
|
|
15
|
-
| `startIcon` | `key \| search \| pin \| filter \| visible \| continuous \| auto \| warning \| error \| account \| activity \| add \| addPeople \| advancedMarketSelector \| advancedTradeProduct \| affiliates \| airdrop \| allTimeHigh \| allocation \| annotation \| api \| apiPlug \| appSwitcher \| appleLogo \| application \| arrowDown \| arrowLeft \| arrowRight \| arrowUp \| arrowsHorizontal \| arrowsVertical \| artwork \| assetHubProduct \| assetManagementProduct \| astronautHelmet \| avatar \| average \| backArrow \| bank \| barChartWindow \| base \| baseApps \| baseFeed \| baseNotification \| baseSquare \| baseTransact \| baseVerification \| baseWallet \| beaker \| beginningArrow \| bell \| bellCheck \| bellPlus \| block \| blockchain \| blog \| book \| bookmark \| borrowProduct \| bridging \| briefcase \| browser \| calculator \| calendar \| calendarEmpty \| camera \| candlesticks \| car \| card \| caret \| caretDown \| caretLeft \| caretRight \| caretUp \| cash \| cashAustralianDollar \| cashBrazilianReal \| cashBrazillianReal \| cashCanadianDollar \| cashCoins \| cashEUR \| cashGBP \| cashIndonesianRupiah \| cashJPY \| cashPhilippinePeso \| cashPolishZloty \| cashRupee \| cashSingaporeDollar \| cashSwissFranc \| cashThaiBaht \| cashTurkishLira \| cashUSD \| cashUaeDirham \| cashVietnameseDong \| chainLink \| chartBar \| chartCandles \| chartLine \| chartPie \| chartPieCircle \| chartVolume \| chatBotAgent \| chatBubble \| chatRequests \| checkboxChecked \| checkboxEmpty \| checkmark \| circleCheckmark \| circleCross \| circulatingSupply \| clipboard \| clock \| clockOutline \| close \| closeCaption \| clothing \| cloud \| cloudProduct \| cluster \| coinbase \| coinbaseCardProduct \| coinbaseOne \| coinbaseOneCard \| coinbaseOneLogo \| coinbaseRewards \| collapse \| collectibles \| collection \| comment \| commentPlus \| commerceProduct \| compass \| complianceProduct \| compose \| concierge \| conciergeBell \| config \| convert \| copy \| creatorCoin \| cross \| crossTrade \| crypto \| cryptobasics \| crystalBall \| currencies \| custodyProduct \| dashboard \| dataMarketplaceProduct \| dataStack \| defi \| delegateProduct \| deposit \| derivatives \| derivativesProduct \| derivativesProductNew \| developerAPIProduct \| developerPlatformProduct \| dex \| diagonalDownArrow \| diagonalRightArrow \| diagonalUpArrow \| diamond \| diamondIncentives \| dinnerPlate \| directDeposit \| directDepositIcon \| disabledPhone \| discordLogo \| distribution \| document \| documentation \| dot \| doubleChevronRight \| downArrow \| download \| drag \| drops \| earn \| earnProduct \| earnRewards \| email \| endArrow \| ethereum \| eventContracts \| exchangeProduct \| exclamationMark \| expand \| expandAddress \| expandAll \| externalLink \| eye \| faceScan \| faces \| faucet \| fib \| fingerprint \| flame \| folder \| folderArrow \| folderOpen \| followAdd \| following \| fork \| forwardArrow \| fscsProtection \| gab \| games \| gasFees \| gauge \| gaugeEmpty \| gaugeHigh \| gaugeHighLow \| gaugeHighMid \| gaugeLow \| gaugeLowHigh \| gaugeLowMid \| gaugeMedium \| gavel \| gear \| generalCharacter \| ghost \| gif \| giftBox \| giftCard \| gitHubLogo \| globe \| googleLogo \| grid \| group \| hamburger \| hammer \| heart \| helpCenterProduct \| helpCenterQuestionMark \| hiddenEye \| home \| horizontalLine \| ideal \| identityCard \| image \| info \| initiator \| instagramLogo \| instantUnstakingClock \| institute \| institutionalProduct \| interest \| invisible \| invoice \| keyboard \| laptop \| leadChart \| leadCoin \| learningRewardsProduct \| light \| lightbulb \| lightningBolt \| lineChartCrypto \| list \| location \| lock \| login \| logout \| magnifyingGlass \| marketCap \| megaphone \| menu \| metaverse \| microphone \| mint \| minus \| moon \| more \| moreVertical \| music \| newsFeed \| newsletter \| nft \| nftBuy \| nftOffer \| nftProduct \| nftSale \| noRocket \| noWifi \| nodeProduct \| options \| orderBook \| orderHistory \| outline \| pFPS \| paperAirplane \| paperclip \| participate \| participateProduct \| passKey \| passport \| pause \| pay \| payProduct \| paymentCard \| payments \| payouts \| paypal \| pencil \| peopleGroup \| peopleStar \| percentage \| perpetualSwap \| phone \| plane \| planet \| play \| plusMinus \| powerTool \| priceAlerts \| priceAlertsCheck \| primePoduct \| privateClientProduct \| proProduct \| profile \| protection \| pulse \| pyramid \| qrCode \| qrCodeAlt \| queryTransact \| questionMark \| reCenter \| rectangle \| recurring \| refresh \| regulated \| regulatedFutures \| report \| rewardsProduct \| rocket \| rocketShip \| rollingSpot \| rosettaProduct \| royalty \| safe \| save \| savingsBank \| scanQrCode \| securityKey \| securityShield \| seen \| sendReceive \| setPinCode \| settings \| share \| shield \| shieldOutline \| shoppingCart \| signinProduct \| smartContract \| socialChat \| socialReshare \| socialShare \| sofort \| sortDoubleArrow \| sortDown \| sortDownCenter \| sortUp \| sortUpCenter \| soundOff \| soundOn \| sparkle \| speaker \| staggeredList \| stake \| staking \| star \| statusDot \| step0 \| step1 \| step2 \| step3 \| step4 \| step5 \| step6 \| step7 \| step8 \| step9 \| sun \| support \| tag \| taxes \| taxesReceipt \| telephone \| thumbsDown \| thumbsDownOutline \| thumbsUp \| thumbsUpOutline \| trading \| transactions \| trashCan \| trophy \| trophyCup \| twitterLogo \| ultility \| undo \| unknown \| unlock \| upArrow \| upload \| venturesProduct \| verifiedBadge \| verifiedPools \| verticalLine \| waasProduct \| wallet \| walletLogo \| walletProduct \| wellness \| wifi \| wireTransfer \| withdraw \| wrapToken \| xLogo` | Yes | `-` | Name of icon to be shown in the banner |
|
|
114
|
+
| `startIcon` | `key \| search \| pin \| filter \| visible \| continuous \| auto \| warning \| error \| account \| activity \| add \| addPeople \| advancedMarketSelector \| advancedTradeProduct \| affiliates \| airdrop \| allTimeHigh \| allocation \| annotation \| api \| apiPlug \| appSwitcher \| appleLogo \| application \| arrowDown \| arrowLeft \| arrowRight \| arrowUp \| arrowsHorizontal \| arrowsVertical \| artwork \| assetHubProduct \| assetManagementProduct \| astronautHelmet \| avatar \| average \| backArrow \| bank \| barChartWindow \| base \| baseApps \| baseFeed \| baseNotification \| baseSquare \| baseTransact \| baseVerification \| baseWallet \| beaker \| beginningArrow \| bell \| bellCheck \| bellPlus \| block \| blockchain \| blog \| book \| bookmark \| borrowProduct \| bridging \| briefcase \| browser \| calculator \| calendar \| calendarEmpty \| camera \| candlesticks \| car \| card \| caret \| caretDown \| caretLeft \| caretRight \| caretUp \| cash \| cashAustralianDollar \| cashBrazilianReal \| cashBrazillianReal \| cashCanadianDollar \| cashCoins \| cashEUR \| cashGBP \| cashIndonesianRupiah \| cashJPY \| cashPhilippinePeso \| cashPolishZloty \| cashRupee \| cashSingaporeDollar \| cashSwissFranc \| cashThaiBaht \| cashTurkishLira \| cashUSD \| cashUaeDirham \| cashVietnameseDong \| chainLink \| chartBar \| chartCandles \| chartLine \| chartPie \| chartPieCircle \| chartVolume \| chatBotAgent \| chatBubble \| chatRequests \| checkboxChecked \| checkboxEmpty \| checkmark \| circleCheckmark \| circleCross \| circulatingSupply \| clipboard \| clock \| clockOutline \| close \| closeCaption \| clothing \| cloud \| cloudProduct \| cluster \| coinbase \| coinbaseCardProduct \| coinbaseOne \| coinbaseOneCard \| coinbaseOneLogo \| coinbaseRewards \| collapse \| collectibles \| collection \| comment \| commentPlus \| commerceProduct \| compass \| complianceProduct \| compose \| concierge \| conciergeBell \| config \| convert \| copy \| creatorCoin \| cross \| crossTrade \| crypto \| cryptobasics \| crystalBall \| currencies \| custodyProduct \| dashboard \| dataMarketplaceProduct \| dataStack \| defi \| delegateProduct \| deposit \| derivatives \| derivativesProduct \| derivativesProductNew \| developerAPIProduct \| developerPlatformProduct \| dex \| diagonalDownArrow \| diagonalRightArrow \| diagonalUpArrow \| diamond \| diamondIncentives \| dinnerPlate \| directDeposit \| directDepositIcon \| disabledPhone \| discordLogo \| distribution \| document \| documentation \| dot \| doubleChevronRight \| downArrow \| download \| drag \| drops \| earn \| earnProduct \| earnRewards \| email \| endArrow \| ethereum \| eventContracts \| exchangeProduct \| exclamationMark \| expand \| expandAddress \| expandAll \| externalLink \| eye \| faceScan \| faces \| faucet \| fib \| fingerprint \| flame \| folder \| folderArrow \| folderOpen \| followAdd \| following \| fork \| forwardArrow \| fscsProtection \| gab \| games \| gasFees \| gauge \| gaugeEmpty \| gaugeHigh \| gaugeHighLow \| gaugeHighMid \| gaugeLow \| gaugeLowHigh \| gaugeLowMid \| gaugeMedium \| gavel \| gear \| generalCharacter \| ghost \| gif \| giftBox \| giftCard \| gitHubLogo \| globe \| googleLogo \| grid \| group \| hamburger \| hammer \| heart \| helpCenterProduct \| helpCenterQuestionMark \| hiddenEye \| home \| horizontalLine \| ideal \| identityCard \| image \| info \| initiator \| instagramLogo \| instantUnstakingClock \| institute \| institutionalProduct \| interest \| invisible \| invoice \| keyboard \| laptop \| leadChart \| leadCoin \| learningRewardsProduct \| light \| lightbulb \| lightningBolt \| lineChartCrypto \| list \| location \| lock \| login \| logout \| magnifyingGlass \| marketCap \| megaphone \| menu \| metaverse \| microphone \| mint \| minus \| moon \| more \| moreVertical \| music \| newsFeed \| newsletter \| nft \| nftBuy \| nftOffer \| nftProduct \| nftSale \| noRocket \| noWifi \| nodeProduct \| options \| orderBook \| orderHistory \| outline \| pFPS \| paperAirplane \| paperclip \| participate \| participateProduct \| passKey \| passport \| pause \| pay \| payProduct \| paymentCard \| payments \| payouts \| paypal \| pencil \| peopleGroup \| peopleStar \| percentage \| perpetualSwap \| phone \| plane \| planet \| play \| plusMinus \| powerTool \| priceAlerts \| priceAlertsCheck \| primePoduct \| privateClientProduct \| proProduct \| profile \| protection \| pulse \| pyramid \| qrCode \| qrCodeAlt \| queryTransact \| questionMark \| reCenter \| rectangle \| recurring \| refresh \| regulated \| regulatedFutures \| report \| rewardsProduct \| rocket \| rocketShip \| rollingSpot \| rosettaProduct \| royalty \| safe \| save \| savingsBank \| scanQrCode \| securityKey \| securityShield \| seen \| sendReceive \| setPinCode \| settings \| share \| shield \| shieldOutline \| shoppingCart \| signinProduct \| smartContract \| socialChat \| socialReshare \| socialShare \| sofort \| sortDoubleArrow \| sortDown \| sortDownCenter \| sortUp \| sortUpCenter \| soundOff \| soundOn \| sparkle \| speaker \| staggeredList \| stake \| staking \| star \| statusDot \| step0 \| step1 \| step2 \| step3 \| step4 \| step5 \| step6 \| step7 \| step8 \| step9 \| sun \| support \| tag \| taxes \| taxesReceipt \| telephone \| thumbsDown \| thumbsDownOutline \| thumbsUp \| thumbsUpOutline \| tokenSales \| trading \| transactions \| trashCan \| trophy \| trophyCup \| twitterLogo \| ultility \| undo \| unfollowPeople \| unknown \| unlock \| upArrow \| upload \| venturesProduct \| verifiedBadge \| verifiedPools \| verticalLine \| waasProduct \| wallet \| walletLogo \| walletProduct \| wellness \| wifi \| wireTransfer \| withdraw \| wrapToken \| xLogo` | Yes | `-` | Name of icon to be shown in the banner |
|
|
16
115
|
| `variant` | `warning \| promotional \| informational \| error` | Yes | `-` | Sets the variant of the banner - which is responsible for foreground and background color assignment |
|
|
17
116
|
| `alignContent` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| stretch \| baseline \| first baseline \| last baseline \| space-between \| space-around \| space-evenly>` | No | `-` | - |
|
|
18
117
|
| `alignItems` | `ResponsiveProp<center \| normal \| start \| end \| flex-start \| flex-end \| self-start \| self-end \| stretch \| baseline \| first baseline \| last baseline>` | No | `-` | - |
|
|
@@ -125,103 +224,3 @@ import { Banner } from '@coinbase/cds-web/banner/Banner'
|
|
|
125
224
|
| `zIndex` | `-moz-initial \| inherit \| initial \| revert \| revert-layer \| unset \| auto` | No | `-` | - |
|
|
126
225
|
|
|
127
226
|
|
|
128
|
-
## Examples
|
|
129
|
-
|
|
130
|
-
### Global Warning Banner
|
|
131
|
-
|
|
132
|
-
The global warning banner is used to communicate important alerts or warnings to users across the entire platform, ensuring universal visibility and building trust.
|
|
133
|
-
|
|
134
|
-
```jsx live
|
|
135
|
-
<Banner
|
|
136
|
-
showDismiss
|
|
137
|
-
label="Message last updated today at 3:33pm"
|
|
138
|
-
startIcon="warning"
|
|
139
|
-
startIconActive
|
|
140
|
-
styleVariant="global"
|
|
141
|
-
title="Some features are temporarily unavailable"
|
|
142
|
-
variant="warning"
|
|
143
|
-
primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
|
|
144
|
-
secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
|
|
145
|
-
>
|
|
146
|
-
<TextLabel2 as="p">
|
|
147
|
-
Your funds are safe. We’re looking into it and expect our usual service to return soon.
|
|
148
|
-
<Link to="https://www.coinbase.com">Learn more</Link>
|
|
149
|
-
</TextLabel2>
|
|
150
|
-
</Banner>
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
### In-line Error Banner
|
|
154
|
-
|
|
155
|
-
The In-line Error Banner is used to display specific error messages directly beneath the relevant section headers. Use in-line banners to help users identify exactly where the error or outage is located.
|
|
156
|
-
|
|
157
|
-
```jsx live
|
|
158
|
-
<Banner
|
|
159
|
-
startIcon="info"
|
|
160
|
-
startIconActive
|
|
161
|
-
styleVariant="inline"
|
|
162
|
-
title="Some features are temporarily unavailable"
|
|
163
|
-
variant="error"
|
|
164
|
-
primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
|
|
165
|
-
secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
|
|
166
|
-
>
|
|
167
|
-
<TextLabel2 as="p">
|
|
168
|
-
Your funds are safe. We’re looking into it and expect our usual service to return soon.
|
|
169
|
-
<Link to="https://www.coinbase.com">Learn more</Link>
|
|
170
|
-
</TextLabel2>
|
|
171
|
-
</Banner>
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
### Contextual Promotional Banner
|
|
175
|
-
|
|
176
|
-
The Contextual Promotional Banner is used to highlight special offers, promotions, or announcements within a specific context or section of the platform. It is used to increase user engagement and drive conversions.
|
|
177
|
-
|
|
178
|
-
```jsx live
|
|
179
|
-
<Banner
|
|
180
|
-
startIcon="info"
|
|
181
|
-
startIconActive
|
|
182
|
-
styleVariant="contextual"
|
|
183
|
-
title="Some features are temporarily unavailable"
|
|
184
|
-
variant="promotional"
|
|
185
|
-
>
|
|
186
|
-
<TextLabel2 as="p">
|
|
187
|
-
Your funds are safe. We’re looking into it and expect our usual service to return soon.
|
|
188
|
-
<Link to="https://www.coinbase.com">Learn more</Link>
|
|
189
|
-
</TextLabel2>
|
|
190
|
-
</Banner>
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
### In-line Informational Banner
|
|
194
|
-
|
|
195
|
-
The in-line Informational Banner is used to provide users with additional information or helpful tips directly within the content or interface, providing relevant guidance.
|
|
196
|
-
|
|
197
|
-
```jsx live
|
|
198
|
-
<VStack gap={2}>
|
|
199
|
-
<Banner
|
|
200
|
-
startIcon="info"
|
|
201
|
-
startIconActive
|
|
202
|
-
styleVariant="inline"
|
|
203
|
-
title="Some features are temporarily unavailable"
|
|
204
|
-
variant="informational"
|
|
205
|
-
primaryAction={<Link to="https://www.coinbase.com">Primary</Link>}
|
|
206
|
-
secondaryAction={<Link to="https://www.coinbase.com">Secondary</Link>}
|
|
207
|
-
>
|
|
208
|
-
<TextLabel2 as="p">
|
|
209
|
-
Your funds are safe. We’re looking into it and expect our usual service to return soon.
|
|
210
|
-
<Link to="https://www.coinbase.com">Learn more</Link>
|
|
211
|
-
</TextLabel2>
|
|
212
|
-
</Banner>
|
|
213
|
-
<Banner
|
|
214
|
-
startIcon="warning"
|
|
215
|
-
startIconActive
|
|
216
|
-
styleVariant="inline"
|
|
217
|
-
title="Some features are temporarily unavailable"
|
|
218
|
-
variant="warning"
|
|
219
|
-
>
|
|
220
|
-
<TextLabel2 as="p">
|
|
221
|
-
<Link to="https://www.coinbase.com">Retry</Link>
|
|
222
|
-
</TextLabel2>
|
|
223
|
-
</Banner>
|
|
224
|
-
</VStack>
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
|