@commercetools/nimbus 0.0.1 → 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 +33 -6
  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,301 +0,0 @@
1
- ---
2
- id: Style Props-Layout
3
- title: Layout
4
- description:
5
- JSX style props to control the width, height, and spacing of elements
6
- documentState: InitialDraft
7
- order: 999
8
- menu:
9
- - Style Props
10
- - Layout
11
- tags:
12
- - document
13
- ---
14
-
15
- # Layout
16
-
17
- JSX style props to control the width, height, and spacing of elements
18
-
19
- ## Aspect Ratio
20
-
21
- Use the `aspectRatio` prop to set the desired aspect ratio of an element.
22
-
23
- ```jsx
24
- // raw value
25
- <Box aspectRatio="1.2" />
26
-
27
- // token
28
- <Box aspectRatio="square" />
29
- ```
30
-
31
- | Prop | CSS Property | Token Category |
32
- | ------------- | -------------- | -------------- |
33
- | `aspectRatio` | `aspect-ratio` | `aspectRatios` |
34
-
35
- ## Break
36
-
37
- ### Break After
38
-
39
- Use the `breakAfter` prop to set how page, column, or region breaks should
40
- behave after an element.
41
-
42
- ```jsx
43
- <Box columns="2">
44
- <Box>Item 1</Box>
45
- <Box breakAfter="page">Item 2</Box>
46
- </Box>
47
- ```
48
-
49
- | Prop | CSS Property | Token Category |
50
- | ------------ | ------------- | -------------- |
51
- | `breakAfter` | `break-after` | - |
52
-
53
- ### Break Before
54
-
55
- Use the `breakBefore` prop to set how page, column, or region breaks should
56
- behave before an element.
57
-
58
- ```jsx
59
- <Box columns="2">
60
- <Box>Item 1</Box>
61
- <Box breakBefore="page">Item 2</Box>
62
- </Box>
63
- ```
64
-
65
- | Prop | CSS Property | Token Category |
66
- | ------------- | -------------- | -------------- |
67
- | `breakBefore` | `break-before` | - |
68
-
69
- ### Break Inside
70
-
71
- Use the `breakInside` prop to set how page, column, or region breaks should
72
- behave inside an element.
73
-
74
- ```jsx
75
- <Box columns="2">
76
- <Box>Item 1</Box>
77
- <Box breakInside="avoid">Item 2</Box>
78
- </Box>
79
- ```
80
-
81
- | Prop | CSS Property | Token Category |
82
- | ------------- | -------------- | -------------- |
83
- | `breakInside` | `break-inside` | - |
84
-
85
- ## Box Decoration Break
86
-
87
- Use the `boxDecorationBreak` prop to set how box decorations should behave when
88
- the box breaks across multiple lines, columns, or pages.
89
-
90
- ```jsx /boxDecorationBreak/
91
- <Box bgImage="linear-gradient(red, blue)" boxDecorationBreak="clone">
92
- Chakra is <br /> great!
93
- </Box>
94
- ```
95
-
96
- | Prop | CSS Property | Token Category |
97
- | -------------------- | ---------------------- | -------------- |
98
- | `boxDecorationBreak` | `box-decoration-break` | - |
99
-
100
- ## Box Sizing
101
-
102
- Use the `boxSizing` prop to set the box sizing of an element.
103
-
104
- ```jsx /boxSizing/
105
- <Box boxSizing="border-box" padding="4" width="8" height="8" />
106
- ```
107
-
108
- | Prop | CSS Property | Token Category |
109
- | ----------- | ------------ | -------------- |
110
- | `boxSizing` | `box-sizing` | - |
111
-
112
- ## Columns
113
-
114
- Use the `columns` prop to set the number of columns for an element.
115
-
116
- ```jsx
117
- <Box columns={2} />
118
- ```
119
-
120
- | Prop | CSS Property | Token Category |
121
- | --------- | ------------ | -------------- |
122
- | `columns` | `columns` | - |
123
-
124
- ## Float
125
-
126
- Use the `float` prop to set the float of an element.
127
-
128
- ```jsx /float/
129
- <Box>
130
- <Text>As much mud in the streets...</Text>
131
- <Box float="left">Float me</Box>
132
- </Box>
133
- ```
134
-
135
- | Prop | CSS Property | Token Category |
136
- | ------- | ------------ | -------------- |
137
- | `float` | `float` | - |
138
-
139
- ## Clear
140
-
141
- Use the `clear` prop to set whether an element must be moved below (cleared)
142
- floating elements that precede it.
143
-
144
- ```jsx
145
- <Box>
146
- <Box float="left">Left</Box>
147
- <Box float="right">Right</Box>
148
- <Box clear="none">
149
- As much mud in the streets as if the waters had but newly retired from the
150
- face of the earth, and it would not be wonderful to meet a Megalosaurus,
151
- forty feet long or so, waddling like an elephantine lizard up Holborn Hill.
152
- </Box>
153
- </Box>
154
- ```
155
-
156
- | Prop | CSS Property | Token Category |
157
- | ------- | ------------ | -------------- |
158
- | `clear` | `clear` | - |
159
-
160
- ## Isolation
161
-
162
- Use the `isolation` prop to set whether an element should explicitly create a
163
- new stacking context.
164
-
165
- ```jsx
166
- <Box isolation="isolate">
167
- <Box bg="red.500" width="10" height="10" />
168
- </Box>
169
- ```
170
-
171
- | Prop | CSS Property | Token Category |
172
- | ----------- | ------------ | -------------- |
173
- | `isolation` | `isolation` | - |
174
-
175
- ## Object Fit
176
-
177
- Use the `objectFit` prop to set how an image or video should be resized to fit
178
- its container.
179
-
180
- ```jsx
181
- <Image src="..." objectFit="cover" width="10" height="10" />
182
- ```
183
-
184
- | Prop | CSS Property | Token Category |
185
- | ----------- | ------------ | -------------- |
186
- | `objectFit` | `object-fit` | - |
187
-
188
- ## Object Position
189
-
190
- Use the `objectPosition` prop to set how an element should be positioned within
191
- its container.
192
-
193
- ```jsx
194
- <Image src="..." objectPosition="center" width="10" height="10" />
195
- ```
196
-
197
- | Prop | CSS Property | Token Category |
198
- | ---------------- | ----------------- | -------------- |
199
- | `objectPosition` | `object-position` | - |
200
-
201
- ## Overflow
202
-
203
- Use the `overflow` prop to control how content that exceeds an element's
204
- dimensions is handled. This property determines whether to clip the content, add
205
- scrollbars, or display the overflow content.
206
-
207
- ```jsx
208
- <Box overflow="hidden" maxHeight="120px" />
209
- <Box overflow="auto" maxHeight="120px" />
210
- ```
211
-
212
- | Prop | CSS Property | Token Category |
213
- | ---------- | ------------ | -------------- |
214
- | `overflow` | `overflow` | - |
215
-
216
- ## Overscroll Behavior
217
-
218
- Use the `overscrollBehavior` prop to control what the browser does when reaching
219
- the boundary of a scrolling area.
220
-
221
- ```jsx
222
- <Box maxHeight="120px" overscrollBehavior="contain" />
223
- ```
224
-
225
- | Prop | CSS Property | Token Category |
226
- | -------------------- | --------------------- | -------------- |
227
- | `overscrollBehavior` | `overscroll-behavior` | - |
228
-
229
- ## Position
230
-
231
- Use the `position` utilities to set the position of an element.
232
-
233
- ```jsx
234
- <Box position="absolute" />
235
- <Box pos="absolute" /> // shorthand
236
- ```
237
-
238
- | Prop | CSS Property | Token Category |
239
- | ---------- | ------------ | -------------- |
240
- | `position` | `position` | - |
241
-
242
- ## Top / Right / Bottom / Left
243
-
244
- Use the `top`, `right`, `bottom` and `left` utilities to set the position of an
245
- element.
246
-
247
- ```jsx
248
- <Box position="absolute" top="0" left="0" />
249
-
250
- // using spacing tokens
251
- <Box position="absolute" top="4" />
252
-
253
- // using hardcoded values
254
- <Box position="absolute" top="100px" />
255
- ```
256
-
257
- Use the logical equivalents of `inset{Start|End}` utilities to set the position
258
- of an element based on the writing mode.
259
-
260
- ```jsx
261
- <Box position="absolute" insetStart="0" />
262
- ```
263
-
264
- | Prop | CSS Property | Token Category |
265
- | ----------------------------------------- | -------------------- | -------------- |
266
- | `top` | `top` | `spacing` |
267
- | `right` | `right` | `spacing` |
268
- | `bottom` | `bottom` | `spacing` |
269
- | `left` | `left` | `spacing` |
270
- | `start`, `insetStart`, `insetInlineStart` | `inset-inline-start` | `spacing` |
271
- | `end` , `insetEnd`, `insetInlineEnd` | `inset-inline-end` | `spacing` |
272
- | `insetX`, `insetInline` | `inset-inline` | `spacing` |
273
- | `insetY`, `insetBlock` | `inset-inline` | `spacing` |
274
-
275
- ## Visibility
276
-
277
- Use the `visibility` prop to control the visibility of an element.
278
-
279
- ```jsx
280
- <Box visibility="hidden" />
281
- ```
282
-
283
- | Prop | CSS Property | Token Category |
284
- | ------------ | ------------ | -------------- |
285
- | `visibility` | `visibility` | - |
286
-
287
- ## Z-Index
288
-
289
- Use the `zIndex` prop to set the z-index of an element.
290
-
291
- ```jsx
292
- // using hardcoded values
293
- <Box zIndex="1" />
294
-
295
- // using token
296
- <Box zIndex="overlay" />
297
- ```
298
-
299
- | Prop | CSS Property | Token Category |
300
- | -------- | ------------ | -------------- |
301
- | `zIndex` | `z-index` | `zIndices` |
package/src/docs/list.mdx DELETED
@@ -1,82 +0,0 @@
1
- ---
2
- id: Style Props-List
3
- title: List
4
- description: JSX style props for customizing list styles.
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Style Props
9
- - List
10
- tags:
11
- - document
12
- ---
13
-
14
- # List
15
-
16
- JSX style props for customizing list styles.
17
-
18
- ## List Style Type
19
-
20
- Use the `listStyleType` property to set the type of the list marker.
21
-
22
- ```jsx
23
- <Box as="ul" listStyleType="circle">
24
- <li>Item 1</li>
25
- <li>Item 2</li>
26
- <li>Item 3</li>
27
- </Box>
28
- ```
29
-
30
- | Prop | CSS Property | Token Category |
31
- | --------------- | ----------------- | -------------- |
32
- | `listStyleType` | `list-style-type` | - |
33
-
34
- ## List Style Position
35
-
36
- Use the `listStylePosition` property to set the position of the list marker.
37
-
38
- ```jsx
39
- <Box as="ul" listStylePosition="inside">
40
- <li>Item 1</li>
41
- <li>Item 2</li>
42
- <li>Item 3</li>
43
- </Box>
44
- ```
45
-
46
- | Prop | CSS Property | Token Category |
47
- | ------------------- | --------------------- | -------------- |
48
- | `listStylePosition` | `list-style-position` | - |
49
-
50
- ## List Style Image
51
-
52
- Use the `listStyleImage` property to set the image of the list marker.
53
-
54
- ```jsx
55
- <Box as="ul" listStyleImage="url(...)">
56
- <li>Item 1</li>
57
- <li>Item 2</li>
58
- <li>Item 3</li>
59
- </Box>
60
- ```
61
-
62
- | Prop | CSS Property | Token Category |
63
- | ---------------- | ------------------ | -------------- |
64
- | `listStyleImage` | `list-style-image` | `assets` |
65
-
66
- ## Markers
67
-
68
- Use the `_marker` property to set the marker of a list item.
69
-
70
- ```jsx /_marker/
71
- <ul>
72
- <Box as="li" _marker={{ color: "red" }}>
73
- Item 1
74
- </Box>
75
- <Box as="li" _marker={{ color: "blue" }}>
76
- Item 2
77
- </Box>
78
- <Box as="li" _marker={{ color: "green" }}>
79
- Item 3
80
- </Box>
81
- </ul>
82
- ```
@@ -1,234 +0,0 @@
1
- ---
2
- id: Markdown
3
- title: Markdown
4
- description: a page with many mdx & markdown features
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Playground
9
- - Markdown
10
- tags:
11
- - playground
12
- - markdown
13
- - mdx
14
- ---
15
-
16
- # Markdown / MDX Stress Test
17
-
18
- This is a page to stress test markdown & mdx syntax usages to see if everything
19
- renders without issues.
20
-
21
- ## Basic Markdown
22
-
23
- BAsic markdown is supported.
24
-
25
- ### Headings
26
-
27
- See the bold Text above? This is a heading. Not gonna demonstrate them, they are
28
- used everwhere on a page, but this is what you'd use in markdown or mdx files to
29
- write one:
30
-
31
- ```markdown
32
- # H1 Most important
33
-
34
- ## H2 Heading
35
-
36
- ### H3 Heading
37
-
38
- #### H4 Heading
39
-
40
- ##### H5 Heading
41
-
42
- ###### H6 Least important
43
- ```
44
-
45
- ### Emphasizing Text
46
-
47
- #### Italic Text
48
-
49
- _Italic text_ is done with underscores `_String to highlight_`
50
-
51
- #### Bold Text
52
-
53
- **Bold text** is done with double asterisks `**String to highlight**`
54
-
55
- #### Bold + Italic Text
56
-
57
- **_Bold + Italic text_** is done with tripple asterisks
58
- `***String to highlight***`
59
-
60
- ### Code
61
-
62
- Code can be displayed inline or in a code-block, use single backticks for
63
- inline-code or tripple backticks for code blocks.
64
-
65
- Look at this: `export const App = () => <div>App</div>` this was inline code.
66
-
67
- And here is a code-block:
68
-
69
- ```jsx
70
- export const App = () => {
71
- return (
72
- <div>
73
- <p>App</p>
74
- </div>
75
- );
76
- };
77
- ```
78
-
79
- ### Blockquote
80
-
81
- This is how a regular blockquote looks. There are more variants of blockquotes
82
- but they are belonging to the Github flavored Markdown though.
83
-
84
- > Sugar plum shortbread dragée chocolate bar lollipop. Bonbon soufflé cupcake
85
- > cotton candy bear claw muffin tiramisu
86
-
87
- ### Links
88
-
89
- Link look pretty basic [tiramisu croissant gummies](http://www.asdasdsd.com)
90
-
91
- ### Images
92
-
93
- Images work as well.
94
-
95
- ```markdown
96
- ![alt text](https://picsum.photos/seed/2/640/480 "Image title")
97
- ```
98
-
99
- ![alt text](https://picsum.photos/seed/2/640/480 "Random office pic")
100
-
101
- ### Lists
102
-
103
- #### Ordered List
104
-
105
- Simple list:
106
-
107
- 1. First item
108
- 2. Second item
109
- 3. Third item
110
- 4. Fourth item
111
-
112
- ---
113
-
114
- 1. First item
115
- 2. Second item
116
- 3. Third item
117
- 1. Indented item
118
- 2. Indented item
119
- 4. Fourth item
120
-
121
- ---
122
-
123
- #### Unordered Lists
124
-
125
- Simple list:
126
-
127
- - First item
128
- - Second item
129
- - Third item
130
- - Fourth item
131
-
132
- List with a sublist:
133
-
134
- - First item
135
- - Second item
136
- - Third item
137
- - Indented item
138
- - Indented item
139
- - Fourth item
140
-
141
- ## Github flavored Markdown
142
-
143
- ### Tables
144
-
145
- | **Product Name** | **Category** | **Price** | **Discount** | **Stock** | **Ratings** | **Brand** | **Color** | **Shipping** | **In Stock** |
146
- | --------------------------------- | ---------------- | --------- | ------------ | --------- | --------------- | ---------- | ----------- | ----------------- | ------------ |
147
- | **Wireless Bluetooth Headphones** | Electronics | $79.99 | 10% off | 124 | ⭐⭐⭐⭐☆ (4.5) | SoundWave | Black | Free Shipping | Yes |
148
- | **Leather Sofa Set** | Furniture | $999.00 | 15% off | 15 | ⭐⭐⭐⭐⭐ (5) | HomeLux | Brown | Free Shipping | No |
149
- | **Smartphone 6 Pro** | Electronics | $699.00 | 5% off | 57 | ⭐⭐⭐⭐⭐ (5) | TechSmart | Blue | Free Shipping | Yes |
150
- | **Gaming Laptop 15"** | Electronics | $1,499.00 | 20% off | 32 | ⭐⭐⭐⭐☆ (4.2) | GamerX | Gray | Free Shipping | Yes |
151
- | **Organic Green Tea** | Food & Beverages | $15.99 | No Discount | 302 | ⭐⭐⭐⭐☆ (4.4) | PureLeaf | Green | Standard Shipping | Yes |
152
- | **Men’s Running Shoes** | Apparel | $79.99 | 30% off | 85 | ⭐⭐⭐⭐☆ (4.6) | FitStep | Red | Free Shipping | Yes |
153
- | **Stainless Steel Watch** | Accessories | $249.00 | 10% off | 67 | ⭐⭐⭐⭐⭐ (5) | TimeMaster | Silver | Free Shipping | No |
154
- | **Coffee Maker 12 Cup** | Kitchen | $89.99 | No Discount | 121 | ⭐⭐⭐⭐⭐ (5) | BrewMaster | Black | Standard Shipping | Yes |
155
- | **Children’s Toy Set** | Toys & Games | $24.99 | 15% off | 205 | ⭐⭐⭐⭐☆ (4.3) | FunTime | Multi-color | Free Shipping | Yes |
156
-
157
- ### Footnotes
158
-
159
- - Super cheap, buy now [^1]
160
-
161
- [^1]: It's actually expensive.
162
-
163
- ### Strikethrough
164
-
165
- ~one~ or ~~two~~ tildes.
166
-
167
- ### Tasklist
168
-
169
- - [ ] to do
170
- - [x] done
171
-
172
- ### Highlighted blockquotes
173
-
174
- > [!NOTE]
175
- > Highlights information that users should take into account, even when
176
- > skimming.
177
-
178
- > [!IMPORTANT]
179
- > Crucial information necessary for users to succeed.
180
-
181
- > [!WARNING]
182
- > Critical content demanding immediate user attention due to potential risks.
183
-
184
- > [!CAUTION]
185
- > Negative potential consequences of an action.
186
-
187
- > [!TIP]
188
- > Optional information to help a user be more successful. Maybe with more text
189
-
190
- ## Blockquotes
191
-
192
- ### Simple case
193
-
194
- > Sugar plum shortbread dragée chocolate bar lollipop. Bonbon soufflé cupcake
195
- > cotton candy bear claw muffin tiramisu chocolate cake icing. Cake marshmallow
196
- > tart pastry caramels tootsie roll. Gummi bears liquorice tiramisu toffee tart.
197
-
198
- ### With cite
199
-
200
- > Sugar plum shortbread dragée chocolate bar lollipop. Bonbon soufflé cupcake
201
- > cotton candy bear claw muffin tiramisu chocolate cake icing. Cake marshmallow
202
- > tart pastry caramels tootsie roll. Gummi bears liquorice tiramisu toffee tart.
203
- >
204
- > - Dorothy from wizard of oz
205
-
206
- ### Two paragraphs in a blockquote
207
-
208
- > Dorothy followed her through many of the beautiful rooms in her castle.
209
- >
210
- > The Witch bade her clean the pots and kettles and sweep the floor and keep the
211
- > fire fed with wood.
212
-
213
- ### Nested blockquote
214
-
215
- > Dorothy followed her through many of the beautiful rooms in her castle.
216
- >
217
- > > The Witch bade her clean the pots and kettles and sweep the floor and keep
218
- > > the fire fed with wood.
219
-
220
- ### Blockquotes with Other Elements
221
-
222
- > #### The quarterly results look great!
223
- >
224
- > - Revenue was off the chart.
225
- > - Profits were higher than ever.
226
- >
227
- > ---
228
- >
229
- > Kinda fancy looking, right?
230
-
231
- ### Keyboard Combinations
232
-
233
- To enable fruitcake mode, press <kbd>Ctrl</kbd> + <kbd>Alt</kbd> +
234
- <kbd>Space</kbd>.
@@ -1,22 +0,0 @@
1
- ---
2
- id: Media
3
- title: Media
4
- description: Components for displaying media content.
5
- documentState: InitialDraft
6
- order: 3
7
- menu:
8
- - Components
9
- - Media
10
- tags:
11
- - media
12
- icon: Image
13
- ---
14
-
15
- # Media
16
-
17
- Components for displaying media content.
18
-
19
- - **Images**: e.g., Avatar, Image, Carousel.
20
- - **Videos**: e.g., VideoPlayer, VideoThumbnail.
21
- - **Icons**: e.g., Icon, IconButton.
22
- - **Audio**: e.g., AudioPlayer.
@@ -1,22 +0,0 @@
1
- ---
2
- id: Components-Naivgation
3
- title: Navigation
4
- description: Components for moving through an application.
5
- documentState: InitialDraft
6
- order: 2
7
- menu:
8
- - Components
9
- - Navigation
10
- tags:
11
- - document
12
- icon: Explore
13
- ---
14
-
15
- # Navigation
16
-
17
- Components for moving through an application.
18
-
19
- - **Menus**: e.g., Dropdown, ContextMenu.
20
- - **Navigation Bars**: e.g., Navbar, Sidebar, Breadcrumbs.
21
- - **Tabs & Accordions**: e.g., TabPanel, Accordion.
22
- - **Pagination**: e.g., Paginator, InfiniteScroller.
@@ -1,16 +0,0 @@
1
- ---
2
- id: Playground
3
- title: Playground
4
- description: collection of pages with an explorative character
5
- documentState: InitialDraft
6
- order: 999
7
- menu:
8
- - Playground
9
- tags:
10
- - playground
11
- - exploring
12
- ---
13
-
14
- # Playground
15
-
16
- This is the place to try out things.
@@ -1,17 +0,0 @@
1
- ---
2
- id: Component Structure-RFCs
3
- title: RFCs
4
- description: Requests for feedback
5
- documentState: InitialDraft
6
- documentAudiences:
7
- - Maintainer
8
- order: 1.5
9
- menu:
10
- - RFCs
11
- tags:
12
- - document
13
- ---
14
-
15
- # RFCs
16
-
17
- Requests for comments. Just create a document and work on it.