@commercetools/nimbus 0.0.2 → 0.0.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 (302) hide show
  1. package/dist/index.d.ts +1412 -0
  2. package/dist/index.js +11183 -0
  3. package/dist/index.js.map +1 -0
  4. package/dist/index.umd.cjs +27 -0
  5. package/dist/index.umd.cjs.map +1 -0
  6. package/package.json +63 -39
  7. package/.storybook/apca-check/index.ts +0 -150
  8. package/.storybook/main.ts +0 -64
  9. package/.storybook/preview.tsx +0 -92
  10. package/.storybook/vitest.setup.ts +0 -13
  11. package/docs/architecture-decisions/adr-0001-consumer-component-apis.md +0 -177
  12. package/docs/architecture-decisions/adr-0002-compound-component-extraction.md +0 -82
  13. package/src/components/accordion/accordion-context.tsx +0 -17
  14. package/src/components/accordion/accordion.mdx +0 -172
  15. package/src/components/accordion/accordion.recipe.tsx +0 -98
  16. package/src/components/accordion/accordion.slots.tsx +0 -39
  17. package/src/components/accordion/accordion.stories.tsx +0 -188
  18. package/src/components/accordion/accordion.tsx +0 -16
  19. package/src/components/accordion/accordion.types.tsx +0 -54
  20. package/src/components/accordion/components/accordion-content.tsx +0 -28
  21. package/src/components/accordion/components/accordion-group.tsx +0 -27
  22. package/src/components/accordion/components/accordion-header.tsx +0 -63
  23. package/src/components/accordion/components/accordion-item.tsx +0 -87
  24. package/src/components/accordion/index.ts +0 -2
  25. package/src/components/alert/alert.mdx +0 -92
  26. package/src/components/alert/alert.recipe.tsx +0 -65
  27. package/src/components/alert/alert.slots.tsx +0 -46
  28. package/src/components/alert/alert.stories.tsx +0 -308
  29. package/src/components/alert/alert.tsx +0 -18
  30. package/src/components/alert/alert.types.tsx +0 -70
  31. package/src/components/alert/components/alert.actions.tsx +0 -27
  32. package/src/components/alert/components/alert.description.tsx +0 -27
  33. package/src/components/alert/components/alert.dismiss-button.tsx +0 -41
  34. package/src/components/alert/components/alert.root.tsx +0 -92
  35. package/src/components/alert/components/alert.title.tsx +0 -29
  36. package/src/components/alert/index.ts +0 -2
  37. package/src/components/avatar/avatar.mdx +0 -80
  38. package/src/components/avatar/avatar.recipe.tsx +0 -36
  39. package/src/components/avatar/avatar.slots.tsx +0 -16
  40. package/src/components/avatar/avatar.stories.tsx +0 -136
  41. package/src/components/avatar/avatar.tsx +0 -34
  42. package/src/components/avatar/avatar.types.ts +0 -33
  43. package/src/components/avatar/index.ts +0 -2
  44. package/src/components/badge/badge.mdx +0 -91
  45. package/src/components/badge/badge.recipe.tsx +0 -72
  46. package/src/components/badge/badge.slots.tsx +0 -8
  47. package/src/components/badge/badge.stories.tsx +0 -124
  48. package/src/components/badge/badge.tsx +0 -35
  49. package/src/components/badge/badge.types.tsx +0 -40
  50. package/src/components/badge/index.ts +0 -2
  51. package/src/components/bleed/bleed.tsx +0 -1
  52. package/src/components/bleed/index.ts +0 -1
  53. package/src/components/box/box.mdx +0 -115
  54. package/src/components/box/box.stories.tsx +0 -71
  55. package/src/components/box/box.tsx +0 -11
  56. package/src/components/box/index.ts +0 -1
  57. package/src/components/button/button.mdx +0 -169
  58. package/src/components/button/button.recipe.ts +0 -185
  59. package/src/components/button/button.slots.tsx +0 -45
  60. package/src/components/button/button.stories.tsx +0 -369
  61. package/src/components/button/button.tsx +0 -37
  62. package/src/components/button/button.types.ts +0 -14
  63. package/src/components/button/index.ts +0 -2
  64. package/src/components/card/card.mdx +0 -92
  65. package/src/components/card/card.recipe.tsx +0 -71
  66. package/src/components/card/card.slots.tsx +0 -50
  67. package/src/components/card/card.stories.tsx +0 -175
  68. package/src/components/card/card.tsx +0 -9
  69. package/src/components/card/card.types.ts +0 -22
  70. package/src/components/card/components/card.content.tsx +0 -29
  71. package/src/components/card/components/card.header.tsx +0 -28
  72. package/src/components/card/components/card.root.tsx +0 -62
  73. package/src/components/card/index.ts +0 -2
  74. package/src/components/checkbox/checkbox.mdx +0 -78
  75. package/src/components/checkbox/checkbox.recipe.tsx +0 -116
  76. package/src/components/checkbox/checkbox.slots.tsx +0 -33
  77. package/src/components/checkbox/checkbox.stories.tsx +0 -200
  78. package/src/components/checkbox/checkbox.tsx +0 -77
  79. package/src/components/checkbox/checkbox.types.tsx +0 -22
  80. package/src/components/checkbox/index.ts +0 -2
  81. package/src/components/code/code.mdx +0 -17
  82. package/src/components/code/code.recipe.ts +0 -63
  83. package/src/components/code/code.tsx +0 -1
  84. package/src/components/code/index.ts +0 -1
  85. package/src/components/dialog/dialog.mdx +0 -20
  86. package/src/components/dialog/dialog.recipe.ts +0 -254
  87. package/src/components/dialog/dialog.tsx +0 -61
  88. package/src/components/dialog/index.ts +0 -1
  89. package/src/components/em/em.mdx +0 -17
  90. package/src/components/em/em.tsx +0 -1
  91. package/src/components/em/index.ts +0 -1
  92. package/src/components/flex/flex.mdx +0 -41
  93. package/src/components/flex/flex.tsx +0 -1
  94. package/src/components/flex/index.ts +0 -1
  95. package/src/components/grid/grid.mdx +0 -156
  96. package/src/components/grid/grid.stories.tsx +0 -151
  97. package/src/components/grid/grid.tsx +0 -29
  98. package/src/components/grid/index.ts +0 -1
  99. package/src/components/heading/heading.mdx +0 -23
  100. package/src/components/heading/heading.recipe.ts +0 -49
  101. package/src/components/heading/heading.tsx +0 -1
  102. package/src/components/heading/index.ts +0 -1
  103. package/src/components/highlight/highlight.mdx +0 -18
  104. package/src/components/highlight/highlight.tsx +0 -1
  105. package/src/components/highlight/index.ts +0 -1
  106. package/src/components/icon-button/icon-button.mdx +0 -98
  107. package/src/components/icon-button/icon-button.stories.tsx +0 -188
  108. package/src/components/icon-button/icon-button.tsx +0 -21
  109. package/src/components/icon-button/icon-button.types.tsx +0 -10
  110. package/src/components/icon-button/index.ts +0 -2
  111. package/src/components/index.ts +0 -33
  112. package/src/components/input/index.ts +0 -1
  113. package/src/components/input/input.mdx +0 -20
  114. package/src/components/input/input.recipe.ts +0 -95
  115. package/src/components/input/input.tsx +0 -1
  116. package/src/components/input-group/index.ts +0 -1
  117. package/src/components/input-group/input-group.mdx +0 -20
  118. package/src/components/input-group/input-group.tsx +0 -44
  119. package/src/components/kbd/index.ts +0 -1
  120. package/src/components/kbd/kbd.mdx +0 -18
  121. package/src/components/kbd/kbd.recipe.ts +0 -57
  122. package/src/components/kbd/kbd.tsx +0 -1
  123. package/src/components/link/index.ts +0 -2
  124. package/src/components/link/link.mdx +0 -77
  125. package/src/components/link/link.recipe.ts +0 -52
  126. package/src/components/link/link.slots.tsx +0 -29
  127. package/src/components/link/link.stories.tsx +0 -204
  128. package/src/components/link/link.tsx +0 -38
  129. package/src/components/link/link.types.tsx +0 -26
  130. package/src/components/list/index.ts +0 -1
  131. package/src/components/list/list.mdx +0 -18
  132. package/src/components/list/list.recipe.ts +0 -68
  133. package/src/components/list/list.tsx +0 -9
  134. package/src/components/loading-spinner/index.ts +0 -2
  135. package/src/components/loading-spinner/loading-spinner.mdx +0 -92
  136. package/src/components/loading-spinner/loading-spinner.recipe.tsx +0 -70
  137. package/src/components/loading-spinner/loading-spinner.slots.tsx +0 -38
  138. package/src/components/loading-spinner/loading-spinner.stories.tsx +0 -97
  139. package/src/components/loading-spinner/loading-spinner.tsx +0 -50
  140. package/src/components/loading-spinner/loading-spinner.types.tsx +0 -21
  141. package/src/components/nimbus-provider/color-mode.tsx +0 -32
  142. package/src/components/nimbus-provider/index.ts +0 -2
  143. package/src/components/nimbus-provider/nimbus-provider.mdx +0 -21
  144. package/src/components/nimbus-provider/nimbus-provider.tsx +0 -51
  145. package/src/components/select/components/select.clear-button.tsx +0 -31
  146. package/src/components/select/components/select.option-group.tsx +0 -48
  147. package/src/components/select/components/select.option.tsx +0 -21
  148. package/src/components/select/components/select.options.tsx +0 -23
  149. package/src/components/select/components/select.root.tsx +0 -81
  150. package/src/components/select/index.ts +0 -2
  151. package/src/components/select/select.mdx +0 -170
  152. package/src/components/select/select.recipe.tsx +0 -216
  153. package/src/components/select/select.slots.tsx +0 -58
  154. package/src/components/select/select.stories.tsx +0 -841
  155. package/src/components/select/select.tsx +0 -18
  156. package/src/components/select/select.types.tsx +0 -37
  157. package/src/components/simple-grid/index.ts +0 -1
  158. package/src/components/simple-grid/simple-grid.mdx +0 -133
  159. package/src/components/simple-grid/simple-grid.stories.tsx +0 -143
  160. package/src/components/simple-grid/simple-grid.tsx +0 -31
  161. package/src/components/stack/index.ts +0 -1
  162. package/src/components/stack/stack.mdx +0 -88
  163. package/src/components/stack/stack.stories.tsx +0 -82
  164. package/src/components/stack/stack.tsx +0 -15
  165. package/src/components/table/index.ts +0 -1
  166. package/src/components/table/table.mdx +0 -23
  167. package/src/components/table/table.recipe.ts +0 -170
  168. package/src/components/table/table.tsx +0 -43
  169. package/src/components/text/index.ts +0 -1
  170. package/src/components/text/text.mdx +0 -244
  171. package/src/components/text/text.tsx +0 -23
  172. package/src/components/text-input/index.ts +0 -2
  173. package/src/components/text-input/text-input.mdx +0 -118
  174. package/src/components/text-input/text-input.recipe.tsx +0 -68
  175. package/src/components/text-input/text-input.slots.tsx +0 -24
  176. package/src/components/text-input/text-input.stories.tsx +0 -282
  177. package/src/components/text-input/text-input.tsx +0 -39
  178. package/src/components/text-input/text-input.types.ts +0 -7
  179. package/src/components/toggle-button-group/components/toggle-button-group.button.tsx +0 -14
  180. package/src/components/toggle-button-group/components/toggle-button-group.root.tsx +0 -15
  181. package/src/components/toggle-button-group/index.ts +0 -2
  182. package/src/components/toggle-button-group/toggle-button-group.mdx +0 -94
  183. package/src/components/toggle-button-group/toggle-button-group.recipe.tsx +0 -64
  184. package/src/components/toggle-button-group/toggle-button-group.slots.tsx +0 -26
  185. package/src/components/toggle-button-group/toggle-button-group.stories.tsx +0 -311
  186. package/src/components/toggle-button-group/toggle-button-group.tsx +0 -12
  187. package/src/components/toggle-button-group/toggle-button-group.types.tsx +0 -62
  188. package/src/components/tooltip/index.ts +0 -4
  189. package/src/components/tooltip/make-element-focusable.stories.tsx +0 -56
  190. package/src/components/tooltip/make-element-focusable.tsx +0 -57
  191. package/src/components/tooltip/tooltip-trigger.stories.tsx +0 -157
  192. package/src/components/tooltip/tooltip-trigger.tsx +0 -15
  193. package/src/components/tooltip/tooltip.mdx +0 -48
  194. package/src/components/tooltip/tooltip.recipe.ts +0 -26
  195. package/src/components/tooltip/tooltip.slots.ts +0 -35
  196. package/src/components/tooltip/tooltip.stories.tsx +0 -139
  197. package/src/components/tooltip/tooltip.tsx +0 -31
  198. package/src/components/tooltip/tooltip.types.ts +0 -44
  199. package/src/components/visually-hidden/index.ts +0 -1
  200. package/src/components/visually-hidden/visually-hidden.mdx +0 -61
  201. package/src/components/visually-hidden/visually-hidden.stories.tsx +0 -124
  202. package/src/components/visually-hidden/visually-hidden.tsx +0 -18
  203. package/src/docs/accessibility.mdx +0 -21
  204. package/src/docs/background.mdx +0 -154
  205. package/src/docs/border.mdx +0 -226
  206. package/src/docs/changelog.mdx +0 -17
  207. package/src/docs/components-layout.mdx +0 -22
  208. package/src/docs/components.mdx +0 -17
  209. package/src/docs/data-display.mdx +0 -23
  210. package/src/docs/display.mdx +0 -55
  211. package/src/docs/effects.mdx +0 -73
  212. package/src/docs/feedback.mdx +0 -22
  213. package/src/docs/filters.mdx +0 -268
  214. package/src/docs/flex-and-grid.mdx +0 -445
  215. package/src/docs/forms.mdx +0 -22
  216. package/src/docs/generated/index.mdx +0 -16
  217. package/src/docs/getting-started.mdx +0 -17
  218. package/src/docs/home.mdx +0 -56
  219. package/src/docs/hooks.mdx +0 -16
  220. package/src/docs/inputs.mdx +0 -21
  221. package/src/docs/installation.mdx +0 -60
  222. package/src/docs/interactivity.mdx +0 -278
  223. package/src/docs/known-issues.mdx +0 -19
  224. package/src/docs/layout.mdx +0 -301
  225. package/src/docs/list.mdx +0 -82
  226. package/src/docs/markdown.mdx +0 -234
  227. package/src/docs/media.mdx +0 -22
  228. package/src/docs/naivgation.mdx +0 -22
  229. package/src/docs/playground.mdx +0 -16
  230. package/src/docs/rfcs-component-structure-rfcs.mdx +0 -17
  231. package/src/docs/rfcs-component-structure.mdx +0 -74
  232. package/src/docs/rfcs-hook-structure.mdx +0 -59
  233. package/src/docs/sizing.mdx +0 -210
  234. package/src/docs/spacing.mdx +0 -193
  235. package/src/docs/style-props-typography.mdx +0 -373
  236. package/src/docs/style-props.mdx +0 -15
  237. package/src/docs/svg.mdx +0 -58
  238. package/src/docs/tables.mdx +0 -95
  239. package/src/docs/toc.mdx +0 -39
  240. package/src/docs/tokens/animations.mdx +0 -68
  241. package/src/docs/tokens/aspect-ratios.mdx +0 -21
  242. package/src/docs/tokens/blurs.mdx +0 -20
  243. package/src/docs/tokens/borders.mdx +0 -25
  244. package/src/docs/tokens/breakpoints.mdx +0 -35
  245. package/src/docs/tokens/colors.mdx +0 -86
  246. package/src/docs/tokens/cursors.mdx +0 -21
  247. package/src/docs/tokens/radii.mdx +0 -23
  248. package/src/docs/tokens/shadows.mdx +0 -21
  249. package/src/docs/tokens/sizes.mdx +0 -54
  250. package/src/docs/tokens/spacing.mdx +0 -35
  251. package/src/docs/tokens/typography.mdx +0 -61
  252. package/src/docs/tokens/z-indices.mdx +0 -23
  253. package/src/docs/tokens-other.mdx +0 -17
  254. package/src/docs/tokens.mdx +0 -16
  255. package/src/docs/transforms.mdx +0 -150
  256. package/src/docs/transitions.mdx +0 -164
  257. package/src/docs/typography.mdx +0 -17
  258. package/src/docs/utilities.mdx +0 -17
  259. package/src/hooks/index.ts +0 -2
  260. package/src/hooks/use-copy-to-clipboard/use-copy-to-clipboard.mdx +0 -54
  261. package/src/hooks/use-copy-to-clipboard/use-copy-to-clipboard.ts +0 -1
  262. package/src/hooks/use-hotkeys/use-hotkeys.mdx +0 -48
  263. package/src/hooks/use-hotkeys/use-hotkeys.stories.tsx +0 -69
  264. package/src/hooks/use-hotkeys/use-hotkeys.ts +0 -1
  265. package/src/index.ts +0 -3
  266. package/src/test/utils.tsx +0 -20
  267. package/src/theme/animation-styles.ts +0 -52
  268. package/src/theme/breakpoints.ts +0 -32
  269. package/src/theme/global-css.ts +0 -53
  270. package/src/theme/index.ts +0 -35
  271. package/src/theme/keyframes.ts +0 -192
  272. package/src/theme/layer-styles.ts +0 -12
  273. package/src/theme/recipes/index.ts +0 -21
  274. package/src/theme/semantic-tokens/colors.ts +0 -55
  275. package/src/theme/semantic-tokens/index.ts +0 -9
  276. package/src/theme/semantic-tokens/radii.ts +0 -3
  277. package/src/theme/semantic-tokens/shadows.ts +0 -4
  278. package/src/theme/slot-recipes/index.ts +0 -15
  279. package/src/theme/text-styles.ts +0 -8
  280. package/src/theme/tokens/animations.ts +0 -4
  281. package/src/theme/tokens/aspect-ratios.ts +0 -5
  282. package/src/theme/tokens/blurs.ts +0 -5
  283. package/src/theme/tokens/borders.ts +0 -4
  284. package/src/theme/tokens/colors.ts +0 -8
  285. package/src/theme/tokens/cursor.ts +0 -4
  286. package/src/theme/tokens/durations.ts +0 -4
  287. package/src/theme/tokens/easings.ts +0 -4
  288. package/src/theme/tokens/font-sizes.ts +0 -4
  289. package/src/theme/tokens/font-weights.ts +0 -4
  290. package/src/theme/tokens/fonts.ts +0 -4
  291. package/src/theme/tokens/index.ts +0 -57
  292. package/src/theme/tokens/letter-spacings.ts +0 -24
  293. package/src/theme/tokens/line-heights.ts +0 -4
  294. package/src/theme/tokens/radii.ts +0 -4
  295. package/src/theme/tokens/sizes.ts +0 -120
  296. package/src/theme/tokens/spacing.ts +0 -4
  297. package/src/theme/tokens/z-index.ts +0 -4
  298. package/src/utils/extractStyleProps.ts +0 -26
  299. package/src/utils/fixedForwardRef.ts +0 -17
  300. package/tsconfig.json +0 -38
  301. package/vite.config.ts +0 -54
  302. package/vitest.config.ts +0 -50
