@coinbase/cds-mcp-server 8.17.2 → 8.17.4

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 (284) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/mcp-docs/mobile/components/Accordion.txt +188 -0
  3. package/mcp-docs/mobile/components/AccordionItem.txt +29 -0
  4. package/mcp-docs/mobile/components/Alert.txt +155 -0
  5. package/mcp-docs/mobile/components/AreaChart.txt +265 -0
  6. package/mcp-docs/mobile/components/Avatar.txt +195 -0
  7. package/mcp-docs/mobile/components/AvatarButton.txt +225 -0
  8. package/mcp-docs/mobile/components/Banner.txt +221 -0
  9. package/mcp-docs/mobile/components/BarChart.txt +815 -0
  10. package/mcp-docs/mobile/components/Box.txt +173 -0
  11. package/mcp-docs/mobile/components/BrowserBar.txt +146 -0
  12. package/mcp-docs/mobile/components/Button.txt +198 -0
  13. package/mcp-docs/mobile/components/ButtonGroup.txt +79 -0
  14. package/mcp-docs/mobile/components/Carousel.txt +1083 -0
  15. package/mcp-docs/mobile/components/CartesianChart.txt +825 -0
  16. package/mcp-docs/mobile/components/CellMedia.txt +70 -0
  17. package/mcp-docs/mobile/components/Checkbox.txt +245 -0
  18. package/mcp-docs/mobile/components/CheckboxCell.txt +201 -0
  19. package/mcp-docs/mobile/components/CheckboxGroup.txt +284 -0
  20. package/mcp-docs/mobile/components/Chip.txt +194 -0
  21. package/mcp-docs/mobile/components/Coachmark.txt +157 -0
  22. package/mcp-docs/mobile/components/Collapsible.txt +104 -0
  23. package/mcp-docs/mobile/components/ContainedAssetCard.txt +134 -0
  24. package/mcp-docs/mobile/components/ContentCard.txt +365 -0
  25. package/mcp-docs/mobile/components/ContentCardBody.txt +135 -0
  26. package/mcp-docs/mobile/components/ContentCardFooter.txt +127 -0
  27. package/mcp-docs/mobile/components/ContentCardHeader.txt +145 -0
  28. package/mcp-docs/mobile/components/ContentCell.txt +226 -0
  29. package/mcp-docs/mobile/components/ControlGroup.txt +443 -0
  30. package/mcp-docs/mobile/components/DatePicker.txt +496 -0
  31. package/mcp-docs/mobile/components/Divider.txt +138 -0
  32. package/mcp-docs/mobile/components/DotCount.txt +145 -0
  33. package/mcp-docs/mobile/components/DotStatusColor.txt +58 -0
  34. package/mcp-docs/mobile/components/DotSymbol.txt +134 -0
  35. package/mcp-docs/mobile/components/Fallback.txt +157 -0
  36. package/mcp-docs/mobile/components/FloatingAssetCard.txt +155 -0
  37. package/mcp-docs/mobile/components/HStack.txt +234 -0
  38. package/mcp-docs/mobile/components/HeroSquare.txt +47 -0
  39. package/mcp-docs/mobile/components/Icon.txt +51 -0
  40. package/mcp-docs/mobile/components/IconButton.txt +268 -0
  41. package/mcp-docs/mobile/components/InputChip.txt +187 -0
  42. package/mcp-docs/mobile/components/Interactable.txt +186 -0
  43. package/mcp-docs/mobile/components/LineChart.txt +1324 -0
  44. package/mcp-docs/mobile/components/Link.txt +291 -0
  45. package/mcp-docs/mobile/components/ListCell.txt +412 -0
  46. package/mcp-docs/mobile/components/LogoMark.txt +84 -0
  47. package/mcp-docs/mobile/components/LogoWordMark.txt +93 -0
  48. package/mcp-docs/mobile/components/Lottie.txt +138 -0
  49. package/mcp-docs/mobile/components/LottieStatusAnimation.txt +46 -0
  50. package/mcp-docs/mobile/components/Modal.txt +83 -0
  51. package/mcp-docs/mobile/components/ModalBody.txt +33 -0
  52. package/mcp-docs/mobile/components/ModalFooter.txt +24 -0
  53. package/mcp-docs/mobile/components/ModalHeader.txt +27 -0
  54. package/mcp-docs/mobile/components/MultiContentModule.txt +379 -0
  55. package/mcp-docs/mobile/components/NavigationTitle.txt +131 -0
  56. package/mcp-docs/mobile/components/NavigationTitleSelect.txt +141 -0
  57. package/mcp-docs/mobile/components/NudgeCard.txt +89 -0
  58. package/mcp-docs/mobile/components/Numpad.txt +340 -0
  59. package/mcp-docs/mobile/components/Overlay.txt +151 -0
  60. package/mcp-docs/mobile/components/PageFooter.txt +160 -0
  61. package/mcp-docs/mobile/components/PageHeader.txt +185 -0
  62. package/mcp-docs/mobile/components/PeriodSelector.txt +407 -0
  63. package/mcp-docs/mobile/components/Pictogram.txt +47 -0
  64. package/mcp-docs/mobile/components/Point.txt +204 -0
  65. package/mcp-docs/mobile/components/PortalProvider.txt +78 -0
  66. package/mcp-docs/mobile/components/Pressable.txt +210 -0
  67. package/mcp-docs/mobile/components/ProgressBar.txt +129 -0
  68. package/mcp-docs/mobile/components/ProgressBarWithFixedLabels.txt +160 -0
  69. package/mcp-docs/mobile/components/ProgressBarWithFloatLabel.txt +137 -0
  70. package/mcp-docs/mobile/components/ProgressCircle.txt +236 -0
  71. package/mcp-docs/mobile/components/Radio.txt +241 -0
  72. package/mcp-docs/mobile/components/RadioCell.txt +201 -0
  73. package/mcp-docs/mobile/components/RadioGroup.txt +281 -0
  74. package/mcp-docs/mobile/components/ReferenceLine.txt +152 -0
  75. package/mcp-docs/mobile/components/RemoteImage.txt +105 -0
  76. package/mcp-docs/mobile/components/RemoteImageGroup.txt +60 -0
  77. package/mcp-docs/mobile/components/RollingNumber.txt +788 -0
  78. package/mcp-docs/mobile/components/Scrubber.txt +203 -0
  79. package/mcp-docs/mobile/components/SearchInput.txt +191 -0
  80. package/mcp-docs/mobile/components/SectionHeader.txt +204 -0
  81. package/mcp-docs/mobile/components/SegmentedTabs.txt +315 -0
  82. package/mcp-docs/mobile/components/Select.txt +211 -0
  83. package/mcp-docs/mobile/components/SelectChip.txt +323 -0
  84. package/mcp-docs/mobile/components/SelectOption.txt +84 -0
  85. package/mcp-docs/mobile/components/SlideButton.txt +330 -0
  86. package/mcp-docs/mobile/components/Spacer.txt +83 -0
  87. package/mcp-docs/mobile/components/Sparkline.txt +122 -0
  88. package/mcp-docs/mobile/components/SparklineGradient.txt +106 -0
  89. package/mcp-docs/mobile/components/SparklineInteractive.txt +156 -0
  90. package/mcp-docs/mobile/components/SparklineInteractiveHeader.txt +72 -0
  91. package/mcp-docs/mobile/components/Spinner.txt +48 -0
  92. package/mcp-docs/mobile/components/SpotIcon.txt +47 -0
  93. package/mcp-docs/mobile/components/SpotRectangle.txt +47 -0
  94. package/mcp-docs/mobile/components/SpotSquare.txt +47 -0
  95. package/mcp-docs/mobile/components/Stepper.txt +527 -0
  96. package/mcp-docs/mobile/components/SubBrandLogoMark.txt +125 -0
  97. package/mcp-docs/mobile/components/SubBrandLogoWordMark.txt +125 -0
  98. package/mcp-docs/mobile/components/Switch.txt +97 -0
  99. package/mcp-docs/mobile/components/TabIndicator.txt +48 -0
  100. package/mcp-docs/mobile/components/TabLabel.txt +153 -0
  101. package/mcp-docs/mobile/components/TabNavigation.txt +146 -0
  102. package/mcp-docs/mobile/components/TabbedChips.txt +142 -0
  103. package/mcp-docs/mobile/components/Tabs.txt +190 -0
  104. package/mcp-docs/mobile/components/Tag.txt +300 -0
  105. package/mcp-docs/mobile/components/Text.txt +211 -0
  106. package/mcp-docs/mobile/components/TextInput.txt +717 -0
  107. package/mcp-docs/mobile/components/ThemeProvider.txt +132 -0
  108. package/mcp-docs/mobile/components/Toast.txt +196 -0
  109. package/mcp-docs/mobile/components/Tooltip.txt +59 -0
  110. package/mcp-docs/mobile/components/TopNavBar.txt +161 -0
  111. package/mcp-docs/mobile/components/Tour.txt +158 -0
  112. package/mcp-docs/mobile/components/Tray.txt +252 -0
  113. package/mcp-docs/mobile/components/UpsellCard.txt +321 -0
  114. package/mcp-docs/mobile/components/VStack.txt +222 -0
  115. package/mcp-docs/mobile/components/XAxis.txt +621 -0
  116. package/mcp-docs/mobile/components/YAxis.txt +567 -0
  117. package/mcp-docs/mobile/getting-started/ai-overview.txt +108 -0
  118. package/mcp-docs/mobile/getting-started/installation.txt +57 -0
  119. package/mcp-docs/mobile/getting-started/introduction.txt +102 -0
  120. package/mcp-docs/mobile/getting-started/playground.txt +28 -0
  121. package/mcp-docs/mobile/getting-started/styling.txt +84 -0
  122. package/mcp-docs/mobile/getting-started/theming.txt +286 -0
  123. package/mcp-docs/mobile/hooks/useDimensions.txt +72 -0
  124. package/mcp-docs/mobile/hooks/useEventHandler.txt +120 -0
  125. package/mcp-docs/mobile/hooks/useMergeRefs.txt +116 -0
  126. package/mcp-docs/mobile/hooks/useOverlayContentContext.txt +280 -0
  127. package/mcp-docs/mobile/hooks/usePreviousValue.txt +74 -0
  128. package/mcp-docs/mobile/hooks/useRefMap.txt +178 -0
  129. package/mcp-docs/mobile/hooks/useTheme.txt +321 -0
  130. package/mcp-docs/mobile/routes.txt +139 -0
  131. package/mcp-docs/web/components/Accordion.txt +189 -0
  132. package/mcp-docs/web/components/AccordionItem.txt +31 -0
  133. package/mcp-docs/web/components/Alert.txt +164 -0
  134. package/mcp-docs/web/components/AreaChart.txt +510 -0
  135. package/mcp-docs/web/components/Avatar.txt +211 -0
  136. package/mcp-docs/web/components/AvatarButton.txt +240 -0
  137. package/mcp-docs/web/components/Banner.txt +226 -0
  138. package/mcp-docs/web/components/BarChart.txt +1267 -0
  139. package/mcp-docs/web/components/Box.txt +175 -0
  140. package/mcp-docs/web/components/Button.txt +212 -0
  141. package/mcp-docs/web/components/ButtonGroup.txt +79 -0
  142. package/mcp-docs/web/components/Calendar.txt +181 -0
  143. package/mcp-docs/web/components/Carousel.txt +1575 -0
  144. package/mcp-docs/web/components/CartesianChart.txt +1044 -0
  145. package/mcp-docs/web/components/CellMedia.txt +56 -0
  146. package/mcp-docs/web/components/Checkbox.txt +188 -0
  147. package/mcp-docs/web/components/CheckboxCell.txt +202 -0
  148. package/mcp-docs/web/components/CheckboxGroup.txt +219 -0
  149. package/mcp-docs/web/components/Chip.txt +196 -0
  150. package/mcp-docs/web/components/Coachmark.txt +188 -0
  151. package/mcp-docs/web/components/Collapsible.txt +119 -0
  152. package/mcp-docs/web/components/ContainedAssetCard.txt +232 -0
  153. package/mcp-docs/web/components/ContentCard.txt +367 -0
  154. package/mcp-docs/web/components/ContentCardBody.txt +137 -0
  155. package/mcp-docs/web/components/ContentCardFooter.txt +129 -0
  156. package/mcp-docs/web/components/ContentCardHeader.txt +147 -0
  157. package/mcp-docs/web/components/ContentCell.txt +219 -0
  158. package/mcp-docs/web/components/ControlGroup.txt +436 -0
  159. package/mcp-docs/web/components/DatePicker.txt +505 -0
  160. package/mcp-docs/web/components/Divider.txt +143 -0
  161. package/mcp-docs/web/components/DotCount.txt +149 -0
  162. package/mcp-docs/web/components/DotStatusColor.txt +58 -0
  163. package/mcp-docs/web/components/DotSymbol.txt +137 -0
  164. package/mcp-docs/web/components/Dropdown.txt +119 -0
  165. package/mcp-docs/web/components/Fallback.txt +163 -0
  166. package/mcp-docs/web/components/FloatingAssetCard.txt +250 -0
  167. package/mcp-docs/web/components/FullscreenAlert.txt +69 -0
  168. package/mcp-docs/web/components/FullscreenModal.txt +145 -0
  169. package/mcp-docs/web/components/FullscreenModalLayout.txt +187 -0
  170. package/mcp-docs/web/components/Grid.txt +236 -0
  171. package/mcp-docs/web/components/GridColumn.txt +209 -0
  172. package/mcp-docs/web/components/HStack.txt +236 -0
  173. package/mcp-docs/web/components/HeroSquare.txt +48 -0
  174. package/mcp-docs/web/components/Icon.txt +145 -0
  175. package/mcp-docs/web/components/IconButton.txt +390 -0
  176. package/mcp-docs/web/components/InputChip.txt +187 -0
  177. package/mcp-docs/web/components/Interactable.txt +193 -0
  178. package/mcp-docs/web/components/LineChart.txt +1576 -0
  179. package/mcp-docs/web/components/Link.txt +243 -0
  180. package/mcp-docs/web/components/ListCell.txt +418 -0
  181. package/mcp-docs/web/components/LogoMark.txt +84 -0
  182. package/mcp-docs/web/components/LogoWordMark.txt +93 -0
  183. package/mcp-docs/web/components/Lottie.txt +157 -0
  184. package/mcp-docs/web/components/LottieStatusAnimation.txt +57 -0
  185. package/mcp-docs/web/components/MediaQueryProvider.txt +108 -0
  186. package/mcp-docs/web/components/Modal.txt +196 -0
  187. package/mcp-docs/web/components/ModalBody.txt +117 -0
  188. package/mcp-docs/web/components/ModalFooter.txt +119 -0
  189. package/mcp-docs/web/components/ModalHeader.txt +123 -0
  190. package/mcp-docs/web/components/MultiContentModule.txt +381 -0
  191. package/mcp-docs/web/components/NavigationBar.txt +102 -0
  192. package/mcp-docs/web/components/NavigationTitle.txt +25 -0
  193. package/mcp-docs/web/components/NavigationTitleSelect.txt +45 -0
  194. package/mcp-docs/web/components/NudgeCard.txt +181 -0
  195. package/mcp-docs/web/components/Overlay.txt +171 -0
  196. package/mcp-docs/web/components/PageFooter.txt +184 -0
  197. package/mcp-docs/web/components/PageHeader.txt +243 -0
  198. package/mcp-docs/web/components/Pagination.txt +499 -0
  199. package/mcp-docs/web/components/PeriodSelector.txt +703 -0
  200. package/mcp-docs/web/components/Pictogram.txt +48 -0
  201. package/mcp-docs/web/components/Point.txt +460 -0
  202. package/mcp-docs/web/components/PortalProvider.txt +76 -0
  203. package/mcp-docs/web/components/Pressable.txt +193 -0
  204. package/mcp-docs/web/components/ProgressBar.txt +163 -0
  205. package/mcp-docs/web/components/ProgressBarWithFixedLabels.txt +212 -0
  206. package/mcp-docs/web/components/ProgressBarWithFloatLabel.txt +181 -0
  207. package/mcp-docs/web/components/ProgressCircle.txt +443 -0
  208. package/mcp-docs/web/components/Radio.txt +219 -0
  209. package/mcp-docs/web/components/RadioCell.txt +215 -0
  210. package/mcp-docs/web/components/RadioGroup.txt +288 -0
  211. package/mcp-docs/web/components/ReferenceLine.txt +451 -0
  212. package/mcp-docs/web/components/RemoteImage.txt +165 -0
  213. package/mcp-docs/web/components/RemoteImageGroup.txt +86 -0
  214. package/mcp-docs/web/components/RollingNumber.txt +1021 -0
  215. package/mcp-docs/web/components/Scrubber.txt +231 -0
  216. package/mcp-docs/web/components/SearchInput.txt +117 -0
  217. package/mcp-docs/web/components/SectionHeader.txt +217 -0
  218. package/mcp-docs/web/components/SegmentedTabs.txt +324 -0
  219. package/mcp-docs/web/components/Select.txt +224 -0
  220. package/mcp-docs/web/components/SelectChip.txt +314 -0
  221. package/mcp-docs/web/components/SelectOption.txt +165 -0
  222. package/mcp-docs/web/components/Sidebar.txt +349 -0
  223. package/mcp-docs/web/components/SidebarItem.txt +131 -0
  224. package/mcp-docs/web/components/SidebarMoreMenu.txt +30 -0
  225. package/mcp-docs/web/components/Spacer.txt +173 -0
  226. package/mcp-docs/web/components/Sparkline.txt +122 -0
  227. package/mcp-docs/web/components/SparklineGradient.txt +106 -0
  228. package/mcp-docs/web/components/SparklineInteractive.txt +153 -0
  229. package/mcp-docs/web/components/SparklineInteractiveHeader.txt +76 -0
  230. package/mcp-docs/web/components/Spinner.txt +128 -0
  231. package/mcp-docs/web/components/SpotIcon.txt +48 -0
  232. package/mcp-docs/web/components/SpotRectangle.txt +48 -0
  233. package/mcp-docs/web/components/SpotSquare.txt +48 -0
  234. package/mcp-docs/web/components/Stepper.txt +682 -0
  235. package/mcp-docs/web/components/SubBrandLogoMark.txt +125 -0
  236. package/mcp-docs/web/components/SubBrandLogoWordMark.txt +125 -0
  237. package/mcp-docs/web/components/Switch.txt +85 -0
  238. package/mcp-docs/web/components/TabIndicator.txt +48 -0
  239. package/mcp-docs/web/components/TabLabel.txt +158 -0
  240. package/mcp-docs/web/components/TabNavigation.txt +159 -0
  241. package/mcp-docs/web/components/TabbedChips.txt +155 -0
  242. package/mcp-docs/web/components/Table.txt +367 -0
  243. package/mcp-docs/web/components/TableBody.txt +83 -0
  244. package/mcp-docs/web/components/TableCaption.txt +102 -0
  245. package/mcp-docs/web/components/TableCell.txt +165 -0
  246. package/mcp-docs/web/components/TableCellFallback.txt +97 -0
  247. package/mcp-docs/web/components/TableFooter.txt +83 -0
  248. package/mcp-docs/web/components/TableHeader.txt +100 -0
  249. package/mcp-docs/web/components/TableRow.txt +140 -0
  250. package/mcp-docs/web/components/Tabs.txt +212 -0
  251. package/mcp-docs/web/components/Tag.txt +304 -0
  252. package/mcp-docs/web/components/Text.txt +232 -0
  253. package/mcp-docs/web/components/TextInput.txt +652 -0
  254. package/mcp-docs/web/components/ThemeProvider.txt +199 -0
  255. package/mcp-docs/web/components/TileButton.txt +158 -0
  256. package/mcp-docs/web/components/Toast.txt +203 -0
  257. package/mcp-docs/web/components/Tooltip.txt +89 -0
  258. package/mcp-docs/web/components/Tour.txt +179 -0
  259. package/mcp-docs/web/components/Tray.txt +288 -0
  260. package/mcp-docs/web/components/UpsellCard.txt +319 -0
  261. package/mcp-docs/web/components/VStack.txt +224 -0
  262. package/mcp-docs/web/components/XAxis.txt +619 -0
  263. package/mcp-docs/web/components/YAxis.txt +548 -0
  264. package/mcp-docs/web/getting-started/ai-overview.txt +108 -0
  265. package/mcp-docs/web/getting-started/installation.txt +103 -0
  266. package/mcp-docs/web/getting-started/introduction.txt +102 -0
  267. package/mcp-docs/web/getting-started/playground.txt +28 -0
  268. package/mcp-docs/web/getting-started/styling.txt +161 -0
  269. package/mcp-docs/web/getting-started/templates.txt +121 -0
  270. package/mcp-docs/web/getting-started/theming.txt +426 -0
  271. package/mcp-docs/web/hooks/useBreakpoints.txt +61 -0
  272. package/mcp-docs/web/hooks/useDimensions.txt +114 -0
  273. package/mcp-docs/web/hooks/useEventHandler.txt +120 -0
  274. package/mcp-docs/web/hooks/useHasMounted.txt +75 -0
  275. package/mcp-docs/web/hooks/useIsoEffect.txt +58 -0
  276. package/mcp-docs/web/hooks/useMediaQuery.txt +114 -0
  277. package/mcp-docs/web/hooks/useMergeRefs.txt +116 -0
  278. package/mcp-docs/web/hooks/useOverlayContentContext.txt +279 -0
  279. package/mcp-docs/web/hooks/usePreviousValue.txt +74 -0
  280. package/mcp-docs/web/hooks/useRefMap.txt +178 -0
  281. package/mcp-docs/web/hooks/useScrollBlocker.txt +82 -0
  282. package/mcp-docs/web/hooks/useTheme.txt +364 -0
  283. package/mcp-docs/web/routes.txt +163 -0
  284. package/package.json +1 -1
