@coinbase/cds-mcp-server 8.17.2 → 8.17.3

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.
Files changed (269) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/mcp-docs/mobile/components/Accordion.txt +189 -0
  3. package/mcp-docs/mobile/components/AccordionItem.txt +30 -0
  4. package/mcp-docs/mobile/components/Alert.txt +156 -0
  5. package/mcp-docs/mobile/components/AreaChart.txt +266 -0
  6. package/mcp-docs/mobile/components/Avatar.txt +196 -0
  7. package/mcp-docs/mobile/components/AvatarButton.txt +226 -0
  8. package/mcp-docs/mobile/components/Banner.txt +222 -0
  9. package/mcp-docs/mobile/components/BarChart.txt +816 -0
  10. package/mcp-docs/mobile/components/Box.txt +174 -0
  11. package/mcp-docs/mobile/components/BrowserBar.txt +147 -0
  12. package/mcp-docs/mobile/components/Button.txt +199 -0
  13. package/mcp-docs/mobile/components/ButtonGroup.txt +80 -0
  14. package/mcp-docs/mobile/components/Carousel.txt +1084 -0
  15. package/mcp-docs/mobile/components/CartesianChart.txt +826 -0
  16. package/mcp-docs/mobile/components/CellMedia.txt +71 -0
  17. package/mcp-docs/mobile/components/Checkbox.txt +246 -0
  18. package/mcp-docs/mobile/components/CheckboxCell.txt +202 -0
  19. package/mcp-docs/mobile/components/CheckboxGroup.txt +285 -0
  20. package/mcp-docs/mobile/components/Chip.txt +195 -0
  21. package/mcp-docs/mobile/components/Coachmark.txt +158 -0
  22. package/mcp-docs/mobile/components/Collapsible.txt +105 -0
  23. package/mcp-docs/mobile/components/ContainedAssetCard.txt +135 -0
  24. package/mcp-docs/mobile/components/ContentCard.txt +366 -0
  25. package/mcp-docs/mobile/components/ContentCardBody.txt +136 -0
  26. package/mcp-docs/mobile/components/ContentCardFooter.txt +128 -0
  27. package/mcp-docs/mobile/components/ContentCardHeader.txt +146 -0
  28. package/mcp-docs/mobile/components/ContentCell.txt +227 -0
  29. package/mcp-docs/mobile/components/ControlGroup.txt +444 -0
  30. package/mcp-docs/mobile/components/DatePicker.txt +497 -0
  31. package/mcp-docs/mobile/components/Divider.txt +139 -0
  32. package/mcp-docs/mobile/components/DotCount.txt +146 -0
  33. package/mcp-docs/mobile/components/DotStatusColor.txt +59 -0
  34. package/mcp-docs/mobile/components/DotSymbol.txt +135 -0
  35. package/mcp-docs/mobile/components/Fallback.txt +158 -0
  36. package/mcp-docs/mobile/components/FloatingAssetCard.txt +156 -0
  37. package/mcp-docs/mobile/components/HStack.txt +235 -0
  38. package/mcp-docs/mobile/components/HeroSquare.txt +48 -0
  39. package/mcp-docs/mobile/components/Icon.txt +52 -0
  40. package/mcp-docs/mobile/components/IconButton.txt +269 -0
  41. package/mcp-docs/mobile/components/InputChip.txt +188 -0
  42. package/mcp-docs/mobile/components/Interactable.txt +187 -0
  43. package/mcp-docs/mobile/components/LineChart.txt +1325 -0
  44. package/mcp-docs/mobile/components/Link.txt +292 -0
  45. package/mcp-docs/mobile/components/ListCell.txt +391 -0
  46. package/mcp-docs/mobile/components/LogoMark.txt +85 -0
  47. package/mcp-docs/mobile/components/LogoWordMark.txt +94 -0
  48. package/mcp-docs/mobile/components/Lottie.txt +139 -0
  49. package/mcp-docs/mobile/components/LottieStatusAnimation.txt +47 -0
  50. package/mcp-docs/mobile/components/Modal.txt +84 -0
  51. package/mcp-docs/mobile/components/ModalBody.txt +34 -0
  52. package/mcp-docs/mobile/components/ModalFooter.txt +25 -0
  53. package/mcp-docs/mobile/components/ModalHeader.txt +28 -0
  54. package/mcp-docs/mobile/components/MultiContentModule.txt +380 -0
  55. package/mcp-docs/mobile/components/NavigationTitle.txt +132 -0
  56. package/mcp-docs/mobile/components/NavigationTitleSelect.txt +142 -0
  57. package/mcp-docs/mobile/components/NudgeCard.txt +90 -0
  58. package/mcp-docs/mobile/components/Numpad.txt +341 -0
  59. package/mcp-docs/mobile/components/Overlay.txt +152 -0
  60. package/mcp-docs/mobile/components/PageFooter.txt +161 -0
  61. package/mcp-docs/mobile/components/PageHeader.txt +186 -0
  62. package/mcp-docs/mobile/components/PeriodSelector.txt +408 -0
  63. package/mcp-docs/mobile/components/Pictogram.txt +48 -0
  64. package/mcp-docs/mobile/components/Point.txt +205 -0
  65. package/mcp-docs/mobile/components/PortalProvider.txt +79 -0
  66. package/mcp-docs/mobile/components/Pressable.txt +211 -0
  67. package/mcp-docs/mobile/components/ProgressBar.txt +130 -0
  68. package/mcp-docs/mobile/components/ProgressBarWithFixedLabels.txt +161 -0
  69. package/mcp-docs/mobile/components/ProgressBarWithFloatLabel.txt +138 -0
  70. package/mcp-docs/mobile/components/ProgressCircle.txt +237 -0
  71. package/mcp-docs/mobile/components/Radio.txt +242 -0
  72. package/mcp-docs/mobile/components/RadioCell.txt +202 -0
  73. package/mcp-docs/mobile/components/RadioGroup.txt +282 -0
  74. package/mcp-docs/mobile/components/ReferenceLine.txt +153 -0
  75. package/mcp-docs/mobile/components/RemoteImage.txt +106 -0
  76. package/mcp-docs/mobile/components/RemoteImageGroup.txt +61 -0
  77. package/mcp-docs/mobile/components/RollingNumber.txt +789 -0
  78. package/mcp-docs/mobile/components/Scrubber.txt +204 -0
  79. package/mcp-docs/mobile/components/SearchInput.txt +192 -0
  80. package/mcp-docs/mobile/components/SectionHeader.txt +205 -0
  81. package/mcp-docs/mobile/components/SegmentedTabs.txt +316 -0
  82. package/mcp-docs/mobile/components/Select.txt +212 -0
  83. package/mcp-docs/mobile/components/SelectChip.txt +324 -0
  84. package/mcp-docs/mobile/components/SelectOption.txt +85 -0
  85. package/mcp-docs/mobile/components/SlideButton.txt +331 -0
  86. package/mcp-docs/mobile/components/Spacer.txt +84 -0
  87. package/mcp-docs/mobile/components/Sparkline.txt +123 -0
  88. package/mcp-docs/mobile/components/SparklineGradient.txt +107 -0
  89. package/mcp-docs/mobile/components/SparklineInteractive.txt +157 -0
  90. package/mcp-docs/mobile/components/SparklineInteractiveHeader.txt +73 -0
  91. package/mcp-docs/mobile/components/Spinner.txt +49 -0
  92. package/mcp-docs/mobile/components/SpotIcon.txt +48 -0
  93. package/mcp-docs/mobile/components/SpotRectangle.txt +48 -0
  94. package/mcp-docs/mobile/components/SpotSquare.txt +48 -0
  95. package/mcp-docs/mobile/components/Stepper.txt +528 -0
  96. package/mcp-docs/mobile/components/SubBrandLogoMark.txt +126 -0
  97. package/mcp-docs/mobile/components/SubBrandLogoWordMark.txt +126 -0
  98. package/mcp-docs/mobile/components/Switch.txt +98 -0
  99. package/mcp-docs/mobile/components/TabIndicator.txt +49 -0
  100. package/mcp-docs/mobile/components/TabLabel.txt +154 -0
  101. package/mcp-docs/mobile/components/TabNavigation.txt +147 -0
  102. package/mcp-docs/mobile/components/TabbedChips.txt +143 -0
  103. package/mcp-docs/mobile/components/Tabs.txt +191 -0
  104. package/mcp-docs/mobile/components/Tag.txt +301 -0
  105. package/mcp-docs/mobile/components/Text.txt +212 -0
  106. package/mcp-docs/mobile/components/TextInput.txt +718 -0
  107. package/mcp-docs/mobile/components/ThemeProvider.txt +133 -0
  108. package/mcp-docs/mobile/components/Toast.txt +197 -0
  109. package/mcp-docs/mobile/components/Tooltip.txt +60 -0
  110. package/mcp-docs/mobile/components/TopNavBar.txt +162 -0
  111. package/mcp-docs/mobile/components/Tour.txt +159 -0
  112. package/mcp-docs/mobile/components/Tray.txt +253 -0
  113. package/mcp-docs/mobile/components/UpsellCard.txt +322 -0
  114. package/mcp-docs/mobile/components/VStack.txt +223 -0
  115. package/mcp-docs/mobile/components/XAxis.txt +622 -0
  116. package/mcp-docs/mobile/components/YAxis.txt +568 -0
  117. package/mcp-docs/mobile/getting-started/introduction.txt +99 -0
  118. package/mcp-docs/mobile/getting-started/mcp-server.txt +94 -0
  119. package/mcp-docs/mobile/getting-started/playground.txt +25 -0
  120. package/mcp-docs/mobile/hooks/useDimensions.txt +47 -0
  121. package/mcp-docs/mobile/hooks/useOverlayContentContext.txt +215 -0
  122. package/mcp-docs/mobile/hooks/useTheme.txt +110 -0
  123. package/mcp-docs/mobile/routes.txt +132 -0
  124. package/mcp-docs/web/components/Accordion.txt +190 -0
  125. package/mcp-docs/web/components/AccordionItem.txt +32 -0
  126. package/mcp-docs/web/components/Alert.txt +165 -0
  127. package/mcp-docs/web/components/AreaChart.txt +511 -0
  128. package/mcp-docs/web/components/Avatar.txt +212 -0
  129. package/mcp-docs/web/components/AvatarButton.txt +241 -0
  130. package/mcp-docs/web/components/Banner.txt +227 -0
  131. package/mcp-docs/web/components/BarChart.txt +1268 -0
  132. package/mcp-docs/web/components/Box.txt +176 -0
  133. package/mcp-docs/web/components/Button.txt +213 -0
  134. package/mcp-docs/web/components/ButtonGroup.txt +80 -0
  135. package/mcp-docs/web/components/Calendar.txt +182 -0
  136. package/mcp-docs/web/components/Carousel.txt +1576 -0
  137. package/mcp-docs/web/components/CartesianChart.txt +1045 -0
  138. package/mcp-docs/web/components/CellMedia.txt +57 -0
  139. package/mcp-docs/web/components/Checkbox.txt +189 -0
  140. package/mcp-docs/web/components/CheckboxCell.txt +203 -0
  141. package/mcp-docs/web/components/CheckboxGroup.txt +220 -0
  142. package/mcp-docs/web/components/Chip.txt +197 -0
  143. package/mcp-docs/web/components/Coachmark.txt +189 -0
  144. package/mcp-docs/web/components/Collapsible.txt +120 -0
  145. package/mcp-docs/web/components/ContainedAssetCard.txt +233 -0
  146. package/mcp-docs/web/components/ContentCard.txt +368 -0
  147. package/mcp-docs/web/components/ContentCardBody.txt +138 -0
  148. package/mcp-docs/web/components/ContentCardFooter.txt +130 -0
  149. package/mcp-docs/web/components/ContentCardHeader.txt +148 -0
  150. package/mcp-docs/web/components/ContentCell.txt +220 -0
  151. package/mcp-docs/web/components/ControlGroup.txt +437 -0
  152. package/mcp-docs/web/components/DatePicker.txt +506 -0
  153. package/mcp-docs/web/components/Divider.txt +144 -0
  154. package/mcp-docs/web/components/DotCount.txt +150 -0
  155. package/mcp-docs/web/components/DotStatusColor.txt +59 -0
  156. package/mcp-docs/web/components/DotSymbol.txt +138 -0
  157. package/mcp-docs/web/components/Dropdown.txt +120 -0
  158. package/mcp-docs/web/components/Fallback.txt +164 -0
  159. package/mcp-docs/web/components/FloatingAssetCard.txt +251 -0
  160. package/mcp-docs/web/components/FullscreenAlert.txt +70 -0
  161. package/mcp-docs/web/components/FullscreenModal.txt +146 -0
  162. package/mcp-docs/web/components/FullscreenModalLayout.txt +188 -0
  163. package/mcp-docs/web/components/Grid.txt +237 -0
  164. package/mcp-docs/web/components/GridColumn.txt +210 -0
  165. package/mcp-docs/web/components/HStack.txt +237 -0
  166. package/mcp-docs/web/components/HeroSquare.txt +49 -0
  167. package/mcp-docs/web/components/Icon.txt +146 -0
  168. package/mcp-docs/web/components/IconButton.txt +391 -0
  169. package/mcp-docs/web/components/InputChip.txt +188 -0
  170. package/mcp-docs/web/components/Interactable.txt +194 -0
  171. package/mcp-docs/web/components/LineChart.txt +1577 -0
  172. package/mcp-docs/web/components/Link.txt +244 -0
  173. package/mcp-docs/web/components/ListCell.txt +397 -0
  174. package/mcp-docs/web/components/LogoMark.txt +85 -0
  175. package/mcp-docs/web/components/LogoWordMark.txt +94 -0
  176. package/mcp-docs/web/components/Lottie.txt +158 -0
  177. package/mcp-docs/web/components/LottieStatusAnimation.txt +58 -0
  178. package/mcp-docs/web/components/MediaQueryProvider.txt +109 -0
  179. package/mcp-docs/web/components/Modal.txt +193 -0
  180. package/mcp-docs/web/components/ModalBody.txt +118 -0
  181. package/mcp-docs/web/components/ModalFooter.txt +120 -0
  182. package/mcp-docs/web/components/ModalHeader.txt +124 -0
  183. package/mcp-docs/web/components/MultiContentModule.txt +382 -0
  184. package/mcp-docs/web/components/NavigationBar.txt +103 -0
  185. package/mcp-docs/web/components/NavigationTitle.txt +26 -0
  186. package/mcp-docs/web/components/NavigationTitleSelect.txt +46 -0
  187. package/mcp-docs/web/components/NudgeCard.txt +182 -0
  188. package/mcp-docs/web/components/Overlay.txt +172 -0
  189. package/mcp-docs/web/components/PageFooter.txt +185 -0
  190. package/mcp-docs/web/components/PageHeader.txt +244 -0
  191. package/mcp-docs/web/components/Pagination.txt +500 -0
  192. package/mcp-docs/web/components/PeriodSelector.txt +704 -0
  193. package/mcp-docs/web/components/Pictogram.txt +49 -0
  194. package/mcp-docs/web/components/Point.txt +461 -0
  195. package/mcp-docs/web/components/PortalProvider.txt +77 -0
  196. package/mcp-docs/web/components/Pressable.txt +194 -0
  197. package/mcp-docs/web/components/ProgressBar.txt +164 -0
  198. package/mcp-docs/web/components/ProgressBarWithFixedLabels.txt +213 -0
  199. package/mcp-docs/web/components/ProgressBarWithFloatLabel.txt +182 -0
  200. package/mcp-docs/web/components/ProgressCircle.txt +444 -0
  201. package/mcp-docs/web/components/Radio.txt +220 -0
  202. package/mcp-docs/web/components/RadioCell.txt +216 -0
  203. package/mcp-docs/web/components/RadioGroup.txt +289 -0
  204. package/mcp-docs/web/components/ReferenceLine.txt +452 -0
  205. package/mcp-docs/web/components/RemoteImage.txt +166 -0
  206. package/mcp-docs/web/components/RemoteImageGroup.txt +87 -0
  207. package/mcp-docs/web/components/RollingNumber.txt +1022 -0
  208. package/mcp-docs/web/components/Scrubber.txt +232 -0
  209. package/mcp-docs/web/components/SearchInput.txt +118 -0
  210. package/mcp-docs/web/components/SectionHeader.txt +218 -0
  211. package/mcp-docs/web/components/SegmentedTabs.txt +325 -0
  212. package/mcp-docs/web/components/Select.txt +225 -0
  213. package/mcp-docs/web/components/SelectChip.txt +315 -0
  214. package/mcp-docs/web/components/SelectOption.txt +166 -0
  215. package/mcp-docs/web/components/Sidebar.txt +350 -0
  216. package/mcp-docs/web/components/SidebarItem.txt +132 -0
  217. package/mcp-docs/web/components/SidebarMoreMenu.txt +31 -0
  218. package/mcp-docs/web/components/Spacer.txt +174 -0
  219. package/mcp-docs/web/components/Sparkline.txt +123 -0
  220. package/mcp-docs/web/components/SparklineGradient.txt +107 -0
  221. package/mcp-docs/web/components/SparklineInteractive.txt +154 -0
  222. package/mcp-docs/web/components/SparklineInteractiveHeader.txt +77 -0
  223. package/mcp-docs/web/components/Spinner.txt +129 -0
  224. package/mcp-docs/web/components/SpotIcon.txt +49 -0
  225. package/mcp-docs/web/components/SpotRectangle.txt +49 -0
  226. package/mcp-docs/web/components/SpotSquare.txt +49 -0
  227. package/mcp-docs/web/components/Stepper.txt +683 -0
  228. package/mcp-docs/web/components/SubBrandLogoMark.txt +126 -0
  229. package/mcp-docs/web/components/SubBrandLogoWordMark.txt +126 -0
  230. package/mcp-docs/web/components/Switch.txt +86 -0
  231. package/mcp-docs/web/components/TabIndicator.txt +49 -0
  232. package/mcp-docs/web/components/TabLabel.txt +159 -0
  233. package/mcp-docs/web/components/TabNavigation.txt +160 -0
  234. package/mcp-docs/web/components/TabbedChips.txt +156 -0
  235. package/mcp-docs/web/components/Table.txt +368 -0
  236. package/mcp-docs/web/components/TableBody.txt +84 -0
  237. package/mcp-docs/web/components/TableCaption.txt +103 -0
  238. package/mcp-docs/web/components/TableCell.txt +166 -0
  239. package/mcp-docs/web/components/TableCellFallback.txt +98 -0
  240. package/mcp-docs/web/components/TableFooter.txt +84 -0
  241. package/mcp-docs/web/components/TableHeader.txt +101 -0
  242. package/mcp-docs/web/components/TableRow.txt +141 -0
  243. package/mcp-docs/web/components/Tabs.txt +213 -0
  244. package/mcp-docs/web/components/Tag.txt +305 -0
  245. package/mcp-docs/web/components/Text.txt +233 -0
  246. package/mcp-docs/web/components/TextInput.txt +653 -0
  247. package/mcp-docs/web/components/ThemeProvider.txt +200 -0
  248. package/mcp-docs/web/components/TileButton.txt +159 -0
  249. package/mcp-docs/web/components/Toast.txt +204 -0
  250. package/mcp-docs/web/components/Tooltip.txt +90 -0
  251. package/mcp-docs/web/components/Tour.txt +180 -0
  252. package/mcp-docs/web/components/Tray.txt +289 -0
  253. package/mcp-docs/web/components/UpsellCard.txt +320 -0
  254. package/mcp-docs/web/components/VStack.txt +225 -0
  255. package/mcp-docs/web/components/XAxis.txt +620 -0
  256. package/mcp-docs/web/components/YAxis.txt +549 -0
  257. package/mcp-docs/web/getting-started/introduction.txt +99 -0
  258. package/mcp-docs/web/getting-started/mcp-server.txt +94 -0
  259. package/mcp-docs/web/getting-started/playground.txt +25 -0
  260. package/mcp-docs/web/hooks/useBreakpoints.txt +33 -0
  261. package/mcp-docs/web/hooks/useDimensions.txt +55 -0
  262. package/mcp-docs/web/hooks/useHasMounted.txt +55 -0
  263. package/mcp-docs/web/hooks/useIsoEffect.txt +42 -0
  264. package/mcp-docs/web/hooks/useMediaQuery.txt +94 -0
  265. package/mcp-docs/web/hooks/useOverlayContentContext.txt +217 -0
  266. package/mcp-docs/web/hooks/useScrollBlocker.txt +63 -0
  267. package/mcp-docs/web/hooks/useTheme.txt +105 -0
  268. package/mcp-docs/web/routes.txt +155 -0
  269. package/package.json +1 -1