@@ -1,373 +0,0 @@
1
- ---
2
- id: Style Props-Typography
3
- title: Typography
4
- description: JSX style props for styling text
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Style Props
9
- - Typography
10
- tags:
11
- - document
12
- ---
13
-
14
- # Typography
15
-
16
- JSX style props for styling text
17
-
18
- ## Font Family
19
-
20
- Use the `fontFamily` prop to set the font family of a text element.
21
-
22
- ```jsx
23
- <Text fontFamily="mono">Hello World</Text>
24
- ```
25
-
26
- | Prop | CSS Property | Token Category |
27
- | ------------ | ------------- | -------------- |
28
- | `fontFamily` | `font-family` | `fonts` |
29
-
30
- ## Font Size
31
-
32
- Use the `fontSize` prop to set the font size of a text element.
33
-
34
- ```jsx
35
- // hardcoded values
36
- <Text fontSize="12px">Hello World</Text>
37
- <Text fontSize="10rem">Hello World</Text>
38
-
39
- // token values
40
- <Text fontSize="xs">Hello World</Text>
41
- <Text fontSize="4xl">Hello World</Text>
42
- <Text fontSize="5xl">Hello World</Text>
43
- ```
44
-
45
- | Prop | CSS Property | Token Category |
46
- | ---------- | ------------ | -------------- |
47
- | `fontSize` | `font-size` | `fonts` |
48
-
49
- ## Text Styles
50
-
51
- Use the `textStyle` prop to apply both a font size, line height, and letter
52
- spacing composition at once.
53
-
54
- ```jsx
55
- <Text textStyle="xs">Hello World</Text>
56
- <Text textStyle="sm">Hello World</Text>
57
- <Text textStyle="md">Hello World</Text>
58
- <Text textStyle="lg">Hello World</Text>
59
- <Text textStyle="xl">Hello World</Text>
60
- <Text textStyle="2xl">Hello World</Text>
61
- <Text textStyle="3xl">Hello World</Text>
62
- <Text textStyle="4xl">Hello World</Text>
63
- <Text textStyle="5xl">Hello World</Text>
64
- ```
65
-
66
- | Prop | Config |
67
- | ----------- | ------------------ |
68
- | `textStyle` | `theme.textStyles` |
69
-
70
- ## Font Style
71
-
72
- Use the `fontStyle` prop to set the font style of a text element.
73
-
74
- ```jsx
75
- <Text fontStyle="italic">Hello World</Text>
76
- ```
77
-
78
- | Prop | CSS Property | Token Category |
79
- | ----------- | ------------ | -------------- |
80
- | `fontStyle` | `font-style` | none |
81
-
82
- ## Font Weight
83
-
84
- Use the `fontWeight` prop to set the font weight of a text element.
85
-
86
- ```jsx
87
- // hardcoded values
88
- <Text fontWeight="600">Hello World</Text>
89
-
90
- // token values
91
- <Text fontWeight="semibold">Hello World</Text>
92
- ```
93
-
94
- | Prop | CSS Property | Token Category |
95
- | ------------ | ------------- | -------------- |
96
- | `fontWeight` | `font-weight` | `fontWeights` |
97
-
98
- ## Font Variant Numeric
99
-
100
- Use the `fontVariantNumeric` prop to set the font variant numeric of a text
101
- element.
102
-
103
- ```jsx
104
- <Text fontVariantNumeric="lining-nums">Hello World</Text>
105
- ```
106
-
107
- | Prop | CSS Property | Token Category |
108
- | -------------------- | ---------------------- | -------------- |
109
- | `fontVariantNumeric` | `font-variant-numeric` | none |
110
-
111
- ## Letter Spacing
112
-
113
- Use the `letterSpacing` prop to set the letter spacing of a text element.
114
-
115
- ```jsx
116
- // hardcoded values
117
- <Text letterSpacing="0.1rem">Hello World</Text>
118
-
119
- // token values
120
- <Text letterSpacing="tight">Hello World</Text>
121
- <Text letterSpacing="wide">Hello World</Text>
122
- <Text letterSpacing="wider">Hello World</Text>
123
- <Text letterSpacing="widest">Hello World</Text>
124
- ```
125
-
126
- | Prop | CSS Property | Token Category |
127
- | --------------- | ---------------- | ---------------- |
128
- | `letterSpacing` | `letter-spacing` | `letterSpacings` |
129
-
130
- ## Truncation
131
-
132
- Use the `truncate` prop to truncate text.
133
-
134
- ```jsx
135
- <Text truncate>Lorem ipsum dolor sit amet...</Text>
136
- ```
137
-
138
- | Prop | CSS Property | Token Category |
139
- | ---------- | --------------- | -------------- |
140
- | `truncate` | `text-overflow` | none |
141
-
142
- ## Line Clamp
143
-
144
- Use the `lineClamp` prop to truncate multi-line text. Set `lineClamp` to `none`
145
- to disable truncation.
146
-
147
- ```jsx
148
- <Text lineClamp="2">Lorem ipsum dolor sit amet...</Text>
149
-
150
- // revert truncation
151
- <Text lineClamp="none">Lorem ipsum dolor sit amet...</Text>
152
- ```
153
-
154
- | Prop | CSS Property | Token Category |
155
- | ----------- | ------------------- | -------------- |
156
- | `lineClamp` | `webkit-line-clamp` | none |
157
-
158
- ## Line Height
159
-
160
- Use the `lineHeight` prop to set the line height of a text element.
161
-
162
- ```jsx
163
- // hardcoded values
164
- <Text lineHeight="1.5">Hello World</Text>
165
-
166
- // token values
167
- <Text lineHeight="tall">Hello World</Text>
168
- ```
169
-
170
- | Prop | CSS Property | Token Category |
171
- | ------------ | ------------- | -------------- |
172
- | `lineHeight` | `line-height` | `lineHeights` |
173
-
174
- ## Text Align
175
-
176
- Use the `textAlign` prop to set the text alignment of a text element.
177
-
178
- ```jsx
179
- <Text textAlign="left">Hello World</Text>
180
- <Text textAlign="center">Hello World</Text>
181
- <Text textAlign="right">Hello World</Text>
182
- <Text textAlign="justify">Hello World</Text>
183
- ```
184
-
185
- | Prop | CSS Property | Token Category |
186
- | ----------- | ------------ | -------------- |
187
- | `textAlign` | `text-align` | none |
188
-
189
- ## Text Color
190
-
191
- Use the `color` prop to set the color of a text element.
192
-
193
- ```jsx
194
- <Text color="red">Hello World</Text>
195
- ```
196
-
197
- | Prop | CSS Property | Token Category |
198
- | ------- | ------------ | -------------- |
199
- | `color` | `color` | `colors` |
200
-
201
- ## Text Decoration
202
-
203
- Use the `textDecoration` or `textDecor` prop to set the text decoration of a
204
- text element.
205
-
206
- ```jsx
207
- <Text textDecoration="underline">Hello World</Text>
208
- ```
209
-
210
- | Prop | CSS Property | Token Category |
211
- | ----------------------------- | ----------------- | -------------- |
212
- | `textDecor`, `textDecoration` | `text-decoration` | none |
213
-
214
- ## Text Decoration Color
215
-
216
- Use the `textDecorationColor` prop to set the text decoration color of a text
217
- element.
218
-
219
- ```jsx
220
- <Text textDecoration="underline" textDecorationColor="red">
221
- Hello World
222
- </Text>
223
- ```
224
-
225
- | Prop | CSS Property | Token Category |
226
- | --------------------- | ----------------------- | -------------- |
227
- | `textDecorationColor` | `text-decoration-color` | `colors` |
228
-
229
- ## Text Decoration Style
230
-
231
- Use the `textDecorationStyle` prop to set the text decoration style of a text
232
- element.
233
-
234
- ```jsx
235
- <Text textDecoration="underline" textDecorationStyle="dashed">
236
- Hello World
237
- </Text>
238
- ```
239
-
240
- | Prop | CSS Property | Token Category |
241
- | --------------------- | ----------------------- | -------------- |
242
- | `textDecorationStyle` | `text-decoration-style` | none |
243
-
244
- ## Text Decoration Thickness
245
-
246
- Use the `textDecorationThickness` prop to set the text decoration thickness of a
247
- text element.
248
-
249
- ```jsx
250
- <Text textDecoration="underline" textDecorationThickness="1px">
251
- Hello World
252
- </Text>
253
- ```
254
-
255
- | Prop | CSS Property | Token Category |
256
- | ------------------------- | --------------------------- | -------------- |
257
- | `textDecorationThickness` | `text-decoration-thickness` | none |
258
-
259
- ## Text Underline Offset
260
-
261
- Use the `textUnderlineOffset` prop to set the text underline offset of a text
262
- element.
263
-
264
- ```jsx
265
- <Text textDecoration="underline" textUnderlineOffset="1px">
266
- Hello World
267
- </Text>
268
- ```
269
-
270
- | Prop | CSS Property | Token Category |
271
- | --------------------- | ----------------------- | -------------- |
272
- | `textUnderlineOffset` | `text-underline-offset` | none |
273
-
274
- ## Text Transform
275
-
276
- Use the `textTransform` prop to set the text transform of a text element.
277
-
278
- ```jsx
279
- <Text textTransform="uppercase">Hello World</Text>
280
- ```
281
-
282
- | Prop | CSS Property | Token Category |
283
- | --------------- | ---------------- | -------------- |
284
- | `textTransform` | `text-transform` | none |
285
-
286
- ## Text Overflow
287
-
288
- Use the `textOverflow` prop to set the text overflow of a text element.
289
-
290
- ```jsx
291
- <Text textOverflow="ellipsis">Hello World</Text>
292
- ```
293
-
294
- | Prop | CSS Property | Token Category |
295
- | -------------- | --------------- | -------------- |
296
- | `textOverflow` | `text-overflow` | none |
297
-
298
- ## Text Shadow
299
-
300
- Use the `textShadow` prop to set the text shadow of a text element.
301
-
302
- ```jsx
303
- <Text textShadow="0 0 1px red">Hello World</Text>
304
- ```
305
-
306
- | Prop | CSS Property | Token Category |
307
- | ------------ | ------------- | -------------- |
308
- | `textShadow` | `text-shadow` | `shadows` |
309
-
310
- ## Text Indent
311
-
312
- Use the `textIndent` prop to set the text indent of a text element.
313
-
314
- ```jsx
315
- // hardcoded values
316
- <Text textIndent="1rem">Hello World</Text>
317
-
318
- // token values
319
- <Text textIndent="3">Hello World</Text>
320
- ```
321
-
322
- | Prop | CSS Property | Token Category |
323
- | ------------ | ------------- | -------------- |
324
- | `textIndent` | `text-indent` | `spacing` |
325
-
326
- ## Vertical Align
327
-
328
- Use the `verticalAlign` prop to set the vertical alignment of a text element.
329
-
330
- ```jsx
331
- <Text verticalAlign="top">Hello World</Text>
332
- ```
333
-
334
- | Prop | CSS Property | Token Category |
335
- | --------------- | ---------------- | -------------- |
336
- | `verticalAlign` | `vertical-align` | none |
337
-
338
- ## White Space
339
-
340
- Use the `whiteSpace` prop to set the white space of a text element.
341
-
342
- ```jsx
343
- <Text whiteSpace="nowrap">Hello World</Text>
344
- ```
345
-
346
- | Prop | CSS Property | Token Category |
347
- | ------------ | ------------- | -------------- |
348
- | `whiteSpace` | `white-space` | none |
349
-
350
- ## Word Break
351
-
352
- Use the `wordBreak` prop to set whether line breaks appear wherever the text
353
- would otherwise overflow its content box.
354
-
355
- ```jsx
356
- <Text wordBreak="break-all">Hello World</Text>
357
- ```
358
-
359
- | Prop | CSS Property | Token Category |
360
- | ----------- | ------------ | -------------- |
361
- | `wordBreak` | `word-break` | none |
362
-
363
- ## Hyphens
364
-
365
- Use the `hyphens` prop to set whether hyphens are used in the text.
366
-
367
- ```jsx
368
- <Text hyphens="auto">Hello World</Text>
369
- ```
370
-
371
- | Prop | CSS Property | Token Category |
372
- | --------- | ------------ | -------------- |
373
- | `hyphens` | `hyphens` | none |
@@ -1,15 +0,0 @@
1
- ---
2
- id: Home-Style Props
3
- title: Style Props
4
- description: JSX style props for applying CSS rules
5
- documentState: InitialDraft
6
- order: 4
7
- menu:
8
- - Style Props
9
- tags:
10
- - document
11
- ---
12
-
13
- # Style Props
14
-
15
- JSX style props for applying CSS rules
package/src/docs/svg.mdx DELETED
@@ -1,58 +0,0 @@
1
- ---
2
- id: Style Props-SVG
3
- title: SVG
4
- description: JSX style props for SVG elements.
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Style Props
9
- - SVG
10
- tags:
11
- - document
12
- ---
13
-
14
- # SVG
15
-
16
- JSX style props for SVG elements.
17
-
18
- ## Fill
19
-
20
- Use the `fill` prop to set the fill color of an SVG element.
21
-
22
- ```jsx
23
- <chakra.svg fill="blue.500">
24
- <path d="..." />
25
- </chakra.svg>
26
- ```
27
-
28
- | Prop | CSS Property | Token Category |
29
- | ------ | ------------ | -------------- |
30
- | `fill` | `fill` | `colors` |
31
-
32
- ## Stroke
33
-
34
- Use the `stroke` prop to set the stroke color of an SVG element.
35
-
36
- ```jsx
37
- <chakra.svg stroke="blue.500">
38
- <path d="..." />
39
- </chakra.svg>
40
- ```
41
-
42
- | Prop | CSS Property | Token Category |
43
- | -------- | ------------ | -------------- |
44
- | `stroke` | `stroke` | `colors` |
45
-
46
- ## Stroke Width
47
-
48
- Use the `strokeWidth` prop to set the stroke width of an SVG element.
49
-
50
- ```jsx
51
- <chakra.svg strokeWidth="1px">
52
- <path d="..." />
53
- </chakra.svg>
54
- ```
55
-
56
- | Prop | CSS Property | Token Category |
57
- | ------------- | -------------- | -------------- |
58
- | `strokeWidth` | `stroke-width` | `borderWidths` |
@@ -1,95 +0,0 @@
1
- ---
2
- id: Style Props-Tables
3
- title: Tables
4
- description: JSX style props for styling table elements.
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Style Props
9
- - Tables
10
- tags:
11
- - document
12
- ---
13
-
14
- # Tables
15
-
16
- JSX style props for styling table elements.
17
-
18
- ## Border Spacing
19
-
20
- Control the border-spacing property of a table.
21
-
22
- ```jsx
23
- <chakra.table borderSpacing="2">
24
- <tbody>
25
- <tr>
26
- <td>Cell 1</td>
27
- <td>Cell 2</td>
28
- </tr>
29
- </tbody>
30
- </chakra.table>
31
- ```
32
-
33
- | Prop | CSS Property | Token Category |
34
- | --------------- | ---------------- | -------------- |
35
- | `borderSpacing` | `border-spacing` | `spacing` |
36
-
37
- ## Border Spacing X
38
-
39
- Use the `borderSpacingX` prop to set the horizontal border-spacing property of a
40
- table.
41
-
42
- ```jsx
43
- <chakra.table borderSpacingX="2">
44
- <tbody>
45
- <tr>
46
- <td>Cell 1</td>
47
- <td>Cell 2</td>
48
- </tr>
49
- </tbody>
50
- </chakra.table>
51
- ```
52
-
53
- | Prop | CSS Property | Token Category |
54
- | ---------------- | ---------------- | -------------- |
55
- | `borderSpacingX` | `border-spacing` | `spacing` |
56
-
57
- ## Border Spacing Y
58
-
59
- Use the `borderSpacingY` prop to set the vertical border-spacing property of a
60
- table.
61
-
62
- ```jsx
63
- <chakra.table borderSpacingY="2">
64
- <tbody>
65
- <tr>
66
- <td>Cell 1</td>
67
- <td>Cell 2</td>
68
- </tr>
69
- </tbody>
70
- </chakra.table>
71
- ```
72
-
73
- | Prop | CSS Property | Token Category |
74
- | ---------------- | ---------------- | -------------- |
75
- | `borderSpacingY` | `border-spacing` | `spacing` |
76
-
77
- ## Caption Side
78
-
79
- Use the `captionSide` prop to set the side of the caption of a table.
80
-
81
- ```jsx
82
- <table>
83
- <chakra.caption captionSide="bottom">This is a caption</chakra.caption>
84
- <tbody>
85
- <tr>
86
- <td>Cell 1</td>
87
- <td>Cell 2</td>
88
- </tr>
89
- </tbody>
90
- </table>
91
- ```
92
-
93
- | Prop | CSS Property | Token Category |
94
- | ------------- | -------------- | -------------- |
95
- | `captionSide` | `caption-side` | - |
package/src/docs/toc.mdx DELETED
@@ -1,39 +0,0 @@
1
- ---
2
- id: Toc
3
- title: Toc
4
- description: Let's get the table of contents automatically generated
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Playground
9
- - Toc
10
- tags:
11
- - playground
12
- - exploring
13
- ---
14
-
15
- # Toc
16
-
17
- This is the place to try out things.
18
-
19
- ## Level 2.1
20
-
21
- First Level 2 Heading
22
-
23
- ### Level 3.1
24
-
25
- First Level 3 Heading
26
-
27
- #### Level 4.1
28
-
29
- First Level 4 Heading
30
-
31
- #### Level 4.2
32
-
33
- Second Level 4 Heading
34
-
35
- ### Level 3.2
36
-
37
- Second Level 3 Heading
38
-
39
- ## Level 2.2
@@ -1,68 +0,0 @@
1
- ---
2
- id: TokensAnimations
3
- title: Animations
4
- description: The list of available animation tokens
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Tokens
9
- - Other
10
- - Animations
11
- tags:
12
- - animation
13
- - transition
14
- icon: RotateRight
15
- ---
16
-
17
- # Animations
18
-
19
- This page provides a list of tokens for applying ready made animations
20
- (shorthands) or creating custom animations or transitions by combining keyframe
21
- animations with durations and easings.
22
-
23
- ## Shorthands
24
-
25
- The following list of shorthand tokens can be used as `animation` property
26
- value, they combine a keyframe animation with duration and easing for a reusable
27
- animation definition.
28
-
29
- <GenericTokenTableDemo category="animations" demoProperty="animation" />
30
-
31
- ## Keyframe Animations
32
-
33
- CSS keyframe animations define animations as a sequence of steps, each with its
34
- own set of properties. They allow for more complex, multi-step animations that
35
- can be controlled with keyframes and timing functions.
36
-
37
- <KeyframeTokenDemo />
38
-
39
- ## Durations
40
-
41
- Durations define **how long** an animation takes to complete one cycle, directly
42
- impacting the perception of speed and fluidity.
43
-
44
- Short durations create snappy, quick interactions that feel responsive but can
45
- risk appearing abrupt. Longer durations allow for smoother, more deliberate
46
- motion but can feel sluggish if overused.
47
-
48
- Finding the right balance is key—durations should match the context and intent
49
- of the interaction. They’re measured in seconds or milliseconds and are often
50
- paired with easings to create harmonious, intentional animations.
51
-
52
- <DurationTokenDemo />
53
-
54
- ## Easings
55
-
56
- _Easings_ determine **the rate of change** of an animation over time,
57
- essentially defining how an animation transitions between its start and end
58
- states.
59
-
60
- Instead of moving linearly, animations can accelerate, decelerate, or follow
61
- complex curves, making the motion feel more dynamic and natural.
62
-
63
- This is achieved through mathematical easing functions, like linear
64
- interpolation or bezier curves, which map progress over time to the visible
65
- change in animation properties. It controls the "rhythm" of the animation,
66
- ensuring it feels fluid or deliberate depending on the desired effect.
67
-
68
- <EasingTokenDemo />
@@ -1,21 +0,0 @@
1
- ---
2
- id: TokensAspectRatios
3
- title: Aspect Ratios
4
- description: The list of available aspect ratio tokens
5
- documentState: InitialDraft
6
- documentAudiences: []
7
- order: 999
8
- menu:
9
- - Tokens
10
- - Aspect Ratios
11
- tags:
12
- - aspect ratio
13
- - ratios
14
- icon: ImageAspectRatio
15
- ---
16
-
17
- # Aspect Ratios
18
-
19
- The list of available aspect ratio tokens:
20
-
21
- <GenericTokenTableDemo category="aspectRatios" demoProperty="aspectRatio" />
@@ -1,20 +0,0 @@
1
- ---
2
- id: TokensBlurs
3
- title: Blurs
4
- description: The list of available blur tokens
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Tokens
9
- - Other
10
- - Blurs
11
- tags:
12
- - blur
13
- icon: BlurOn
14
- ---
15
-
16
- # Blurs
17
-
18
- The list of available blur tokens:
19
-
20
- <GenericTokenTableDemo category="blurs" demoProperty="blur" />