@@ -0,0 +1,48 @@
1
+ # Pictogram
2
+
3
+ Displays elevated product icons.
4
+
5
+ ## Import
6
+
7
+ ```tsx
8
+ import { Pictogram } from '@coinbase/cds-web/illustrations/Pictogram'
9
+ ```
10
+
11
+ ## Examples
12
+
13
+ ### Basic example
14
+
15
+ ```jsx live
16
+ <Pictogram name="shield" dimension="64x64" />
17
+ ```
18
+
19
+ ### `scaleMultiplier` prop
20
+
21
+ If no predefined dimensions fit your use case, you can use the `scaleMultiplier` prop to scale the illustration.
22
+
23
+ Use `scaleMultiplier` sparingly and with caution. We have predefined dimensions to ensure that illustrations scale elegantly.
24
+
25
+ ```jsx live
26
+ <Pictogram name="shield" scaleMultiplier={1.5} />
27
+ ```
28
+
29
+ ### Scaling with dimension
30
+
31
+ If `dimension` and `scaleMultiplier` are both provided the component will scale based on the provided dimension.
32
+
33
+ ```jsx live
34
+ <Pictogram name="shield" dimension="48x48" scaleMultiplier={2.5} />
35
+ ```
36
+
37
+ ## Props
38
+
39
+ | Prop | Type | Required | Default | Description |
40
+ | --- | --- | --- | --- | --- |
41
+ | `name` | `key \| done \| cardSuccess \| warning \| error \| add \| browser \| calculator \| calendar \| checkmark \| clock \| coinbaseOneLogo \| derivativesProduct \| email \| gasFees \| identityCard \| instantUnstakingClock \| laptop \| learningRewardsProduct \| lock \| passport \| paypal \| phone \| planet \| safe \| securityKey \| settings \| shield \| support \| taxes \| tokenSales \| trading \| verifiedPools \| wallet \| 2fa \| accountsNavigation \| accreditedInvestor \| addCard \| addPayment \| addPhone \| addressBook \| addToWatchlist \| addWallet \| advancedTradingDesktop \| advancedTradingNavigation \| advancedTradingRebates \| agent \| alerts \| alertsCoinbaseOne \| analyticsNavigation \| apartOfDropsNft \| applyForHigherLimits \| apyInterest \| assetEncryption \| assetHubNavigation \| assetManagement \| assetManagementNavigation \| assetMeasurements \| assetMovement \| authenticationApp \| authenticator \| authenticatorAlt \| authenticatorProgress \| avatarAa \| avatarAb \| avatarAc \| avatarAd \| avatarAe \| avatarAf \| avatarAg \| avatarAh \| avatarAi \| avatarAj \| avatarBa \| avatarBb \| avatarBc \| avatarBd \| avatarBe \| avatarBf \| avatarBg \| avatarBh \| avatarBi \| avatarBj \| avatarCa \| avatarCb \| avatarCc \| avatarCd \| avatarCe \| avatarCf \| avatarCg \| avatarCh \| avatarCi \| avatarCj \| avatarDa \| avatarDb \| avatarDc \| avatarDd \| avatarDe \| avatarDf \| avatarDg \| avatarDh \| avatarDi \| avatarDj \| avatarEa \| avatarEb \| avatarEc \| avatarEd \| avatarEe \| avatarEf \| avatarEg \| avatarEh \| avatarEi \| avatarEj \| avatarFa \| avatarFb \| avatarFc \| avatarFd \| avatarFe \| avatarFf \| avatarFg \| avatarFh \| avatarFi \| avatarFj \| avatarGa \| avatarGb \| avatarGc \| avatarGd \| avatarGe \| avatarGf \| avatarGg \| avatarGh \| avatarGi \| avatarGj \| avatarHa \| avatarHb \| avatarHc \| avatarHd \| avatarHe \| avatarHf \| avatarHg \| avatarHh \| avatarHi \| avatarHj \| avatarIa \| avatarIb \| avatarIc \| avatarId \| avatarIe \| avatarIf \| avatarIg \| avatarIh \| avatarIi \| avatarIj \| avatarJa \| avatarJb \| avatarJc \| avatarJd \| avatarJe \| avatarJf \| avatarJg \| avatarJh \| avatarJi \| avatarJj \| barChart \| baseChartSmall \| baseCheckSmall \| baseCoinCryptoSmall \| baseCoinNetworkSmall \| baseCoinStack \| baseConnectApps \| baseConnectSmall \| baseDecentralizationSmall \| baseDiamondSmall \| baseDiamondTrophy \| baseEmptySmall \| baseErrorButterflySmall \| baseErrorSmall \| baseLoadingSmall \| baseLocationSmall \| baseLogo \| baseLogoNavigation \| baseMessaging \| baseMintNftSmall \| baseNetworkSmall \| baseNftSmall \| basePaycoinSmall \| basePeopleSmall \| basePiechartSmall \| baseSecuritySmall \| baseSendSmall \| baseSignin \| baseTargetSmall \| bitcoin \| bitcoinPizza \| bitcoinRewards \| bitcoinWhitePaper \| blockchainConnection \| bonusFivePercent \| bonusTwoPercent \| borrowCoins \| borrowingLending \| borrowNavigation \| browserMultiPlatform \| browserTransaction \| bundle \| businessProduct \| calendarCaution \| candleSticksGraph \| cardBlocked \| cardDeclined \| cardNavigation \| cb1BankTransfers \| chart \| chat \| cloudNavigation \| coinbaseLogoAdvancedBrand \| coinbaseLogoNavigation \| coinbaseOneAuthenticator \| coinbaseOneChat \| coinbaseOneEarn \| coinbaseOneEarnCoins \| coinbaseOneEarnCoinsLogo \| coinbaseOneFiat \| coinbaseOneProductIcon \| coinbaseOneProductInvestWeekly \| coinbaseOneRefreshed \| coinbaseOneShield \| coinbaseOneTrade \| coinbaseOneTrusted \| coinbaseOneUnlimitedRewards \| coinbaseUnlockOffers \| coinbaseWalletApp \| coinFocus \| coinShare \| coldStorageCheck \| collectionOfAssets \| commerceCheckout \| commerceInvoice \| commerceNavigation \| completeQuiz \| complianceNavigation \| congratulations \| connectNavigation \| contactInfo \| controlWalletStorage \| creative \| creditCard \| crypto101 \| cryptoCard \| cryptoFolder \| custodialJourney \| custodyNavigation \| dataMarketplaceNavigation \| decentralizationEverything \| decentralizedExchange \| decentralizedIdentity \| decentralizedWeb3 \| defiEarnMoment \| delegate \| delegateNavigation \| derivativesNavigation \| developerPlatformNavigation \| developerSDKNavigation \| directDepositNavigation \| dollarShowcase \| driversLicense \| driversLicenseWheel \| earnCoins \| earnGraph \| earnNavigation \| easyToUse \| economyGlobal \| emailAndMessages \| enableVoting \| envelope \| ethereumFocus \| ethRewards \| ethStaking \| ethStakingChart \| ethStakingRewards \| ethToken \| exchangeNavigation \| explore \| fast \| faucetNavigation \| feesRestriction \| fiat \| finance \| findYourSelection \| formDownload \| futures \| futuresCoinbaseOne \| gem \| genericCountryIDCard \| getStarted \| giftbox \| globalConnections \| globalPayments \| globalTransactions \| googleAuthenticator \| governance \| hardwareWallet \| helpCenterNavigation \| higherLimits \| holdingCoin \| idBlock \| idError \| idVerification \| increaseLimits \| institutionalNavigation \| institutions \| internationalExchangeNavigation \| internet \| investGraph \| laptopCharts \| laptopVideo \| layerNetworks \| leadGraph \| learn \| learningRewardsNavigation \| lightbulbLearn \| lightningNetworkSend \| linkYourAccount \| listingFees \| locationUsa \| lowFees \| manageWeb3SignersAcct \| miningCoins \| mintedNft \| mobileCharts \| mobileError \| mobileNotifcation \| mobileSuccess \| mobileWarning \| moneyEarn \| moneySwift \| monitoringPerformance \| moreThanBitcoin \| multiAccountsAndCards \| multiPlatform \| multipleAssets \| musicAndSounds \| myNumberCard \| newUserChecklistBuyCrypto \| newUserChecklistCompleteAccount \| newUserChecklistVerifyId \| nftAvatar \| nftLibrary \| nftNavigation \| noAnnualFee \| noNftFound \| notificationHubAnalysis \| notificationHubNews \| notificationHubPortfolio \| notificationHubSocial \| notifications \| noVisibility \| noWiFi \| orders \| outage \| partialCoins \| participateNavigation \| passwordWalletLocked \| payNavigation \| peerToPeer \| pieChart \| pizza \| pluginBrowser \| positiveReviews \| predictionMarkets \| premiumInvestor \| priceTracking \| primeMobileApp \| primeNavigation \| privateClientNavigation \| proNavigation \| protectionPlan \| queryTransactNavigation \| receipt \| recurringPurchases \| restaking \| reviewAndAdd \| rewardsNavigation \| riskStaking \| rosettaNavigation \| securedAssets \| security \| securityCoinShield \| seedPhrase \| selectAddNft \| selfCustodyWallet \| selfServe \| sellSendAnytime \| sendPaymentToOthers \| settled \| sideChainSide \| signInNavigation \| smsAuthenticate \| sparkleCoinbaseOne \| ssnCard \| stableCoinMetaphor \| stacking \| stakingGraph \| standWithCryptoLogoNavigation \| startToday \| strongInfo \| strongWarning \| successPhone \| supportChat \| takeQuiz \| target \| taxBeta \| taxCenterNavigation \| taxesArrangement \| taxSeason \| timingCheck \| tokenBaskets \| transferSend \| transistor \| trendingAssets \| trusted \| tryAgainLater \| twoBonus \| typeScript \| ubiKey \| usaProduct \| usdcEarn \| usdcInterest \| usdcLoan \| usdcLogo \| usdcRewards \| usdcRewardsRibbon \| usdcToken \| venturesNavigation \| videoCalendar \| videoContent \| waiting \| waitingForConsensus \| walletAsServiceNavigation \| walletDeposit \| walletError \| walletExchange \| walletLinkNavigation \| walletLogoNavigation \| walletNavigation \| walletPassword \| walletSuccess \| walletWarning \| winBTC \| worldwide \| wrapEth` | Yes | `-` | Name of illustration as defined in Figma |
42
+ | `alt` | `string` | No | `"" will identify the image as decorative` | Alt tag to apply to the img |
43
+ | `dimension` | `48x48 \| 64x64` | No | `-` | HeroSquare Default: 240x240 SpotSquare Default: 96x96 Pictogram Default: 48x48 SpotRectangle Default: 240x120 |
44
+ | `fallback` | `ReactElement<any, string \| JSXElementConstructor<any>> \| null` | No | `null` | Fallback element to render if unable to find an illustration with the matching name |
45
+ | `scaleMultiplier` | `number` | No | `-` | Multiply the width & height while maintaining aspect ratio |
46
+ | `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
47
+
48
+
@@ -0,0 +1,460 @@
1
+ # Point
2
+
3
+ Visual markers that highlight specific data values on a chart. Points can be customized with different colors, sizes, and interactivity.
4
+
5
+ ## Import
6
+
7
+ ```tsx
8
+ import { Point } from '@coinbase/cds-web-visualization'
9
+ ```
10
+
11
+ ## Examples
12
+
13
+ ### Basic Example
14
+
15
+ Points are visual markers that highlight specific data values on a chart. They can be used to emphasize important data points, show discrete values, or provide interactive elements.
16
+
17
+ ```jsx live
18
+ <LineChart
19
+ enableScrubbing
20
+ height={{ base: 150, tablet: 200, desktop: 250 }}
21
+ series={[
22
+ {
23
+ id: 'prices',
24
+ data: [10, 22, 29, 45, 98, 45, 22, 52, 21, 4, 68, 20, 21, 58],
25
+ },
26
+ ]}
27
+ curve="monotone"
28
+ showYAxis
29
+ showArea
30
+ yAxis={{
31
+ showGrid: true,
32
+ }}
33
+ renderPoints={() => true}
34
+ >
35
+ <Scrubber />
36
+ </LineChart>
37
+ ```
38
+
39
+ ### Conditional Points
40
+
41
+ You can conditionally render points to highlight specific values in your data, such as maximum/minimum values or outliers.
42
+
43
+ ```jsx live
44
+ function AssetPriceWithMinMax() {
45
+ const data = sparklineInteractiveData.hour.map((d) => d.value);
46
+
47
+ const minPrice = Math.min(...data);
48
+ const maxPrice = Math.max(...data);
49
+
50
+ const formatPrice = useCallback((price: number) => {
51
+ return new Intl.NumberFormat('en-US', {
52
+ style: 'currency',
53
+ currency: 'USD',
54
+ }).format(price);
55
+ }, []);
56
+
57
+ return (
58
+ <LineChart
59
+ series={[
60
+ {
61
+ id: 'btc',
62
+ data: data,
63
+ color: assets.btc.color,
64
+ },
65
+ ]}
66
+ showArea
67
+ areaType="dotted"
68
+ height={{ base: 150, tablet: 200, desktop: 250 }}
69
+ style={{ outlineColor: assets.btc.color }}
70
+ renderPoints={({ dataX, dataY }) => {
71
+ const isMin = dataY === minPrice;
72
+ const isMax = dataY === maxPrice;
73
+
74
+ if (isMin) {
75
+ return { label: formatPrice(dataY), labelProps: { dy: 6, verticalAlignment: 'top' } };
76
+ }
77
+
78
+ if (isMax) {
79
+ return { label: formatPrice(dataY), labelProps: { dy: -6, verticalAlignment: 'bottom' } };
80
+ }
81
+ }}
82
+ />
83
+ );
84
+ };
85
+ ```
86
+
87
+ ### Interactive Points
88
+
89
+ Points can be made interactive by adding click handlers, allowing users to explore data in more detail.
90
+
91
+ ```jsx live
92
+ <LineChart
93
+ height={{ base: 150, tablet: 200, desktop: 250 }}
94
+ series={[
95
+ {
96
+ id: 'sales',
97
+ data: [120, 132, 101, 134, 90, 230, 210, 120, 180, 190, 210, 176],
98
+ },
99
+ ]}
100
+ curve="monotone"
101
+ showYAxis
102
+ showArea
103
+ yAxis={{
104
+ showGrid: true,
105
+ label: 'Sales (units)',
106
+ }}
107
+ renderPoints={({ dataX, dataY }) => {
108
+ const months = [
109
+ 'Jan',
110
+ 'Feb',
111
+ 'Mar',
112
+ 'Apr',
113
+ 'May',
114
+ 'Jun',
115
+ 'Jul',
116
+ 'Aug',
117
+ 'Sep',
118
+ 'Oct',
119
+ 'Nov',
120
+ 'Dec',
121
+ ];
122
+ return {
123
+ radius: 4,
124
+ onClick: () => alert(`${months[dataX]}: ${dataY} units sold`),
125
+ accessibilityLabel: `${months[dataX]} sales: ${dataY} units`,
126
+ };
127
+ }}
128
+ />
129
+ ```
130
+
131
+ ### Customization
132
+
133
+ Points support extensive customization through various properties including colors, sizes, animations, and labels.
134
+
135
+ ```jsx live
136
+ <LineChart
137
+ height={{ base: 150, tablet: 200, desktop: 250 }}
138
+ series={[
139
+ {
140
+ id: 'performance',
141
+ data: [65, 70, 72, 85, 88, 92, 78, 82, 90, 95, 91, 94],
142
+ },
143
+ ]}
144
+ curve="monotone"
145
+ showYAxis
146
+ showArea
147
+ yAxis={{
148
+ showGrid: true,
149
+ label: 'Performance Score',
150
+ }}
151
+ renderPoints={({ dataX, dataY }) => {
152
+ const isHighPerformance = dataY >= 90;
153
+ const isLowPerformance = dataY < 75;
154
+
155
+ return {
156
+ fill: isHighPerformance
157
+ ? 'var(--color-bgPositive)'
158
+ : isLowPerformance
159
+ ? 'var(--color-bgNegative)'
160
+ : 'var(--color-fgPrimary)',
161
+ radius: isHighPerformance ? 6 : 4,
162
+ strokeWidth: 2,
163
+ stroke: 'var(--color-bg)',
164
+ label: isHighPerformance || isLowPerformance ? `${dataY}%` : undefined,
165
+ labelProps: {
166
+ verticalAlignment: isHighPerformance ? 'bottom' : 'top',
167
+ dy: isHighPerformance ? -10 : 10,
168
+ color: isHighPerformance
169
+ ? 'var(--color-fgPositive)'
170
+ : isLowPerformance
171
+ ? 'var(--color-fgNegative)'
172
+ : undefined,
173
+ },
174
+ };
175
+ }}
176
+ />
177
+ ```
178
+
179
+ ## Props
180
+
181
+ | Prop | Type | Required | Default | Description |
182
+ | --- | --- | --- | --- | --- |
183
+ | `dataX` | `number` | Yes | `-` | X coordinate in data space (not pixel coordinates). |
184
+ | `dataY` | `number` | Yes | `-` | Y coordinate in data space (not pixel coordinates). |
185
+ | `accentHeight` | `string \| number` | No | `-` | - |
186
+ | `accessibilityLabel` | `string` | No | `-` | Accessibility label for screen readers to describe the point. If not provided, a default label will be generated using the data coordinates. |
187
+ | `accumulate` | `none \| sum` | No | `-` | - |
188
+ | `additive` | `sum \| replace` | No | `-` | - |
189
+ | `alignmentBaseline` | `alphabetic \| hanging \| ideographic \| mathematical \| inherit \| auto \| baseline \| before-edge \| text-before-edge \| middle \| central \| after-edge \| text-after-edge` | No | `-` | - |
190
+ | `allowReorder` | `no \| yes` | No | `-` | - |
191
+ | `alphabetic` | `string \| number` | No | `-` | - |
192
+ | `amplitude` | `string \| number` | No | `-` | - |
193
+ | `animate` | `boolean` | No | `-` | Override the charts animation setting for this specific point. When undefined, uses the chart contexts animation setting. |
194
+ | `arabicForm` | `initial \| medial \| terminal \| isolated` | No | `-` | - |
195
+ | `ascent` | `string \| number` | No | `-` | - |
196
+ | `attributeName` | `string` | No | `-` | - |
197
+ | `attributeType` | `string` | No | `-` | - |
198
+ | `autoReverse` | `false \| true \| true \| false` | No | `-` | - |
199
+ | `azimuth` | `string \| number` | No | `-` | - |
200
+ | `baseFrequency` | `string \| number` | No | `-` | - |
201
+ | `baseProfile` | `string \| number` | No | `-` | - |
202
+ | `baselineShift` | `string \| number` | No | `-` | - |
203
+ | `bbox` | `string \| number` | No | `-` | - |
204
+ | `begin` | `string \| number` | No | `-` | - |
205
+ | `bias` | `string \| number` | No | `-` | - |
206
+ | `by` | `string \| number` | No | `-` | - |
207
+ | `calcMode` | `string \| number` | No | `-` | - |
208
+ | `capHeight` | `string \| number` | No | `-` | - |
209
+ | `className` | `string` | No | `-` | Custom class name for the point. |
210
+ | `classNames` | `{ container?: string; point?: string \| undefined; } \| undefined` | No | `-` | Custom class names for the component. |
211
+ | `clip` | `string \| number` | No | `-` | - |
212
+ | `clipPath` | `string` | No | `-` | - |
213
+ | `clipPathUnits` | `string \| number` | No | `-` | - |
214
+ | `clipRule` | `string \| number` | No | `-` | - |
215
+ | `color` | `string` | No | `-` | - |
216
+ | `colorInterpolation` | `string \| number` | No | `-` | - |
217
+ | `colorInterpolationFilters` | `inherit \| auto \| sRGB \| linearRGB` | No | `-` | - |
218
+ | `colorProfile` | `string \| number` | No | `-` | - |
219
+ | `colorRendering` | `string \| number` | No | `-` | - |
220
+ | `contentScriptType` | `string \| number` | No | `-` | - |
221
+ | `contentStyleType` | `string \| number` | No | `-` | - |
222
+ | `crossOrigin` | ` \| anonymous \| use-credentials` | No | `-` | - |
223
+ | `cursor` | `string \| number` | No | `-` | - |
224
+ | `cx` | `string \| number` | No | `-` | - |
225
+ | `cy` | `string \| number` | No | `-` | - |
226
+ | `d` | `string` | No | `-` | - |
227
+ | `decelerate` | `string \| number` | No | `-` | - |
228
+ | `descent` | `string \| number` | No | `-` | - |
229
+ | `diffuseConstant` | `string \| number` | No | `-` | - |
230
+ | `direction` | `string \| number` | No | `-` | - |
231
+ | `display` | `string \| number` | No | `-` | - |
232
+ | `divisor` | `string \| number` | No | `-` | - |
233
+ | `dominantBaseline` | `string \| number` | No | `-` | - |
234
+ | `dur` | `string \| number` | No | `-` | - |
235
+ | `dx` | `string \| number` | No | `-` | - |
236
+ | `dy` | `string \| number` | No | `-` | - |
237
+ | `edgeMode` | `string \| number` | No | `-` | - |
238
+ | `elevation` | `string \| number` | No | `-` | - |
239
+ | `enableBackground` | `string \| number` | No | `-` | - |
240
+ | `end` | `string \| number` | No | `-` | - |
241
+ | `exponent` | `string \| number` | No | `-` | - |
242
+ | `externalResourcesRequired` | `false \| true \| true \| false` | No | `-` | - |
243
+ | `fill` | `string` | No | `-` | The fill color of the point. |
244
+ | `fillOpacity` | `string \| number` | No | `-` | - |
245
+ | `fillRule` | `inherit \| nonzero \| evenodd` | No | `-` | - |
246
+ | `filter` | `string` | No | `-` | - |
247
+ | `filterRes` | `string \| number` | No | `-` | - |
248
+ | `filterUnits` | `string \| number` | No | `-` | - |
249
+ | `floodColor` | `string \| number` | No | `-` | - |
250
+ | `floodOpacity` | `string \| number` | No | `-` | - |
251
+ | `focusable` | `auto \| Booleanish` | No | `-` | - |
252
+ | `fontFamily` | `string` | No | `-` | - |
253
+ | `fontSize` | `string \| number` | No | `-` | - |
254
+ | `fontSizeAdjust` | `string \| number` | No | `-` | - |
255
+ | `fontStretch` | `string \| number` | No | `-` | - |
256
+ | `fontStyle` | `string \| number` | No | `-` | - |
257
+ | `fontVariant` | `string \| number` | No | `-` | - |
258
+ | `fontWeight` | `string \| number` | No | `-` | - |
259
+ | `format` | `string \| number` | No | `-` | - |
260
+ | `fr` | `string \| number` | No | `-` | - |
261
+ | `from` | `string \| number` | No | `-` | - |
262
+ | `fx` | `string \| number` | No | `-` | - |
263
+ | `fy` | `string \| number` | No | `-` | - |
264
+ | `g1` | `string \| number` | No | `-` | - |
265
+ | `g2` | `string \| number` | No | `-` | - |
266
+ | `glyphName` | `string \| number` | No | `-` | - |
267
+ | `glyphOrientationHorizontal` | `string \| number` | No | `-` | - |
268
+ | `glyphOrientationVertical` | `string \| number` | No | `-` | - |
269
+ | `glyphRef` | `string \| number` | No | `-` | - |
270
+ | `gradientTransform` | `string` | No | `-` | - |
271
+ | `gradientUnits` | `string` | No | `-` | - |
272
+ | `hanging` | `string \| number` | No | `-` | - |
273
+ | `height` | `string \| number` | No | `-` | - |
274
+ | `horizAdvX` | `string \| number` | No | `-` | - |
275
+ | `horizOriginX` | `string \| number` | No | `-` | - |
276
+ | `href` | `string` | No | `-` | - |
277
+ | `id` | `string` | No | `-` | - |
278
+ | `ideographic` | `string \| number` | No | `-` | - |
279
+ | `imageRendering` | `string \| number` | No | `-` | - |
280
+ | `in` | `string` | No | `-` | - |
281
+ | `in2` | `string \| number` | No | `-` | - |
282
+ | `intercept` | `string \| number` | No | `-` | - |
283
+ | `k` | `string \| number` | No | `-` | - |
284
+ | `k1` | `string \| number` | No | `-` | - |
285
+ | `k2` | `string \| number` | No | `-` | - |
286
+ | `k3` | `string \| number` | No | `-` | - |
287
+ | `k4` | `string \| number` | No | `-` | - |
288
+ | `kernelMatrix` | `string \| number` | No | `-` | - |
289
+ | `kernelUnitLength` | `string \| number` | No | `-` | - |
290
+ | `kerning` | `string \| number` | No | `-` | - |
291
+ | `key` | `Key \| null` | No | `-` | - |
292
+ | `keyPoints` | `string \| number` | No | `-` | - |
293
+ | `keySplines` | `string \| number` | No | `-` | - |
294
+ | `keyTimes` | `string \| number` | No | `-` | - |
295
+ | `label` | `null \| string \| number \| ReactElement<TSpanProps, TSpan> \| ReactElement<TextPathProps, TextPath> \| ValidChartTextChildElements[]` | No | `-` | Simple text label to display at the point position. If provided, a ChartText will be automatically rendered. |
296
+ | `labelProps` | `Omit<ChartTextProps, x \| y \| children>` | No | `-` | Configuration for the automatically rendered label. Only used when label prop is provided. |
297
+ | `lang` | `string` | No | `-` | - |
298
+ | `lengthAdjust` | `string \| number` | No | `-` | - |
299
+ | `letterSpacing` | `string \| number` | No | `-` | - |
300
+ | `lightingColor` | `string \| number` | No | `-` | - |
301
+ | `limitingConeAngle` | `string \| number` | No | `-` | - |
302
+ | `local` | `string \| number` | No | `-` | - |
303
+ | `markerEnd` | `string` | No | `-` | - |
304
+ | `markerHeight` | `string \| number` | No | `-` | - |
305
+ | `markerMid` | `string` | No | `-` | - |
306
+ | `markerStart` | `string` | No | `-` | - |
307
+ | `markerUnits` | `string \| number` | No | `-` | - |
308
+ | `markerWidth` | `string \| number` | No | `-` | - |
309
+ | `mask` | `string` | No | `-` | - |
310
+ | `maskContentUnits` | `string \| number` | No | `-` | - |
311
+ | `maskUnits` | `string \| number` | No | `-` | - |
312
+ | `mathematical` | `string \| number` | No | `-` | - |
313
+ | `max` | `string \| number` | No | `-` | - |
314
+ | `media` | `string` | No | `-` | - |
315
+ | `method` | `string` | No | `-` | - |
316
+ | `min` | `string \| number` | No | `-` | - |
317
+ | `mode` | `string \| number` | No | `-` | - |
318
+ | `name` | `string` | No | `-` | - |
319
+ | `numOctaves` | `string \| number` | No | `-` | - |
320
+ | `offset` | `string \| number` | No | `-` | - |
321
+ | `onChange` | `FormEventHandler<SVGCircleElement>` | No | `-` | - |
322
+ | `onClick` | `((event: MouseEvent<Element, MouseEvent>, point: { x: number; y: number; dataX: number; dataY: number; }) => void)` | No | `-` | Handler for when the point is clicked. |
323
+ | `onScrubberEnter` | `((point: { x: number; y: number; }) => void)` | No | `-` | Handler for when the scrubber enters this point. |
324
+ | `opacity` | `number` | No | `-` | Opacity of the point. |
325
+ | `operator` | `string \| number` | No | `-` | - |
326
+ | `order` | `string \| number` | No | `-` | - |
327
+ | `orient` | `string \| number` | No | `-` | - |
328
+ | `orientation` | `string \| number` | No | `-` | - |
329
+ | `origin` | `string \| number` | No | `-` | - |
330
+ | `overflow` | `string \| number` | No | `-` | - |
331
+ | `overlinePosition` | `string \| number` | No | `-` | - |
332
+ | `overlineThickness` | `string \| number` | No | `-` | - |
333
+ | `paintOrder` | `string \| number` | No | `-` | - |
334
+ | `panose1` | `string \| number` | No | `-` | - |
335
+ | `path` | `string` | No | `-` | - |
336
+ | `pathLength` | `string \| number` | No | `-` | - |
337
+ | `patternContentUnits` | `string` | No | `-` | - |
338
+ | `patternTransform` | `string \| number` | No | `-` | - |
339
+ | `patternUnits` | `string` | No | `-` | - |
340
+ | `pixelCoordinates` | `{ x: number; y: number; }` | No | `-` | Coordinates in SVG pixel space. Overrides dataX and dataY for pixel coordinate calculation. |
341
+ | `pointerEvents` | `string \| number` | No | `-` | - |
342
+ | `points` | `string` | No | `-` | - |
343
+ | `pointsAtX` | `string \| number` | No | `-` | - |
344
+ | `pointsAtY` | `string \| number` | No | `-` | - |
345
+ | `pointsAtZ` | `string \| number` | No | `-` | - |
346
+ | `preserveAlpha` | `false \| true \| true \| false` | No | `-` | - |
347
+ | `preserveAspectRatio` | `string` | No | `-` | - |
348
+ | `primitiveUnits` | `string \| number` | No | `-` | - |
349
+ | `r` | `string \| number` | No | `-` | - |
350
+ | `radius` | `number` | No | `4` | Radius of the point. |
351
+ | `ref` | `null \| string \| (instance: SVGCircleElement \| null) => void \| RefObject<SVGCircleElement>` | No | `-` | Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref). |
352
+ | `refX` | `string \| number` | No | `-` | - |
353
+ | `refY` | `string \| number` | No | `-` | - |
354
+ | `renderingIntent` | `string \| number` | No | `-` | - |
355
+ | `repeatCount` | `string \| number` | No | `-` | - |
356
+ | `repeatDur` | `string \| number` | No | `-` | - |
357
+ | `requiredExtensions` | `string \| number` | No | `-` | - |
358
+ | `requiredFeatures` | `string \| number` | No | `-` | - |
359
+ | `restart` | `string \| number` | No | `-` | - |
360
+ | `result` | `string` | No | `-` | - |
361
+ | `role` | `grid \| article \| button \| dialog \| figure \| form \| img \| link \| main \| menu \| menuitem \| option \| search \| table \| switch \| string & {} \| none \| row \| alert \| alertdialog \| application \| banner \| cell \| checkbox \| columnheader \| combobox \| complementary \| contentinfo \| definition \| directory \| document \| feed \| gridcell \| group \| heading \| list \| listbox \| listitem \| log \| marquee \| math \| menubar \| menuitemcheckbox \| menuitemradio \| navigation \| note \| presentation \| progressbar \| radio \| radiogroup \| region \| rowgroup \| rowheader \| scrollbar \| searchbox \| separator \| slider \| spinbutton \| status \| tab \| tablist \| tabpanel \| term \| textbox \| timer \| toolbar \| tooltip \| tree \| treegrid \| treeitem` | No | `-` | - |
362
+ | `rotate` | `string \| number` | No | `-` | - |
363
+ | `rx` | `string \| number` | No | `-` | - |
364
+ | `ry` | `string \| number` | No | `-` | - |
365
+ | `scale` | `string \| number` | No | `-` | - |
366
+ | `seed` | `string \| number` | No | `-` | - |
367
+ | `shapeRendering` | `string \| number` | No | `-` | - |
368
+ | `slope` | `string \| number` | No | `-` | - |
369
+ | `spacing` | `string \| number` | No | `-` | - |
370
+ | `specularConstant` | `string \| number` | No | `-` | - |
371
+ | `specularExponent` | `string \| number` | No | `-` | - |
372
+ | `speed` | `string \| number` | No | `-` | - |
373
+ | `spreadMethod` | `string` | No | `-` | - |
374
+ | `startOffset` | `string \| number` | No | `-` | - |
375
+ | `stdDeviation` | `string \| number` | No | `-` | - |
376
+ | `stemh` | `string \| number` | No | `-` | - |
377
+ | `stemv` | `string \| number` | No | `-` | - |
378
+ | `stitchTiles` | `string \| number` | No | `-` | - |
379
+ | `stopColor` | `string` | No | `-` | - |
380
+ | `stopOpacity` | `string \| number` | No | `-` | - |
381
+ | `strikethroughPosition` | `string \| number` | No | `-` | - |
382
+ | `strikethroughThickness` | `string \| number` | No | `-` | - |
383
+ | `string` | `string \| number` | No | `-` | - |
384
+ | `stroke` | `string` | No | `'var(--color-bg)'` | Color of the outer stroke around the point. |
385
+ | `strokeDasharray` | `string \| number` | No | `-` | - |
386
+ | `strokeDashoffset` | `string \| number` | No | `-` | - |
387
+ | `strokeLinecap` | `inherit \| butt \| round \| square` | No | `-` | - |
388
+ | `strokeLinejoin` | `inherit \| round \| miter \| bevel` | No | `-` | - |
389
+ | `strokeMiterlimit` | `string \| number` | No | `-` | - |
390
+ | `strokeOpacity` | `string \| number` | No | `-` | - |
391
+ | `strokeWidth` | `number` | No | `2` | Outer stroke width of the point. Set to 0 to remove the stroke. |
392
+ | `style` | `CSSProperties` | No | `-` | Custom styles for the point. |
393
+ | `styles` | `{ container?: CSSProperties; point?: CSSProperties \| undefined; } \| undefined` | No | `-` | Custom styles for the component. |
394
+ | `suppressHydrationWarning` | `boolean` | No | `-` | - |
395
+ | `surfaceScale` | `string \| number` | No | `-` | - |
396
+ | `systemLanguage` | `string \| number` | No | `-` | - |
397
+ | `tabIndex` | `number` | No | `-` | - |
398
+ | `tableValues` | `string \| number` | No | `-` | - |
399
+ | `target` | `string` | No | `-` | - |
400
+ | `targetX` | `string \| number` | No | `-` | - |
401
+ | `targetY` | `string \| number` | No | `-` | - |
402
+ | `testID` | `string` | No | `-` | Used to locate this element in unit and end-to-end tests. Under the hood, testID translates to data-testid on Web. On Mobile, testID stays the same - testID |
403
+ | `textAnchor` | `string` | No | `-` | - |
404
+ | `textDecoration` | `string \| number` | No | `-` | - |
405
+ | `textLength` | `string \| number` | No | `-` | - |
406
+ | `textRendering` | `string \| number` | No | `-` | - |
407
+ | `to` | `string \| number` | No | `-` | - |
408
+ | `transform` | `string` | No | `-` | - |
409
+ | `type` | `string` | No | `-` | - |
410
+ | `u1` | `string \| number` | No | `-` | - |
411
+ | `u2` | `string \| number` | No | `-` | - |
412
+ | `underlinePosition` | `string \| number` | No | `-` | - |
413
+ | `underlineThickness` | `string \| number` | No | `-` | - |
414
+ | `unicode` | `string \| number` | No | `-` | - |
415
+ | `unicodeBidi` | `string \| number` | No | `-` | - |
416
+ | `unicodeRange` | `string \| number` | No | `-` | - |
417
+ | `unitsPerEm` | `string \| number` | No | `-` | - |
418
+ | `vAlphabetic` | `string \| number` | No | `-` | - |
419
+ | `vHanging` | `string \| number` | No | `-` | - |
420
+ | `vIdeographic` | `string \| number` | No | `-` | - |
421
+ | `vMathematical` | `string \| number` | No | `-` | - |
422
+ | `values` | `string` | No | `-` | - |
423
+ | `vectorEffect` | `string \| number` | No | `-` | - |
424
+ | `version` | `string` | No | `-` | - |
425
+ | `vertAdvY` | `string \| number` | No | `-` | - |
426
+ | `vertOriginX` | `string \| number` | No | `-` | - |
427
+ | `vertOriginY` | `string \| number` | No | `-` | - |
428
+ | `viewBox` | `string` | No | `-` | - |
429
+ | `viewTarget` | `string \| number` | No | `-` | - |
430
+ | `visibility` | `string \| number` | No | `-` | - |
431
+ | `width` | `string \| number` | No | `-` | - |
432
+ | `widths` | `string \| number` | No | `-` | - |
433
+ | `wordSpacing` | `string \| number` | No | `-` | - |
434
+ | `writingMode` | `string \| number` | No | `-` | - |
435
+ | `x` | `string \| number` | No | `-` | - |
436
+ | `x1` | `string \| number` | No | `-` | - |
437
+ | `x2` | `string \| number` | No | `-` | - |
438
+ | `xChannelSelector` | `string` | No | `-` | - |
439
+ | `xHeight` | `string \| number` | No | `-` | - |
440
+ | `xlinkActuate` | `string` | No | `-` | - |
441
+ | `xlinkArcrole` | `string` | No | `-` | - |
442
+ | `xlinkHref` | `string` | No | `-` | - |
443
+ | `xlinkRole` | `string` | No | `-` | - |
444
+ | `xlinkShow` | `string` | No | `-` | - |
445
+ | `xlinkTitle` | `string` | No | `-` | - |
446
+ | `xlinkType` | `string` | No | `-` | - |
447
+ | `xmlBase` | `string` | No | `-` | - |
448
+ | `xmlLang` | `string` | No | `-` | - |
449
+ | `xmlSpace` | `string` | No | `-` | - |
450
+ | `xmlns` | `string` | No | `-` | - |
451
+ | `xmlnsXlink` | `string` | No | `-` | - |
452
+ | `y` | `string \| number` | No | `-` | - |
453
+ | `y1` | `string \| number` | No | `-` | - |
454
+ | `y2` | `string \| number` | No | `-` | - |
455
+ | `yAxisId` | `string` | No | `-` | Optional Y-axis id to specify which axis to plot along. Defaults to the first y-axis |
456
+ | `yChannelSelector` | `string` | No | `-` | - |
457
+ | `z` | `string \| number` | No | `-` | - |
458
+ | `zoomAndPan` | `string` | No | `-` | - |
459
+
460
+
@@ -0,0 +1,76 @@
1
+ # PortalProvider
2
+
3
+ A component that manages the rendering of portals for overlay components.
4
+
5
+ ## Import
6
+
7
+ ```tsx
8
+ import { PortalProvider } from '@coinbase/cds-web/overlays/PortalProvider'
9
+ ```
10
+
11
+ ## Examples
12
+
13
+ ### Basic usage
14
+
15
+ The PortalProvider component is typically used at the root of your application to manage overlay components:
16
+
17
+ ```tsx live
18
+ function Example() {
19
+ return (
20
+ <PortalProvider>
21
+ <Box padding={4} bordered borderRadius={200}>
22
+ Your app content
23
+ </Box>
24
+ </PortalProvider>
25
+ );
26
+ }
27
+ ```
28
+
29
+ ### Custom Portal Nodes
30
+
31
+ You can disable the default portal rendering and use the PortalNodes component separately:
32
+
33
+ ```tsx live
34
+ function Example() {
35
+ return (
36
+ <PortalProvider renderPortals={false}>
37
+ <Box padding={4} bordered borderRadius={200}>
38
+ Your app content
39
+ </Box>
40
+ <PortalNodes />
41
+ </PortalProvider>
42
+ );
43
+ }
44
+ ```
45
+
46
+ ### Toast Example
47
+
48
+ The PortalProvider's `toastBottomOffset` prop sets the default bottom offset for all toasts:
49
+
50
+ ```tsx live
51
+ function Example() {
52
+ function ToastDemo() {
53
+ const toast = useToast();
54
+ return (
55
+ <Box padding={4} bordered borderRadius={200}>
56
+ <Button onClick={() => toast.show('This toast appears with a custom bottom offset (80px)')}>
57
+ Show Toast
58
+ </Button>
59
+ </Box>
60
+ );
61
+ }
62
+
63
+ return (
64
+ <PortalProvider toastBottomOffset={80}>
65
+ <ToastDemo />
66
+ </PortalProvider>
67
+ );
68
+ }
69
+ ```
70
+
71
+ ## Props
72
+
73
+ | Prop | Type | Required | Default | Description |
74
+ | --- | --- | --- | --- | --- |
75
+
76
+