@@ -0,0 +1,528 @@
1
+ # Stepper
2
+
3
+ A component that visualizes states within a multi-step process.
4
+
5
+ ## Import
6
+
7
+ ```jsx
8
+ import { Stepper } from '@coinbase/cds-mobile/stepper/Stepper'
9
+ ```
10
+
11
+ ## Props
12
+
13
+ | Prop | Type | Required | Default | Description |
14
+ | --- | --- | --- | --- | --- |
15
+ | `activeStepId` | `string \| null` | Yes | `-` | The id of the current/active step. Set this to null to visualize a completely unfilled/incomplete Stepper. |
16
+ | `direction` | `horizontal \| vertical` | Yes | `-` | The orientation of the stepper. |
17
+ | `steps` | `StepperValue<Metadata>[]` | Yes | `-` | An array of steps to render. |
18
+ | `StepperHeaderComponent` | `StepperHeaderComponent<Metadata> \| null` | No | `-` | An optional component to render in place of the default Header subcomponent. Set to null to render nothing in this slot. |
19
+ | `StepperIconComponent` | `StepperIconComponent<Metadata> \| null` | No | `-` | An optional component to render in place of the default Icon subcomponent. Set to null to render nothing in this slot. |
20
+ | `StepperLabelComponent` | `StepperLabelComponent<Metadata> \| null` | No | `-` | An optional component to render in place of the default Label subcomponent. Set to null to render nothing in this slot. |
21
+ | `StepperProgressComponent` | `StepperProgressComponent<Metadata> \| null` | No | `-` | An optional component to render in place of the default Progress subcomponent. Set to null to render nothing in this slot. |
22
+ | `StepperStepComponent` | `StepperStepComponent<Metadata>` | No | `-` | An optional component to render in place of the default Step subcomponent. |
23
+ | `StepperSubstepContainerComponent` | `StepperSubstepContainerComponent<Metadata> \| null` | No | `-` | An optional component to render in place of the default SubstepContainer subcomponent. |
24
+ | `alignContent` | `flex-start \| flex-end \| center \| stretch \| space-between \| space-around \| space-evenly` | No | `-` | - |
25
+ | `alignItems` | `flex-start \| flex-end \| center \| stretch \| baseline` | No | `-` | - |
26
+ | `alignSelf` | `auto \| FlexAlignType` | No | `-` | - |
27
+ | `animate` | `boolean` | No | `true` | Whether to animate the progress spring. |
28
+ | `animated` | `boolean` | No | `-` | - |
29
+ | `aspectRatio` | `string \| number` | No | `-` | - |
30
+ | `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 | `-` | - |
31
+ | `borderBottomLeftRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
32
+ | `borderBottomRightRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
33
+ | `borderBottomWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
34
+ | `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 | `-` | - |
35
+ | `borderEndWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
36
+ | `borderRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
37
+ | `borderStartWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
38
+ | `borderTopLeftRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
39
+ | `borderTopRightRadius` | `0 \| 100 \| 200 \| 300 \| 400 \| 500 \| 600 \| 700 \| 800 \| 900 \| 1000` | No | `-` | - |
40
+ | `borderTopWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
41
+ | `borderWidth` | `0 \| 100 \| 200 \| 300 \| 400 \| 500` | No | `-` | - |
42
+ | `bordered` | `boolean` | No | `-` | Add a border around all sides of the box. |
43
+ | `borderedBottom` | `boolean` | No | `-` | Add a border to the bottom side of the box. |
44
+ | `borderedEnd` | `boolean` | No | `-` | Add a border to the trailing side of the box. |
45
+ | `borderedHorizontal` | `boolean` | No | `-` | Add a border to the leading and trailing sides of the box. |
46
+ | `borderedStart` | `boolean` | No | `-` | Add a border to the leading side of the box. |
47
+ | `borderedTop` | `boolean` | No | `-` | Add a border to the top side of the box. |
48
+ | `borderedVertical` | `boolean` | No | `-` | Add a border to the top and bottom sides of the box. |
49
+ | `bottom` | `string \| number` | No | `-` | - |
50
+ | `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 | `-` | - |
51
+ | `columnGap` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
52
+ | `complete` | `boolean` | No | `-` | Set this to true to visualize a completely filled/complete Stepper |
53
+ | `completedStepAccessibilityLabel` | `string` | No | `"Complete"` | An optional accessibility label used to announce a step as complete/visited. Useful for providing an internationalized label for this state. |
54
+ | `dangerouslySetBackground` | `string` | No | `-` | - |
55
+ | `disableAnimateOnMount` | `boolean` | No | `-` | Whether to disable the animation on mount. |
56
+ | `display` | `flex \| none` | No | `-` | - |
57
+ | `elevation` | `0 \| 1 \| 2` | No | `-` | Determines box shadow styles. Parent should have overflow set to visible to ensure styles are not clipped. |
58
+ | `flexBasis` | `string \| number` | No | `-` | - |
59
+ | `flexDirection` | `row \| column \| row-reverse \| column-reverse` | No | `-` | - |
60
+ | `flexGrow` | `number` | No | `-` | - |
61
+ | `flexShrink` | `number` | No | `-` | - |
62
+ | `flexWrap` | `wrap \| nowrap \| wrap-reverse` | No | `-` | - |
63
+ | `font` | `inherit \| FontFamily` | No | `-` | - |
64
+ | `fontFamily` | `inherit \| FontFamily` | No | `-` | - |
65
+ | `fontSize` | `inherit \| FontSize` | No | `-` | - |
66
+ | `fontWeight` | `inherit \| FontWeight` | No | `-` | - |
67
+ | `gap` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
68
+ | `height` | `string \| number` | No | `-` | - |
69
+ | `justifyContent` | `flex-start \| flex-end \| center \| space-between \| space-around \| space-evenly` | No | `-` | - |
70
+ | `left` | `string \| number` | No | `-` | - |
71
+ | `lineHeight` | `inherit \| LineHeight` | No | `-` | - |
72
+ | `margin` | `0 \| -1 \| -2 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1.5` | No | `-` | - |
73
+ | `marginBottom` | `0 \| -1 \| -2 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1.5` | No | `-` | - |
74
+ | `marginEnd` | `0 \| -1 \| -2 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1.5` | No | `-` | - |
75
+ | `marginStart` | `0 \| -1 \| -2 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1.5` | No | `-` | - |
76
+ | `marginTop` | `0 \| -1 \| -2 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1.5` | No | `-` | - |
77
+ | `marginX` | `0 \| -1 \| -2 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1.5` | No | `-` | - |
78
+ | `marginY` | `0 \| -1 \| -2 \| -3 \| -4 \| -5 \| -6 \| -7 \| -8 \| -9 \| -10 \| -0.25 \| -0.5 \| -0.75 \| -1.5` | No | `-` | - |
79
+ | `maxHeight` | `string \| number` | No | `-` | - |
80
+ | `maxWidth` | `string \| number` | No | `-` | - |
81
+ | `minHeight` | `string \| number` | No | `-` | - |
82
+ | `minWidth` | `string \| number` | No | `-` | - |
83
+ | `onPointerCancel` | `((event: PointerEvent) => void)` | No | `-` | - |
84
+ | `onPointerCancelCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
85
+ | `onPointerDown` | `((event: PointerEvent) => void)` | No | `-` | - |
86
+ | `onPointerDownCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
87
+ | `onPointerEnter` | `((event: PointerEvent) => void)` | No | `-` | - |
88
+ | `onPointerEnterCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
89
+ | `onPointerLeave` | `((event: PointerEvent) => void)` | No | `-` | - |
90
+ | `onPointerLeaveCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
91
+ | `onPointerMove` | `((event: PointerEvent) => void)` | No | `-` | - |
92
+ | `onPointerMoveCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
93
+ | `onPointerUp` | `((event: PointerEvent) => void)` | No | `-` | - |
94
+ | `onPointerUpCapture` | `((event: PointerEvent) => void)` | No | `-` | - |
95
+ | `opacity` | `number \| AnimatedNode` | No | `-` | - |
96
+ | `overflow` | `visible \| hidden \| scroll` | No | `-` | - |
97
+ | `padding` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
98
+ | `paddingBottom` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
99
+ | `paddingEnd` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
100
+ | `paddingStart` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
101
+ | `paddingTop` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
102
+ | `paddingX` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
103
+ | `paddingY` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
104
+ | `pin` | `top \| bottom \| left \| right \| all` | No | `-` | Direction in which to absolutely pin the box. |
105
+ | `position` | `absolute \| relative \| static \| fixed \| sticky` | No | `-` | - |
106
+ | `progressSpringConfig` | `Partial<AnimationConfig>` | No | `-` | The spring config to use for the progress spring. |
107
+ | `ref` | `null \| (instance: View \| null) => void \| RefObject<View>` | No | `-` | - |
108
+ | `right` | `string \| number` | No | `-` | - |
109
+ | `rowGap` | `0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 0.25 \| 0.5 \| 0.75 \| 1.5` | No | `-` | - |
110
+ | `style` | `false \| RegisteredStyle<ViewStyle> \| Value \| AnimatedInterpolation<string \| number> \| WithAnimatedObject<ViewStyle> \| WithAnimatedArray<Falsy \| ViewStyle \| RegisteredStyle<ViewStyle> \| RecursiveArray<Falsy \| ViewStyle \| RegisteredStyle<ViewStyle>> \| readonly (Falsy \| ViewStyle \| RegisteredStyle<ViewStyle>)[]> \| null` | No | `-` | - |
111
+ | `styles` | `{ root?: StyleProp<ViewStyle>; step?: StyleProp<ViewStyle>; substepContainer?: StyleProp<ViewStyle>; label?: StyleProp<ViewStyle>; progress?: StyleProp<ViewStyle>; icon?: StyleProp<ViewStyle>; header?: StyleProp<ViewStyle>; }` | No | `-` | Inline styles for specific child elements of Stepper |
112
+ | `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Used to locate this view in end-to-end tests. |
113
+ | `textAlign` | `left \| right \| auto \| center \| justify` | No | `-` | - |
114
+ | `textDecorationLine` | `none \| underline \| line-through \| underline line-through` | No | `-` | - |
115
+ | `textDecorationStyle` | `solid \| dotted \| dashed \| double` | No | `-` | - |
116
+ | `textTransform` | `none \| capitalize \| uppercase \| lowercase` | No | `-` | - |
117
+ | `top` | `string \| number` | No | `-` | - |
118
+ | `transform` | `string \| (({ scaleX: AnimatableNumericValue; } & { scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ scaleY: AnimatableNumericValue; } & { scaleX?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ translateX: AnimatableNumericValue \| ${number}%; } & { scaleX?: undefined; scaleY?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ translateY: AnimatableNumericValue \| ${number}%; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ perspective: AnimatableNumericValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ rotate: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ rotateX: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ rotateY: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ rotateZ: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ scale: AnimatableNumericValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; skewX?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ skewX: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewY?: undefined; matrix?: undefined; }) \| ({ skewY: AnimatableStringValue; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; matrix?: undefined; }) \| ({ matrix: AnimatableNumericValue[]; } & { scaleX?: undefined; scaleY?: undefined; translateX?: undefined; translateY?: undefined; perspective?: undefined; rotate?: undefined; rotateX?: undefined; rotateY?: undefined; rotateZ?: undefined; scale?: undefined; skewX?: undefined; skewY?: undefined; }))[]` | No | `-` | - |
119
+ | `userSelect` | `none \| auto \| contain \| text \| all` | No | `-` | - |
120
+ | `width` | `string \| number` | No | `-` | - |
121
+ | `zIndex` | `number` | No | `-` | - |
122
+
123
+
124
+ ## Examples
125
+
126
+ ### Basic Usage
127
+
128
+ The stepper can be used in two directions: horizontal and vertical.
129
+ Each direction has its own unique default design in order to support different use cases.
130
+
131
+ #### Direction: Horizontal
132
+
133
+ ```tsx
134
+ const steps = [
135
+ { id: '1', label: 'Account Details' },
136
+ { id: '2', label: 'Personal Information' },
137
+ { id: '3', label: 'Payment Method' },
138
+ { id: '4', label: 'Review & Submit' },
139
+ ];
140
+
141
+ const [stepperState, stepperApi] = useStepper({ steps });
142
+ const [complete, setComplete] = useState(false);
143
+
144
+ // Handle completion logic in your component
145
+ const handleNext = () => {
146
+ if (stepperState.activeStepId === '4') {
147
+ setComplete(true);
148
+ } else {
149
+ stepperApi.goNextStep();
150
+ }
151
+ };
152
+
153
+ return (
154
+ <Stepper
155
+ direction="horizontal"
156
+ activeStepId={stepperState.activeStepId}
157
+ steps={steps}
158
+ complete={complete}
159
+ />
160
+ );
161
+ ```
162
+
163
+ #### Direction: Vertical
164
+
165
+ ```tsx
166
+ const steps = [
167
+ { id: '1', label: 'Account Details' },
168
+ { id: '2', label: 'Personal Information' },
169
+ { id: '3', label: 'Payment Method' },
170
+ { id: '4', label: 'Review & Submit' },
171
+ ];
172
+
173
+ const [stepperState, stepperApi] = useStepper({ steps });
174
+ const [complete, setComplete] = useState(false);
175
+
176
+ // Handle completion logic in your component
177
+ const handleNext = () => {
178
+ if (stepperState.activeStepId === '4') {
179
+ setComplete(true);
180
+ } else {
181
+ stepperApi.goNextStep();
182
+ }
183
+ };
184
+
185
+ return (
186
+ <Stepper
187
+ direction="vertical"
188
+ activeStepId={stepperState.activeStepId}
189
+ steps={steps}
190
+ complete={complete}
191
+ />
192
+ );
193
+ ```
194
+
195
+ ### Step Config
196
+
197
+ The Stepper is ultimately a visual representation of an array of step objects (i.e. `StepperValue[]`).
198
+ These should be defined outside of the component or memoized prior to rendering a Stepper.
199
+
200
+ Commonly used or required **StepperValue** properties:
201
+
202
+ - `id` - A required, unique identifier for the step.
203
+ - `label` - The label of the step. Optionally exclude this property to hide the label text.
204
+ - `subSteps` - An optional array of sub-steps to nest under the step.
205
+ - `metadata` - An optional object that can be used to store additional data about the step. This is useful when providing your own custom Step components.
206
+
207
+ ### useStepper hook
208
+
209
+ Call the `useStepper` hook to initialize stepper state, access the current state and perform state mutations with its API.
210
+
211
+ The hook returns a tuple where the first member is the current stepper state containing the `activeStepId`.
212
+
213
+ ```tsx
214
+ const [stepperState, stepperApi] = useStepper({ steps });
215
+
216
+ <Stepper direction="horizontal" activeStepId={stepperState.activeStepId} steps={steps} />;
217
+ ```
218
+
219
+ The second member is an API for manipulating the stepper state and includes the following methods:
220
+
221
+ ```tsx
222
+ type StepperApi = {
223
+ /** Update the currently active step to the step with `id`. */
224
+ goToStep: (id: string) => void;
225
+ /** Update the currently active step to the next enabled step in the steps array. Does nothing if the last step is already active. */
226
+ goNextStep: () => void;
227
+ /** Update the currently active step to the previous enabled step in the steps array. Does nothing if the first step is already active. */
228
+ goPreviousStep: () => void;
229
+ /** Reset the active step to the original default active step. */
230
+ reset: () => void;
231
+ };
232
+ ```
233
+
234
+ ### Common Patterns & Use Cases
235
+
236
+ #### Sub-steps
237
+
238
+ A common use-case for the vertical stepper is to visualize long and complex workflows with nested/grouped steps.
239
+ A StepperValue object optionally accepts a `subSteps` property, which is also an array of StepperValue objects.
240
+
241
+ :::danger Avoid Deep Nesting
242
+ Steps can be nested arbritrarily deep, however CDS does not advise nesting deeper than one level.
243
+ :::
244
+
245
+ ```tsx
246
+ const steps: StepperValue[] = [
247
+ {
248
+ id: 'first-step',
249
+ label: 'First step',
250
+ },
251
+ {
252
+ id: 'second-step',
253
+ label: 'Second step',
254
+ subSteps: [
255
+ {
256
+ id: 'second-step-substep-one',
257
+ label: 'Substep one',
258
+ },
259
+ {
260
+ id: 'second-step-substep-two',
261
+ label: 'Substep two',
262
+ },
263
+ {
264
+ id: 'second-step-substep-three',
265
+ label: 'Substep three',
266
+ },
267
+ ],
268
+ },
269
+ {
270
+ id: 'final-step',
271
+ label: 'Final step',
272
+ },
273
+ ];
274
+
275
+ const [stepperState, stepperApi] = useStepper({ steps });
276
+ const [complete, setComplete] = useState(false);
277
+
278
+ return (
279
+ <Stepper
280
+ direction="vertical"
281
+ activeStepId={stepperState.activeStepId}
282
+ steps={steps}
283
+ complete={complete}
284
+ accessibilityLabel="Example Stepper"
285
+ />
286
+ );
287
+ ```
288
+
289
+ ### Customization Options
290
+
291
+ #### 1. Custom Components
292
+
293
+ Stepper is highly customizable. Use the _Component_ props to customize Stepper with your own React components.
294
+ Components can be set on the Stepper or individually on each step. Custom components set on a specific step will override the same component set on the Stepper.
295
+
296
+ ##### Customizable subcomponents
297
+
298
+ - **StepperHeaderComponent**: Rendered above the entire stepper, helpful to display an overall title or label.
299
+ - **StepperIconComponent**: Useful for showing a small visual with the step to convey state or the intent of the step.
300
+ - **StepperProgressComponent**: Can be used to show an animated marker of progress with each step.
301
+ - **StepperLabelComponent**: A component responsible for rendering the label text or main content associated with the step.
302
+ - **StepperSubstepContainerComponent**: Responsible for rendering the recursive sub-steps of a step.
303
+
304
+ Below are some basic diagrams to help visualize the Stepper anatomy in its two orientations.
305
+
306
+ ```text
307
+ direction: horizontal
308
+ ┌─────────────────────────────────┐
309
+ │ Step (VStack) │
310
+ │ ┌───────────────────────────┐ │
311
+ │ │ HStack │ │
312
+ │ │ ┌──────┐ ┌──────────────┐ │ │
313
+ │ │ │ Icon │ │ Progress │ │ │
314
+ │ │ │ │ │ │ │ │
315
+ │ │ └──────┘ └──────────────┘ │ │
316
+ │ └───────────────────────────┘ │
317
+ │ ┌───────────────────────────┐ │
318
+ │ │ Label │ │
319
+ │ └───────────────────────────┘ │
320
+ │ ┌───────────────────────────┐ │
321
+ │ │ SubstepContainer │ │
322
+ │ │ (recursive) │ │
323
+ │ └───────────────────────────┘ │
324
+ └─────────────────────────────────┘
325
+ ```
326
+
327
+ ```text
328
+ direction: vertical
329
+ ┌─────────────────────────────────────────────────┐
330
+ │ Step (VStack) │
331
+ │ ┌───────────────────────────────────────────┐ │
332
+ │ │ HStack │ │
333
+ │ │ ┌─────────────┐ ┌───────────────────┐ │ │
334
+ │ │ │ VStack │ │ VStack │ │ │
335
+ │ │ │ ┌─────────┐ │ │ ┌───────────────┐ │ │ │
336
+ │ │ │ │ Icon │ │ │ │ Label │ │ │ │
337
+ │ │ │ └─────────┘ │ │ └───────────────┘ │ │ │
338
+ │ │ │ ┌─────────┐ │ │ ┌───────────────┐ │ │ │
339
+ │ │ │ │Progress │ │ │ │ Substeps │ │ │ │
340
+ │ │ │ └─────────┘ │ │ │ (recursive) │ │ │ │
341
+ │ │ └─────────────┘ │ └───────────────┘ │ │ │
342
+ │ └───────────────────────────────────────────┘ │
343
+ └─────────────────────────────────────────────────┘
344
+ ```
345
+
346
+ Each custom component receives a specific set of props that provide access to step data and state.
347
+ When writing your own components, make sure you're getting the most out of Stepper by importing our custom component types like so:
348
+
349
+ ```tsx
350
+ import type { StepperLabelProps } from '@coinbase/cds-web/stepper/Stepper';
351
+
352
+ const TravelBookingLabel = ({
353
+ step,
354
+ active,
355
+ depth,
356
+ }: StepperLabelProps) => {
357
+ const { label, metadata, id } = step;
358
+ const subtitle = metadata?.subtitle as string;
359
+
360
+ if (depth === 0 && metadata) {
361
+ return (
362
+ <ListCell
363
+ description={metadata.name as string}
364
+ detail={metadata.date as string}
365
+ innerSpacing={{ paddingTop: 0, paddingBottom: 0 }}
366
+ maxWidth={350}
367
+ minHeight={undefined}
368
+ outerSpacing={{ paddingTop: 0, paddingBottom: 3, paddingStart: 0, paddingEnd: 0 }}
369
+ subdetail={metadata.time as string}
370
+ title={label}
371
+ />
372
+ );
373
+ }
374
+ ```
375
+
376
+ :::tip Using Default Components
377
+ In many cases, it may be helpful to compose the default Stepper Components within your own. For example, you may want to make the default label pressable.
378
+ All of the default components used by Stepper are exported and available for you to use.
379
+
380
+ ```tsx
381
+ import { DefaultStepperLabelHorizontal } from '@coinbase/cds-web/stepper';
382
+
383
+ <Stepper
384
+ direction="horizontal"
385
+ StepperLabelComponent={(props) => (
386
+ <Pressable onClick={handleStepClick}>
387
+ <DefaultStepperLabelHorizontal {...props} />
388
+ </Pressable>
389
+ )}
390
+ />;
391
+ ```
392
+
393
+ :::
394
+
395
+ ##### Null Components
396
+
397
+ Pass null to any of the component props to completely disable its functionality and hide it from the user.
398
+
399
+ ```tsx
400
+ const steps = [
401
+ { id: '1', label: 'Account Details' },
402
+ { id: '2', label: 'Personal Information' },
403
+ { id: '3', label: 'Payment Method' },
404
+ { id: '4', label: 'Review & Submit' },
405
+ ];
406
+
407
+ const [stepperState, stepperApi] = useStepper({ steps });
408
+ const [complete, setComplete] = useState(false);
409
+
410
+ return (
411
+ <Stepper
412
+ direction="horizontal"
413
+ StepperLabelComponent={null}
414
+ activeStepId={stepperState.activeStepId}
415
+ steps={steps}
416
+ complete={complete}
417
+ />
418
+ );
419
+ ```
420
+
421
+ ##### Custom Metadata for Rich Step Data
422
+
423
+ The `metadata` property on each step allows you to store additional data that can be used
424
+ by custom components to create rich, interactive experiences. This is particularly useful
425
+ for complex workflows where each step needs to display contextual information.
426
+
427
+ ```tsx
428
+ function StepperCustomMetadataExample() {
429
+ const CustomBookingLabel = ({ step, active }) => {
430
+ const { label, metadata } = step;
431
+
432
+ return (
433
+ <ListCell
434
+ title={label}
435
+ description={metadata.name}
436
+ detail={metadata.date}
437
+ subdetail={metadata.time}
438
+ maxWidth={350}
439
+ innerSpacing={{ paddingTop: 0, paddingBottom: 0 }}
440
+ outerSpacing={{ paddingTop: 0, paddingBottom: 3, paddingStart: 0, paddingEnd: 0 }}
441
+ minHeight={undefined}
442
+ />
443
+ );
444
+ };
445
+
446
+ const bookingSteps: StepperValue<{
447
+ name: string;
448
+ date: string;
449
+ time: string;
450
+ }>[] = [
451
+ {
452
+ id: 'book-hotel',
453
+ label: 'Book Hotel',
454
+ metadata: {
455
+ name: 'Marriott Downtown',
456
+ date: '2025-06-13',
457
+ time: '3:00 PM Check-in',
458
+ },
459
+ },
460
+ {
461
+ id: 'book-flight',
462
+ label: 'Book Flight',
463
+ metadata: {
464
+ name: 'Delta Airlines',
465
+ date: '2025-06-13',
466
+ time: '11:03 AM Departure',
467
+ },
468
+ },
469
+ {
470
+ id: 'rental-car',
471
+ label: 'Reserve Rental Car',
472
+ metadata: {
473
+ name: 'Enterprise Rent-A-Car',
474
+ date: '2025-06-14',
475
+ time: '2:24 PM Pickup',
476
+ },
477
+ },
478
+ ];
479
+
480
+ const [stepperState, stepperApi] = useStepper({
481
+ steps: bookingSteps,
482
+ });
483
+
484
+ return (
485
+ <Stepper
486
+ direction="vertical"
487
+ activeStepId={stepperState.activeStepId}
488
+ steps={bookingSteps}
489
+ complete={true}
490
+ StepperLabelComponent={CustomBookingLabel}
491
+ accessibilityLabel="Travel Booking Stepper"
492
+ />
493
+ );
494
+ }
495
+ ```
496
+
497
+ #### 2. styles API
498
+
499
+ The Stepper component provides flexible styling options through the `styles` prop.
500
+ Through this prop, you can apply inline styles to specific subcomponents of the Stepper; the same components which you can override with the `Component` props.
501
+
502
+ ##### styles
503
+
504
+ The `styles` prop allows you to apply inline styles to specific child elements.
505
+
506
+ It accepts an object with the following optional keys:
507
+
508
+ - `header` - Applied to the header component
509
+ - `step` - Applied to each individual step element
510
+ - `substepContainer` - Applied to each substep container element
511
+ - `progress` - Applied to each step progress bar element
512
+ - `label` - Applied to each step label element
513
+ - `icon` - Applied to each step icon element
514
+
515
+ ```tsx
516
+ <Stepper
517
+ direction="horizontal"
518
+ styles={{
519
+ step: { ... },
520
+ substepContainer: { ... },
521
+ label: { ... },
522
+ progress: { ... },
523
+ }}
524
+ // ... other props
525
+ />
526
+ ```
527
+
528
+
@@ -0,0 +1,126 @@
1
+ # SubBrandLogoMark
2
+
3
+ Coinbase sub-brand logo marks for specialized branding.
4
+
5
+ ## Import
6
+
7
+ ```jsx
8
+ import { SubBrandLogoMark } from '@coinbase/cds-mobile/icons/SubBrandLogoMark'
9
+ ```
10
+
11
+ ## Props
12
+
13
+ | Prop | Type | Required | Default | Description |
14
+ | --- | --- | --- | --- | --- |
15
+ | `type` | `base \| keyof SubBrandLogoDataByType` | Yes | `-` | - |
16
+ | `foreground` | `boolean` | No | `-` | - |
17
+
18
+
19
+ ## Examples
20
+
21
+ ### Basic usage
22
+
23
+ ```tsx
24
+ <VStack alignItems="center">
25
+ <Box height="40px">
26
+ <SubBrandLogoMark type="wallet" />
27
+ </Box>
28
+ </VStack>
29
+ ```
30
+
31
+ ### Different Sub-Brand Types
32
+
33
+ ```tsx
34
+ <VStack gap={4}>
35
+ <VStack gap={2}>
36
+ <Text font="label2" color="fgMuted">
37
+ Wallet
38
+ </Text>
39
+ <Box height="40px">
40
+ <SubBrandLogoMark type="wallet" />
41
+ </Box>
42
+ </VStack>
43
+ <VStack gap={2}>
44
+ <Text font="label2" color="fgMuted">
45
+ Business
46
+ </Text>
47
+ <Box height="40px">
48
+ <SubBrandLogoMark type="business" />
49
+ </Box>
50
+ </VStack>
51
+ <VStack gap={2}>
52
+ <Text font="label2" color="fgMuted">
53
+ Commerce
54
+ </Text>
55
+ <Box height="40px">
56
+ <SubBrandLogoMark type="commerce" />
57
+ </Box>
58
+ </VStack>
59
+ </VStack>
60
+ ```
61
+
62
+ ### Foreground Variations
63
+
64
+ ```tsx
65
+ <VStack gap={4}>
66
+ <VStack gap={2}>
67
+ <Text font="label2" color="fgMuted">
68
+ Default (brand blue in light mode, white in dark mode)
69
+ </Text>
70
+ <Box height="40px">
71
+ <SubBrandLogoMark type="wallet" />
72
+ </Box>
73
+ </VStack>
74
+ <VStack gap={2}>
75
+ <Text font="label2" color="fgMuted">
76
+ Foreground (high contrast black in light mode, white in dark mode)
77
+ </Text>
78
+ <Box height="40px">
79
+ <SubBrandLogoMark type="wallet" foreground={true} />
80
+ </Box>
81
+ </VStack>
82
+ </VStack>
83
+ ```
84
+
85
+ ### Sizing
86
+
87
+ SubBrandLogoMark doesn't have a `size` prop. Instead, control its size by setting the width or height of its container. The component will automatically maintain its aspect ratio.
88
+
89
+ ```tsx
90
+ <VStack gap={4}>
91
+ <VStack gap={2}>
92
+ <Text font="label2" color="fgMuted">
93
+ Small (24px height)
94
+ </Text>
95
+ <Box height="24px">
96
+ <SubBrandLogoMark type="wallet" />
97
+ </Box>
98
+ </VStack>
99
+ <VStack gap={2}>
100
+ <Text font="label2" color="fgMuted">
101
+ Medium (40px height)
102
+ </Text>
103
+ <Box height="40px">
104
+ <SubBrandLogoMark type="wallet" />
105
+ </Box>
106
+ </VStack>
107
+ <VStack gap={2}>
108
+ <Text font="label2" color="fgMuted">
109
+ Large (60px height)
110
+ </Text>
111
+ <Box height="60px">
112
+ <SubBrandLogoMark type="wallet" />
113
+ </Box>
114
+ </VStack>
115
+ <VStack gap={2}>
116
+ <Text font="label2" color="fgMuted">
117
+ Width-constrained (100px width)
118
+ </Text>
119
+ <Box width="100px">
120
+ <SubBrandLogoMark type="wallet" />
121
+ </Box>
122
+ </VStack>
123
+ </VStack>
124
+ ```
125
+
126
+