@iress-oss/ids-mcp-server 6.0.0-alpha.0 → 6.0.0-alpha.1-canary-20251204014525-3f0dce4

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 (108) hide show
  1. package/dist/searchHandlers.test.js +8 -2
  2. package/dist/toolHandler.test.js +9 -9
  3. package/dist/utils.test.js +6 -2
  4. package/package.json +32 -30
  5. package/generated/docs/components-alert-docs.md +0 -702
  6. package/generated/docs/components-autocomplete-docs.md +0 -1433
  7. package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
  8. package/generated/docs/components-badge-docs.md +0 -531
  9. package/generated/docs/components-button-docs.md +0 -1442
  10. package/generated/docs/components-buttongroup-docs.md +0 -748
  11. package/generated/docs/components-card-docs.md +0 -944
  12. package/generated/docs/components-checkbox-docs.md +0 -694
  13. package/generated/docs/components-checkboxgroup-docs.md +0 -1087
  14. package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
  15. package/generated/docs/components-col-docs.md +0 -881
  16. package/generated/docs/components-container-docs.md +0 -123
  17. package/generated/docs/components-divider-docs.md +0 -576
  18. package/generated/docs/components-expander-docs.md +0 -594
  19. package/generated/docs/components-field-docs.md +0 -2007
  20. package/generated/docs/components-filter-docs.md +0 -1322
  21. package/generated/docs/components-hide-docs.md +0 -702
  22. package/generated/docs/components-icon-docs.md +0 -816
  23. package/generated/docs/components-image-docs.md +0 -493
  24. package/generated/docs/components-inline-docs.md +0 -2003
  25. package/generated/docs/components-input-docs.md +0 -867
  26. package/generated/docs/components-input-recipes-docs.md +0 -140
  27. package/generated/docs/components-inputcurrency-docs.md +0 -689
  28. package/generated/docs/components-inputcurrency-recipes-docs.md +0 -115
  29. package/generated/docs/components-introduction-docs.md +0 -450
  30. package/generated/docs/components-label-docs.md +0 -562
  31. package/generated/docs/components-link-docs.md +0 -586
  32. package/generated/docs/components-menu-docs.md +0 -1146
  33. package/generated/docs/components-menu-menuitem-docs.md +0 -739
  34. package/generated/docs/components-modal-docs.md +0 -1346
  35. package/generated/docs/components-panel-docs.md +0 -600
  36. package/generated/docs/components-placeholder-docs.md +0 -446
  37. package/generated/docs/components-popover-docs.md +0 -1529
  38. package/generated/docs/components-popover-recipes-docs.md +0 -211
  39. package/generated/docs/components-progress-docs.md +0 -568
  40. package/generated/docs/components-provider-docs.md +0 -160
  41. package/generated/docs/components-radio-docs.md +0 -563
  42. package/generated/docs/components-radiogroup-docs.md +0 -1153
  43. package/generated/docs/components-readonly-docs.md +0 -535
  44. package/generated/docs/components-richselect-docs.md +0 -5836
  45. package/generated/docs/components-row-docs.md +0 -2354
  46. package/generated/docs/components-select-docs.md +0 -940
  47. package/generated/docs/components-skeleton-docs.md +0 -597
  48. package/generated/docs/components-skeleton-recipes-docs.md +0 -76
  49. package/generated/docs/components-skiplink-docs.md +0 -587
  50. package/generated/docs/components-slideout-docs.md +0 -1036
  51. package/generated/docs/components-slider-docs.md +0 -828
  52. package/generated/docs/components-spinner-docs.md +0 -450
  53. package/generated/docs/components-stack-docs.md +0 -923
  54. package/generated/docs/components-table-ag-grid-docs.md +0 -1444
  55. package/generated/docs/components-table-docs.md +0 -2327
  56. package/generated/docs/components-tabset-docs.md +0 -768
  57. package/generated/docs/components-tabset-tab-docs.md +0 -550
  58. package/generated/docs/components-tag-docs.md +0 -548
  59. package/generated/docs/components-text-docs.md +0 -585
  60. package/generated/docs/components-toaster-docs.md +0 -755
  61. package/generated/docs/components-toggle-docs.md +0 -614
  62. package/generated/docs/components-tooltip-docs.md +0 -747
  63. package/generated/docs/components-validationmessage-docs.md +0 -1161
  64. package/generated/docs/contact-us-docs.md +0 -27
  65. package/generated/docs/extensions-editor-docs.md +0 -1181
  66. package/generated/docs/extensions-editor-recipes-docs.md +0 -89
  67. package/generated/docs/foundations-accessibility-docs.md +0 -40
  68. package/generated/docs/foundations-consistency-docs.md +0 -52
  69. package/generated/docs/foundations-content-docs.md +0 -23
  70. package/generated/docs/foundations-grid-docs.md +0 -74
  71. package/generated/docs/foundations-introduction-docs.md +0 -19
  72. package/generated/docs/foundations-principles-docs.md +0 -70
  73. package/generated/docs/foundations-responsive-breakpoints-docs.md +0 -193
  74. package/generated/docs/foundations-tokens-colour-docs.md +0 -564
  75. package/generated/docs/foundations-tokens-elevation-docs.md +0 -155
  76. package/generated/docs/foundations-tokens-introduction-docs.md +0 -190
  77. package/generated/docs/foundations-tokens-radius-docs.md +0 -71
  78. package/generated/docs/foundations-tokens-spacing-docs.md +0 -89
  79. package/generated/docs/foundations-tokens-typography-docs.md +0 -322
  80. package/generated/docs/foundations-user-experience-docs.md +0 -63
  81. package/generated/docs/foundations-visual-design-docs.md +0 -46
  82. package/generated/docs/foundations-z-index-stacking-docs.md +0 -31
  83. package/generated/docs/frequently-asked-questions-docs.md +0 -53
  84. package/generated/docs/get-started-develop-docs.md +0 -209
  85. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  86. package/generated/docs/guidelines.md +0 -2054
  87. package/generated/docs/introduction-docs.md +0 -87
  88. package/generated/docs/news-version-6-docs.md +0 -93
  89. package/generated/docs/patterns-form-docs.md +0 -3902
  90. package/generated/docs/patterns-form-recipes-docs.md +0 -1370
  91. package/generated/docs/patterns-introduction-docs.md +0 -24
  92. package/generated/docs/patterns-loading-docs.md +0 -4043
  93. package/generated/docs/resources-code-katas-docs.md +0 -29
  94. package/generated/docs/resources-introduction-docs.md +0 -38
  95. package/generated/docs/resources-mcp-server-docs.md +0 -27
  96. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  97. package/generated/docs/styling-props-colour-docs.md +0 -172
  98. package/generated/docs/styling-props-elevation-docs.md +0 -88
  99. package/generated/docs/styling-props-radius-docs.md +0 -86
  100. package/generated/docs/styling-props-reference-docs.md +0 -160
  101. package/generated/docs/styling-props-screen-readers-docs.md +0 -71
  102. package/generated/docs/styling-props-sizing-docs.md +0 -627
  103. package/generated/docs/styling-props-spacing-docs.md +0 -2282
  104. package/generated/docs/styling-props-typography-docs.md +0 -121
  105. package/generated/docs/themes-available-themes-docs.md +0 -66
  106. package/generated/docs/themes-introduction-docs.md +0 -121
  107. package/generated/docs/versions-docs.md +0 -17
  108. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,2003 +0,0 @@
1
- [](#inline)Inline
2
- =================
3
-
4
- Overview
5
- --------
6
-
7
- `IressInline` renders a set of components in a row with equal spacing around them, wrapping onto multiple lines when necessary.
8
-
9
- * * *
10
-
11
- Updated
12
-
13
- **Recently updated**
14
-
15
- This component has been recently updated with new props. The props have been marked as beta. Please tell us if there are any issues.
16
-
17
- Hide code
18
-
19
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
20
-
21
- <IressInline gap\="spacing.400"\>
22
- <IressPlaceholder
23
- style\={{
24
- minHeight: '30px'
25
- }}
26
- width\="50"
27
- />
28
- <IressPlaceholder
29
- style\={{
30
- minHeight: '50px'
31
- }}
32
- width\="50"
33
- />
34
- <IressPlaceholder
35
- style\={{
36
- minHeight: '80px'
37
- }}
38
- width\="50"
39
- />
40
- <IressPlaceholder
41
- style\={{
42
- minHeight: '60px'
43
- }}
44
- width\="50"
45
- />
46
- <IressPlaceholder
47
- style\={{
48
- minHeight: '10px'
49
- }}
50
- width\="50"
51
- />
52
- </IressInline\>
53
-
54
- Copy
55
-
56
- [](#props)Props
57
- ---------------
58
-
59
- | Name | Description | Default | Control |
60
- | --- | --- | --- | --- |
61
- | bg |
62
- **`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
63
-
64
- We recommend using the following token values for best background contrast:
65
-
66
- * `colour.primary.fill` for primary backgrounds that need to stand out
67
- * `colour.primary.surface` for primary backgrounds that need to be less prominent
68
- * `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
69
- * `colour.neutral.20` for a slightly darker background color, used in neutral state components
70
- * `colour.system.danger.fill` for error backgrounds that need to stand out
71
- * `colour.system.danger.surface` for error backgrounds that need to be less prominent
72
- * `colour.system.success.fill` for success backgrounds that need to stand out
73
- * `colour.system.success.surface` for success backgrounds that need to be less prominent
74
- * `colour.system.warning.fill` for warning backgrounds that need to stand out
75
- * `colour.system.warning.surface` for warning backgrounds that need to be less prominent
76
- * `colour.system.info.fill` for info backgrounds that need to stand out
77
- * `colour.system.info.surface` for info backgrounds that need to be less prominent
78
-
79
- ResponsiveProp<ColorToken> | undefined
80
-
81
- | \- | Set object |
82
- | borderRadius |
83
-
84
- The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
85
-
86
- | Chrome | Firefox | Safari | Edge | IE |
87
- | --- | --- | --- | --- | --- |
88
- | **4** | **4** | **5** | **12** | **9** |
89
- | 1 _\-x-_ | | 3 _\-x-_ | | |
90
-
91
- ResponsiveProp<RadiusToken> | undefined
92
-
93
- | \- | Set object |
94
- | children |
95
-
96
- Content to be displayed inline.
97
-
98
- ReactNode
99
-
100
-
101
-
102
- | \- | Choose option...evenunevenstory |
103
- | color |
104
-
105
- The **`color`** CSS property sets the foreground color value of an element's text and text decorations using the colour tokens from the design system. It also sets the `currentcolor` value. `currentcolor` may be used as an indirect value on _other_ properties and is the default for other color properties, such as `border-color`.
106
-
107
- We recommend using the following token values for best color contrast:
108
-
109
- * `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
110
- * `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
111
- * `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
112
- * `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
113
- * `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
114
- * `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
115
- * `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
116
- * `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
117
- * `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
118
- * `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
119
- * `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
120
- * `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
121
-
122
- ResponsiveProp<ColorToken> | undefined
123
-
124
- | \- | Set object |
125
- | focusable |
126
-
127
- The `focusable` prop is used to apply the focus elevation when focused. It can be set to `true` to apply focus styles on focus, or `'within'` to apply focus styles when the element or any of its children are focused.
128
-
129
- "true""within"undefined
130
-
131
-
132
-
133
- | \- | Set object |
134
- | gap |
135
-
136
- Sets the gap between direct children.
137
-
138
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
139
-
140
- | \- |
141
-
142
- "spacing.400"
143
-
144
- |
145
- | hide |
146
-
147
- Set **`hide`** to hide an element completely using `display: none`. It can also be set to an object of breakpoints to hide the element at specific breakpoints.
148
-
149
- Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
150
-
151
- Notes:
152
-
153
- * If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
154
- * Consider if you can conditionally render the element instead of hiding it.
155
-
156
- ResponsiveProp<boolean> | undefined
157
-
158
- | \- | Set object |
159
- | horizontalAlign |
160
-
161
- Sets the horizontal alignment of the inline content.
162
-
163
- "center""left""right""around""between""evenly"undefined
164
-
165
-
166
-
167
- | \- | Set object |
168
- | layerStyle |
169
-
170
- Elevate a layer by using a **`layerStyle`**. These are connected to the elevation tokens in the design system. They can be combined to create hierarchy and structure.
171
-
172
- * `elevation.raised`: Raised elevations sit slightly higher than other content. They are reserved for cards that can be moved, such as Jira issue cards and Trello cards. In special circumstances, they can be used for cards as a way to provide additional heirarchy or emphasis.
173
- * `elevation.floating`: Floating is the highest elevation available. It is reserved for a UI that sits over another UI, such as modals, dialogs, dropdown menus, floating toolbars, and floating single-action buttons.
174
- * `elevation.overflow`: Overflow is a shadow indicating content has scrolled outside a view. It can be used for vertical or horizontal scroll. An example of overflow shadows is the horizontal scroll in tables on a Confluence page.
175
-
176
- ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
177
-
178
- | \- | Set object |
179
- | m |
180
-
181
- The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
182
-
183
- It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
184
-
185
- | Chrome | Firefox | Safari | Edge | IE |
186
- | --- | --- | --- | --- | --- |
187
- | **1** | **1** | **1** | **12** | **3** |
188
-
189
- ResponsiveProp<SpacingToken | "auto"> | undefined
190
-
191
- | \- | Set object |
192
- | maxWidth |
193
-
194
- The **`max-width`** CSS property sets the maximum width of an element. It prevents the used value of the `width` property from becoming larger than the value specified by `max-width`.
195
-
196
- | Chrome | Firefox | Safari | Edge | IE |
197
- | --- | --- | --- | --- | --- |
198
- | **1** | **1** | **1** | **12** | **7** |
199
-
200
- ResponsiveProp<"auto" | SizeToken | "screen" | "1/2" | "1/3" | "2/3" | "1/4" | "2/4" | "3/4" | "1/5" | "2/5" | "3/5" | "4/5" | "1/6" | "2/6" | "3/6" | "4/6" | "5/6" | "1/12" | "2/12" | ... 8 more ... | "11/12"> | undefined
201
-
202
- | \- | Set object |
203
- | mb |
204
-
205
- The **`mb`** property is short for `margin-bottom` and sets the margin area on the bottom side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
206
-
207
- It uses the spacing tokens in the design system.
208
-
209
- | Chrome | Firefox | Safari | Edge | IE |
210
- | --- | --- | --- | --- | --- |
211
- | **1** | **1** | **1** | **12** | **3** |
212
-
213
- ResponsiveProp<SpacingToken | "auto"> | undefined
214
-
215
- | \- | Set object |
216
- | ml |
217
-
218
- The **`ml`** property is short for `margin-left` and sets the margin area on the left side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
219
-
220
- It uses the spacing tokens in the design system.
221
-
222
- | Chrome | Firefox | Safari | Edge | IE |
223
- | --- | --- | --- | --- | --- |
224
- | **1** | **1** | **1** | **12** | **3** |
225
-
226
- ResponsiveProp<SpacingToken | "auto"> | undefined
227
-
228
- | \- | Set object |
229
- | mr |
230
-
231
- The **`mr`** property is short for `margin-right` and sets the margin area on the right side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
232
-
233
- It uses the spacing tokens in the design system.
234
-
235
- | Chrome | Firefox | Safari | Edge | IE |
236
- | --- | --- | --- | --- | --- |
237
- | **1** | **1** | **1** | **12** | **3** |
238
-
239
- ResponsiveProp<SpacingToken | "auto"> | undefined
240
-
241
- | \- | Set object |
242
- | mt |
243
-
244
- The **`mt`** property is short for `margin-top` and sets the margin area on the top side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
245
-
246
- It uses the spacing tokens in the design system.
247
-
248
- | Chrome | Firefox | Safari | Edge | IE |
249
- | --- | --- | --- | --- | --- |
250
- | **1** | **1** | **1** | **12** | **3** |
251
-
252
- ResponsiveProp<SpacingToken | "auto"> | undefined
253
-
254
- | \- | Set object |
255
- | mx |
256
-
257
- The **`mx`** property is short for `margin-inline`. It is a shorthand property that defines both the logical inline start and end margins of an element, which maps to physical margins depending on the element's writing mode, directionality, and text orientation.
258
-
259
- It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
260
-
261
- | Chrome | Firefox | Safari | Edge | IE |
262
- | --- | --- | --- | --- | --- |
263
- | **1** | **1** | **1** | **12** | **3** |
264
-
265
- ResponsiveProp<SpacingToken | "auto"> | undefined
266
-
267
- | \- | Set object |
268
- | my |
269
-
270
- The **`my`** property is short for `margin-block`. It defines the logical block start and end margins of an element, which maps to physical margins depending on the element's writing mode, directionality, and text orientation.
271
-
272
- It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
273
-
274
- | Chrome | Firefox | Safari | Edge | IE |
275
- | --- | --- | --- | --- | --- |
276
- | **1** | **1** | **1** | **12** | **3** |
277
-
278
- ResponsiveProp<SpacingToken | "auto"> | undefined
279
-
280
- | \- | Set object |
281
- | noGutter |
282
-
283
- The **`noGutter`** property is used to remove the bottom margin from the last child of a component. This is useful when you want to avoid extra spacing at the end of a layout.
284
-
285
- booleanundefined
286
-
287
-
288
-
289
- | \- | Set object |
290
- | noWrap |
291
-
292
- Wraps content when stretches beyond container.
293
-
294
- booleanundefined
295
-
296
-
297
-
298
- | \- | Set object |
299
- | p |
300
-
301
- The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
302
-
303
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
304
-
305
- | Chrome | Firefox | Safari | Edge | IE |
306
- | --- | --- | --- | --- | --- |
307
- | **1** | **1** | **1** | **12** | **3** |
308
-
309
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
310
-
311
- | \- | Set object |
312
- | pb |
313
-
314
- The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
315
-
316
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
317
-
318
- | Chrome | Firefox | Safari | Edge | IE |
319
- | --- | --- | --- | --- | --- |
320
- | **1** | **1** | **1** | **12** | **3** |
321
-
322
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
323
-
324
- | \- | Set object |
325
- | pl |
326
-
327
- The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
328
-
329
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
330
-
331
- | Chrome | Firefox | Safari | Edge | IE |
332
- | --- | --- | --- | --- | --- |
333
- | **1** | **1** | **1** | **12** | **3** |
334
-
335
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
336
-
337
- | \- | Set object |
338
- | pr |
339
-
340
- The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
341
-
342
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
343
-
344
- | Chrome | Firefox | Safari | Edge | IE |
345
- | --- | --- | --- | --- | --- |
346
- | **1** | **1** | **1** | **12** | **3** |
347
-
348
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
349
-
350
- | \- | Set object |
351
- | pt |
352
-
353
- The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
354
-
355
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
356
-
357
- | Chrome | Firefox | Safari | Edge | IE |
358
- | --- | --- | --- | --- | --- |
359
- | **1** | **1** | **1** | **12** | **3** |
360
-
361
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
362
-
363
- | \- | Set object |
364
- | px |
365
-
366
- The **`px`** property is short for `padding-inline`. It is a shorthand property that defines both the logical inline start and end paddings of an element, which maps to physical paddings depending on the element's writing mode, directionality, and text orientation.
367
-
368
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
369
-
370
- | Chrome | Firefox | Safari | Edge | IE |
371
- | --- | --- | --- | --- | --- |
372
- | **1** | **1** | **1** | **12** | **3** |
373
-
374
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
375
-
376
- | \- | Set object |
377
- | py |
378
-
379
- The **`py`** property is short for `padding-block`. It defines the logical block start and end paddings of an element, which maps to physical paddings depending on the element's writing mode, directionality, and text orientation.
380
-
381
- It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
382
-
383
- | Chrome | Firefox | Safari | Edge | IE |
384
- | --- | --- | --- | --- | --- |
385
- | **1** | **1** | **1** | **12** | **3** |
386
-
387
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
388
-
389
- | \- | Set object |
390
- | rowGap |
391
-
392
- Sets the size of the top and bottom gap between direct children when they begin to wrap.
393
-
394
- ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
395
-
396
- | \- | Set object |
397
- | srOnly |
398
-
399
- Set **`srOnly`** to hide an element visually but still make it accessible to screen readers. It can also be set to an object of breakpoints to hide the element at specific breakpoints.
400
-
401
- Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
402
-
403
- ResponsiveProp<boolean> | undefined
404
-
405
- | \- | Set object |
406
- | stretch |
407
-
408
- The **`stretch`** property is used to stretch an element to fill the available space in its parent container. It sets the `height` property to `100%` and `alignSelf` to `stretch`, allowing the element to expand and contract based on the size of its parent.
409
-
410
- booleanundefined
411
-
412
-
413
-
414
- | \- | Set object |
415
- | textAlign |
416
-
417
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
418
-
419
- | Chrome | Firefox | Safari | Edge | IE |
420
- | --- | --- | --- | --- | --- |
421
- | **1** | **1** | **1** | **12** | **3** |
422
-
423
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
424
-
425
- | \- | Set object |
426
- | textStyle |
427
-
428
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
429
-
430
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
431
- * `typography.body.md` - The most commonly used body text size, used for most text content in the product and the default state of all components in the design system.
432
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
433
- * `typography.heading.1` - Use for the main page title to establish a clear hierarchy. There is typically only one H1 per screen, emphasising the primary purpose or context of the page.
434
- * `typography.heading.2` - Use for primary section headings within a page to organise content and guide the user through key areas. Also suitable for large components—such as modals—where space allows and where it pairs well with body.md or body.lg.
435
- * `typography.heading.3` - Use for sub-sections under H2s to further structure content and maintain a clear visual hierarchy. Ideal for breaking down complex sections into manageable parts.
436
- * `typography.heading.4` - Use for supporting headings within content blocks or small components where space is limited—such as table headers, cards, or side panels. Provides structure without overwhelming the layout.
437
- * `typography.heading.5` - Use for minor labels or titles in compact UI elements, such as cards, sidebars, or inline labels. Best used to emphasise supplementary information without drawing too much attention. Works well with body.sm and is ideal for subtle content like fine print. Use sparingly to preserve typographic hierarchy.
438
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
439
-
440
- ResponsiveProp<"typography.heading.1" | "typography.heading.2" | "typography.heading.3" | "typography.heading.4" | "typography.heading.5" | "typography.body.sm" | "typography.body.sm.regular" | ... 10 more ... | "typography.code"> | undefined
441
-
442
- | \- | Set object |
443
- | verticalAlign |
444
-
445
- Sets the vertical alignment of the inline content.
446
-
447
- "stretch""bottom""top""middle"undefined
448
-
449
-
450
-
451
- | \- | Set object |
452
- | width |
453
-
454
- The **`width`** CSS property sets an element's width. By default, it sets the width of the content area, but if `box-sizing` is set to `border-box`, it sets the width of the border area.
455
-
456
- This prop only allows widths available throughout the component library. To use a custom width, you need to use the `style` prop, or add a custom class to the element and use CSS.
457
-
458
- | Chrome | Firefox | Safari | Edge | IE |
459
- | --- | --- | --- | --- | --- |
460
- | **1** | **1** | **1** | **12** | **4** |
461
-
462
- ResponsiveProp<"auto" | SizeToken | "screen" | "1/2" | "1/3" | "2/3" | "1/4" | "2/4" | "3/4" | "1/5" | "2/5" | "3/5" | "4/5" | "1/6" | "2/6" | "3/6" | "4/6" | "5/6" | "1/12" | "2/12" | ... 8 more ... | "11/12"> | undefined
463
-
464
- | \- | Set object |
465
-
466
- [](#examples)Examples
467
- ---------------------
468
-
469
- ### [](#gap)Gap
470
-
471
- Inline spacing is applied to the direct children of the `IressInline` component.
472
-
473
- The amount of spacing is controlled by the `gap` prop and can be set from `spacing.000` to `spacing.1200`.
474
-
475
- #### [](#what-happened-to-gutter)What happened to `gutter`?
476
-
477
- The previous `gutter` prop has been replaced by `gap`, which uses the latest set of spacing tokens.
478
-
479
- Here is the mapping of previous `gutter` scale and current `gap` value:
480
-
481
- | Deprecated Gutter Scale | New Gap Value |
482
- | --- | --- |
483
- | none | spacing.000 |
484
- | xs | spacing.100 |
485
- | sm | spacing.200 |
486
- | md | spacing.400 |
487
- | lg | spacing.700 |
488
- | xl | spacing.1200 |
489
-
490
- spacing.000
491
- -----------
492
-
493
- spacing.050
494
- -----------
495
-
496
- spacing.100
497
- -----------
498
-
499
- spacing.150
500
- -----------
501
-
502
- spacing.200
503
- -----------
504
-
505
- spacing.250
506
- -----------
507
-
508
- spacing.300
509
- -----------
510
-
511
- spacing.350
512
- -----------
513
-
514
- spacing.400
515
- -----------
516
-
517
- spacing.500
518
- -----------
519
-
520
- spacing.600
521
- -----------
522
-
523
- spacing.700
524
- -----------
525
-
526
- spacing.800
527
- -----------
528
-
529
- spacing.900
530
- -----------
531
-
532
- spacing.1000
533
- ------------
534
-
535
- spacing.1200
536
- ------------
537
-
538
- none
539
- ----
540
-
541
- xs
542
- --
543
-
544
- sm
545
- --
546
-
547
- md
548
- --
549
-
550
- lg
551
- --
552
-
553
- xl
554
- --
555
-
556
- field.footer
557
- ------------
558
-
559
- slider.tick
560
- -----------
561
-
562
- Hide code
563
-
564
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
565
-
566
- <IressStack gap\="spacing.1200"\>
567
- <IressText\>
568
- <h2\>
569
- spacing.000 </h2\>
570
- <IressInline gap\="spacing.000"\>
571
- <IressPlaceholder
572
- style\={{
573
- minHeight: '50px'
574
- }}
575
- width\="50"
576
- />
577
- <IressPlaceholder
578
- style\={{
579
- minHeight: '50px'
580
- }}
581
- width\="50"
582
- />
583
- <IressPlaceholder
584
- style\={{
585
- minHeight: '50px'
586
- }}
587
- width\="50"
588
- />
589
- <IressPlaceholder
590
- style\={{
591
- minHeight: '50px'
592
- }}
593
- width\="50"
594
- />
595
- <IressPlaceholder
596
- style\={{
597
- minHeight: '50px'
598
- }}
599
- width\="50"
600
- />
601
- </IressInline\>
602
- </IressText\>
603
- <IressText\>
604
- <h2\>
605
- spacing.050 </h2\>
606
- <IressInline gap\="spacing.050"\>
607
- <IressPlaceholder
608
- style\={{
609
- minHeight: '50px'
610
- }}
611
- width\="50"
612
- />
613
- <IressPlaceholder
614
- style\={{
615
- minHeight: '50px'
616
- }}
617
- width\="50"
618
- />
619
- <IressPlaceholder
620
- style\={{
621
- minHeight: '50px'
622
- }}
623
- width\="50"
624
- />
625
- <IressPlaceholder
626
- style\={{
627
- minHeight: '50px'
628
- }}
629
- width\="50"
630
- />
631
- <IressPlaceholder
632
- style\={{
633
- minHeight: '50px'
634
- }}
635
- width\="50"
636
- />
637
- </IressInline\>
638
- </IressText\>
639
- <IressText\>
640
- <h2\>
641
- spacing.100 </h2\>
642
- <IressInline gap\="spacing.100"\>
643
- <IressPlaceholder
644
- style\={{
645
- minHeight: '50px'
646
- }}
647
- width\="50"
648
- />
649
- <IressPlaceholder
650
- style\={{
651
- minHeight: '50px'
652
- }}
653
- width\="50"
654
- />
655
- <IressPlaceholder
656
- style\={{
657
- minHeight: '50px'
658
- }}
659
- width\="50"
660
- />
661
- <IressPlaceholder
662
- style\={{
663
- minHeight: '50px'
664
- }}
665
- width\="50"
666
- />
667
- <IressPlaceholder
668
- style\={{
669
- minHeight: '50px'
670
- }}
671
- width\="50"
672
- />
673
- </IressInline\>
674
- </IressText\>
675
- <IressText\>
676
- <h2\>
677
- spacing.150 </h2\>
678
- <IressInline gap\="spacing.150"\>
679
- <IressPlaceholder
680
- style\={{
681
- minHeight: '50px'
682
- }}
683
- width\="50"
684
- />
685
- <IressPlaceholder
686
- style\={{
687
- minHeight: '50px'
688
- }}
689
- width\="50"
690
- />
691
- <IressPlaceholder
692
- style\={{
693
- minHeight: '50px'
694
- }}
695
- width\="50"
696
- />
697
- <IressPlaceholder
698
- style\={{
699
- minHeight: '50px'
700
- }}
701
- width\="50"
702
- />
703
- <IressPlaceholder
704
- style\={{
705
- minHeight: '50px'
706
- }}
707
- width\="50"
708
- />
709
- </IressInline\>
710
- </IressText\>
711
- <IressText\>
712
- <h2\>
713
- spacing.200 </h2\>
714
- <IressInline gap\="spacing.200"\>
715
- <IressPlaceholder
716
- style\={{
717
- minHeight: '50px'
718
- }}
719
- width\="50"
720
- />
721
- <IressPlaceholder
722
- style\={{
723
- minHeight: '50px'
724
- }}
725
- width\="50"
726
- />
727
- <IressPlaceholder
728
- style\={{
729
- minHeight: '50px'
730
- }}
731
- width\="50"
732
- />
733
- <IressPlaceholder
734
- style\={{
735
- minHeight: '50px'
736
- }}
737
- width\="50"
738
- />
739
- <IressPlaceholder
740
- style\={{
741
- minHeight: '50px'
742
- }}
743
- width\="50"
744
- />
745
- </IressInline\>
746
- </IressText\>
747
- <IressText\>
748
- <h2\>
749
- spacing.250 </h2\>
750
- <IressInline gap\="spacing.250"\>
751
- <IressPlaceholder
752
- style\={{
753
- minHeight: '50px'
754
- }}
755
- width\="50"
756
- />
757
- <IressPlaceholder
758
- style\={{
759
- minHeight: '50px'
760
- }}
761
- width\="50"
762
- />
763
- <IressPlaceholder
764
- style\={{
765
- minHeight: '50px'
766
- }}
767
- width\="50"
768
- />
769
- <IressPlaceholder
770
- style\={{
771
- minHeight: '50px'
772
- }}
773
- width\="50"
774
- />
775
- <IressPlaceholder
776
- style\={{
777
- minHeight: '50px'
778
- }}
779
- width\="50"
780
- />
781
- </IressInline\>
782
- </IressText\>
783
- <IressText\>
784
- <h2\>
785
- spacing.300 </h2\>
786
- <IressInline gap\="spacing.300"\>
787
- <IressPlaceholder
788
- style\={{
789
- minHeight: '50px'
790
- }}
791
- width\="50"
792
- />
793
- <IressPlaceholder
794
- style\={{
795
- minHeight: '50px'
796
- }}
797
- width\="50"
798
- />
799
- <IressPlaceholder
800
- style\={{
801
- minHeight: '50px'
802
- }}
803
- width\="50"
804
- />
805
- <IressPlaceholder
806
- style\={{
807
- minHeight: '50px'
808
- }}
809
- width\="50"
810
- />
811
- <IressPlaceholder
812
- style\={{
813
- minHeight: '50px'
814
- }}
815
- width\="50"
816
- />
817
- </IressInline\>
818
- </IressText\>
819
- <IressText\>
820
- <h2\>
821
- spacing.350 </h2\>
822
- <IressInline gap\="spacing.350"\>
823
- <IressPlaceholder
824
- style\={{
825
- minHeight: '50px'
826
- }}
827
- width\="50"
828
- />
829
- <IressPlaceholder
830
- style\={{
831
- minHeight: '50px'
832
- }}
833
- width\="50"
834
- />
835
- <IressPlaceholder
836
- style\={{
837
- minHeight: '50px'
838
- }}
839
- width\="50"
840
- />
841
- <IressPlaceholder
842
- style\={{
843
- minHeight: '50px'
844
- }}
845
- width\="50"
846
- />
847
- <IressPlaceholder
848
- style\={{
849
- minHeight: '50px'
850
- }}
851
- width\="50"
852
- />
853
- </IressInline\>
854
- </IressText\>
855
- <IressText\>
856
- <h2\>
857
- spacing.400 </h2\>
858
- <IressInline gap\="spacing.400"\>
859
- <IressPlaceholder
860
- style\={{
861
- minHeight: '50px'
862
- }}
863
- width\="50"
864
- />
865
- <IressPlaceholder
866
- style\={{
867
- minHeight: '50px'
868
- }}
869
- width\="50"
870
- />
871
- <IressPlaceholder
872
- style\={{
873
- minHeight: '50px'
874
- }}
875
- width\="50"
876
- />
877
- <IressPlaceholder
878
- style\={{
879
- minHeight: '50px'
880
- }}
881
- width\="50"
882
- />
883
- <IressPlaceholder
884
- style\={{
885
- minHeight: '50px'
886
- }}
887
- width\="50"
888
- />
889
- </IressInline\>
890
- </IressText\>
891
- <IressText\>
892
- <h2\>
893
- spacing.500 </h2\>
894
- <IressInline gap\="spacing.500"\>
895
- <IressPlaceholder
896
- style\={{
897
- minHeight: '50px'
898
- }}
899
- width\="50"
900
- />
901
- <IressPlaceholder
902
- style\={{
903
- minHeight: '50px'
904
- }}
905
- width\="50"
906
- />
907
- <IressPlaceholder
908
- style\={{
909
- minHeight: '50px'
910
- }}
911
- width\="50"
912
- />
913
- <IressPlaceholder
914
- style\={{
915
- minHeight: '50px'
916
- }}
917
- width\="50"
918
- />
919
- <IressPlaceholder
920
- style\={{
921
- minHeight: '50px'
922
- }}
923
- width\="50"
924
- />
925
- </IressInline\>
926
- </IressText\>
927
- <IressText\>
928
- <h2\>
929
- spacing.600 </h2\>
930
- <IressInline gap\="spacing.600"\>
931
- <IressPlaceholder
932
- style\={{
933
- minHeight: '50px'
934
- }}
935
- width\="50"
936
- />
937
- <IressPlaceholder
938
- style\={{
939
- minHeight: '50px'
940
- }}
941
- width\="50"
942
- />
943
- <IressPlaceholder
944
- style\={{
945
- minHeight: '50px'
946
- }}
947
- width\="50"
948
- />
949
- <IressPlaceholder
950
- style\={{
951
- minHeight: '50px'
952
- }}
953
- width\="50"
954
- />
955
- <IressPlaceholder
956
- style\={{
957
- minHeight: '50px'
958
- }}
959
- width\="50"
960
- />
961
- </IressInline\>
962
- </IressText\>
963
- <IressText\>
964
- <h2\>
965
- spacing.700 </h2\>
966
- <IressInline gap\="spacing.700"\>
967
- <IressPlaceholder
968
- style\={{
969
- minHeight: '50px'
970
- }}
971
- width\="50"
972
- />
973
- <IressPlaceholder
974
- style\={{
975
- minHeight: '50px'
976
- }}
977
- width\="50"
978
- />
979
- <IressPlaceholder
980
- style\={{
981
- minHeight: '50px'
982
- }}
983
- width\="50"
984
- />
985
- <IressPlaceholder
986
- style\={{
987
- minHeight: '50px'
988
- }}
989
- width\="50"
990
- />
991
- <IressPlaceholder
992
- style\={{
993
- minHeight: '50px'
994
- }}
995
- width\="50"
996
- />
997
- </IressInline\>
998
- </IressText\>
999
- <IressText\>
1000
- <h2\>
1001
- spacing.800 </h2\>
1002
- <IressInline gap\="spacing.800"\>
1003
- <IressPlaceholder
1004
- style\={{
1005
- minHeight: '50px'
1006
- }}
1007
- width\="50"
1008
- />
1009
- <IressPlaceholder
1010
- style\={{
1011
- minHeight: '50px'
1012
- }}
1013
- width\="50"
1014
- />
1015
- <IressPlaceholder
1016
- style\={{
1017
- minHeight: '50px'
1018
- }}
1019
- width\="50"
1020
- />
1021
- <IressPlaceholder
1022
- style\={{
1023
- minHeight: '50px'
1024
- }}
1025
- width\="50"
1026
- />
1027
- <IressPlaceholder
1028
- style\={{
1029
- minHeight: '50px'
1030
- }}
1031
- width\="50"
1032
- />
1033
- </IressInline\>
1034
- </IressText\>
1035
- <IressText\>
1036
- <h2\>
1037
- spacing.900 </h2\>
1038
- <IressInline gap\="spacing.900"\>
1039
- <IressPlaceholder
1040
- style\={{
1041
- minHeight: '50px'
1042
- }}
1043
- width\="50"
1044
- />
1045
- <IressPlaceholder
1046
- style\={{
1047
- minHeight: '50px'
1048
- }}
1049
- width\="50"
1050
- />
1051
- <IressPlaceholder
1052
- style\={{
1053
- minHeight: '50px'
1054
- }}
1055
- width\="50"
1056
- />
1057
- <IressPlaceholder
1058
- style\={{
1059
- minHeight: '50px'
1060
- }}
1061
- width\="50"
1062
- />
1063
- <IressPlaceholder
1064
- style\={{
1065
- minHeight: '50px'
1066
- }}
1067
- width\="50"
1068
- />
1069
- </IressInline\>
1070
- </IressText\>
1071
- <IressText\>
1072
- <h2\>
1073
- spacing.1000 </h2\>
1074
- <IressInline gap\="spacing.1000"\>
1075
- <IressPlaceholder
1076
- style\={{
1077
- minHeight: '50px'
1078
- }}
1079
- width\="50"
1080
- />
1081
- <IressPlaceholder
1082
- style\={{
1083
- minHeight: '50px'
1084
- }}
1085
- width\="50"
1086
- />
1087
- <IressPlaceholder
1088
- style\={{
1089
- minHeight: '50px'
1090
- }}
1091
- width\="50"
1092
- />
1093
- <IressPlaceholder
1094
- style\={{
1095
- minHeight: '50px'
1096
- }}
1097
- width\="50"
1098
- />
1099
- <IressPlaceholder
1100
- style\={{
1101
- minHeight: '50px'
1102
- }}
1103
- width\="50"
1104
- />
1105
- </IressInline\>
1106
- </IressText\>
1107
- <IressText\>
1108
- <h2\>
1109
- spacing.1200 </h2\>
1110
- <IressInline gap\="spacing.1200"\>
1111
- <IressPlaceholder
1112
- style\={{
1113
- minHeight: '50px'
1114
- }}
1115
- width\="50"
1116
- />
1117
- <IressPlaceholder
1118
- style\={{
1119
- minHeight: '50px'
1120
- }}
1121
- width\="50"
1122
- />
1123
- <IressPlaceholder
1124
- style\={{
1125
- minHeight: '50px'
1126
- }}
1127
- width\="50"
1128
- />
1129
- <IressPlaceholder
1130
- style\={{
1131
- minHeight: '50px'
1132
- }}
1133
- width\="50"
1134
- />
1135
- <IressPlaceholder
1136
- style\={{
1137
- minHeight: '50px'
1138
- }}
1139
- width\="50"
1140
- />
1141
- </IressInline\>
1142
- </IressText\>
1143
- <IressText\>
1144
- <h2\>
1145
- none </h2\>
1146
- <IressInline gap\="none"\>
1147
- <IressPlaceholder
1148
- style\={{
1149
- minHeight: '50px'
1150
- }}
1151
- width\="50"
1152
- />
1153
- <IressPlaceholder
1154
- style\={{
1155
- minHeight: '50px'
1156
- }}
1157
- width\="50"
1158
- />
1159
- <IressPlaceholder
1160
- style\={{
1161
- minHeight: '50px'
1162
- }}
1163
- width\="50"
1164
- />
1165
- <IressPlaceholder
1166
- style\={{
1167
- minHeight: '50px'
1168
- }}
1169
- width\="50"
1170
- />
1171
- <IressPlaceholder
1172
- style\={{
1173
- minHeight: '50px'
1174
- }}
1175
- width\="50"
1176
- />
1177
- </IressInline\>
1178
- </IressText\>
1179
- <IressText\>
1180
- <h2\>
1181
- xs </h2\>
1182
- <IressInline gap\="xs"\>
1183
- <IressPlaceholder
1184
- style\={{
1185
- minHeight: '50px'
1186
- }}
1187
- width\="50"
1188
- />
1189
- <IressPlaceholder
1190
- style\={{
1191
- minHeight: '50px'
1192
- }}
1193
- width\="50"
1194
- />
1195
- <IressPlaceholder
1196
- style\={{
1197
- minHeight: '50px'
1198
- }}
1199
- width\="50"
1200
- />
1201
- <IressPlaceholder
1202
- style\={{
1203
- minHeight: '50px'
1204
- }}
1205
- width\="50"
1206
- />
1207
- <IressPlaceholder
1208
- style\={{
1209
- minHeight: '50px'
1210
- }}
1211
- width\="50"
1212
- />
1213
- </IressInline\>
1214
- </IressText\>
1215
- <IressText\>
1216
- <h2\>
1217
- sm </h2\>
1218
- <IressInline gap\="sm"\>
1219
- <IressPlaceholder
1220
- style\={{
1221
- minHeight: '50px'
1222
- }}
1223
- width\="50"
1224
- />
1225
- <IressPlaceholder
1226
- style\={{
1227
- minHeight: '50px'
1228
- }}
1229
- width\="50"
1230
- />
1231
- <IressPlaceholder
1232
- style\={{
1233
- minHeight: '50px'
1234
- }}
1235
- width\="50"
1236
- />
1237
- <IressPlaceholder
1238
- style\={{
1239
- minHeight: '50px'
1240
- }}
1241
- width\="50"
1242
- />
1243
- <IressPlaceholder
1244
- style\={{
1245
- minHeight: '50px'
1246
- }}
1247
- width\="50"
1248
- />
1249
- </IressInline\>
1250
- </IressText\>
1251
- <IressText\>
1252
- <h2\>
1253
- md </h2\>
1254
- <IressInline gap\="md"\>
1255
- <IressPlaceholder
1256
- style\={{
1257
- minHeight: '50px'
1258
- }}
1259
- width\="50"
1260
- />
1261
- <IressPlaceholder
1262
- style\={{
1263
- minHeight: '50px'
1264
- }}
1265
- width\="50"
1266
- />
1267
- <IressPlaceholder
1268
- style\={{
1269
- minHeight: '50px'
1270
- }}
1271
- width\="50"
1272
- />
1273
- <IressPlaceholder
1274
- style\={{
1275
- minHeight: '50px'
1276
- }}
1277
- width\="50"
1278
- />
1279
- <IressPlaceholder
1280
- style\={{
1281
- minHeight: '50px'
1282
- }}
1283
- width\="50"
1284
- />
1285
- </IressInline\>
1286
- </IressText\>
1287
- <IressText\>
1288
- <h2\>
1289
- lg </h2\>
1290
- <IressInline gap\="lg"\>
1291
- <IressPlaceholder
1292
- style\={{
1293
- minHeight: '50px'
1294
- }}
1295
- width\="50"
1296
- />
1297
- <IressPlaceholder
1298
- style\={{
1299
- minHeight: '50px'
1300
- }}
1301
- width\="50"
1302
- />
1303
- <IressPlaceholder
1304
- style\={{
1305
- minHeight: '50px'
1306
- }}
1307
- width\="50"
1308
- />
1309
- <IressPlaceholder
1310
- style\={{
1311
- minHeight: '50px'
1312
- }}
1313
- width\="50"
1314
- />
1315
- <IressPlaceholder
1316
- style\={{
1317
- minHeight: '50px'
1318
- }}
1319
- width\="50"
1320
- />
1321
- </IressInline\>
1322
- </IressText\>
1323
- <IressText\>
1324
- <h2\>
1325
- xl </h2\>
1326
- <IressInline gap\="xl"\>
1327
- <IressPlaceholder
1328
- style\={{
1329
- minHeight: '50px'
1330
- }}
1331
- width\="50"
1332
- />
1333
- <IressPlaceholder
1334
- style\={{
1335
- minHeight: '50px'
1336
- }}
1337
- width\="50"
1338
- />
1339
- <IressPlaceholder
1340
- style\={{
1341
- minHeight: '50px'
1342
- }}
1343
- width\="50"
1344
- />
1345
- <IressPlaceholder
1346
- style\={{
1347
- minHeight: '50px'
1348
- }}
1349
- width\="50"
1350
- />
1351
- <IressPlaceholder
1352
- style\={{
1353
- minHeight: '50px'
1354
- }}
1355
- width\="50"
1356
- />
1357
- </IressInline\>
1358
- </IressText\>
1359
- <IressText\>
1360
- <h2\>
1361
- field.footer </h2\>
1362
- <IressInline gap\="field.footer"\>
1363
- <IressPlaceholder
1364
- style\={{
1365
- minHeight: '50px'
1366
- }}
1367
- width\="50"
1368
- />
1369
- <IressPlaceholder
1370
- style\={{
1371
- minHeight: '50px'
1372
- }}
1373
- width\="50"
1374
- />
1375
- <IressPlaceholder
1376
- style\={{
1377
- minHeight: '50px'
1378
- }}
1379
- width\="50"
1380
- />
1381
- <IressPlaceholder
1382
- style\={{
1383
- minHeight: '50px'
1384
- }}
1385
- width\="50"
1386
- />
1387
- <IressPlaceholder
1388
- style\={{
1389
- minHeight: '50px'
1390
- }}
1391
- width\="50"
1392
- />
1393
- </IressInline\>
1394
- </IressText\>
1395
- <IressText\>
1396
- <h2\>
1397
- slider.tick </h2\>
1398
- <IressInline gap\="slider.tick"\>
1399
- <IressPlaceholder
1400
- style\={{
1401
- minHeight: '50px'
1402
- }}
1403
- width\="50"
1404
- />
1405
- <IressPlaceholder
1406
- style\={{
1407
- minHeight: '50px'
1408
- }}
1409
- width\="50"
1410
- />
1411
- <IressPlaceholder
1412
- style\={{
1413
- minHeight: '50px'
1414
- }}
1415
- width\="50"
1416
- />
1417
- <IressPlaceholder
1418
- style\={{
1419
- minHeight: '50px'
1420
- }}
1421
- width\="50"
1422
- />
1423
- <IressPlaceholder
1424
- style\={{
1425
- minHeight: '50px'
1426
- }}
1427
- width\="50"
1428
- />
1429
- </IressInline\>
1430
- </IressText\>
1431
- </IressStack\>
1432
-
1433
- Copy
1434
-
1435
- ### [](#responsive-gap)Responsive gap
1436
-
1437
- The `gap` prop can take an object that takes five key/value pairs that correlate with the IDS breakpoints.
1438
-
1439
- Current breakpoint: **xl** breakpoint (1200px - 1499px).
1440
-
1441
- `gap={{"xs":"spacing.100","sm":"spacing.200","md":"spacing.400"}}`
1442
-
1443
- Hide code
1444
-
1445
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
1446
-
1447
- <IressStack gap\="spacing.400"\>
1448
- <IressPanel\>
1449
- <p\>
1450
- Current breakpoint:{' '}
1451
- <CurrentBreakpoint />
1452
- . </p\>
1453
- <p\>
1454
- <code\>
1455
- {\`gap={{"xs":"spacing.100","sm":"spacing.200","md":"spacing.400"}}\`}
1456
- </code\>
1457
- </p\>
1458
- </IressPanel\>
1459
- <IressInline
1460
- gap\={{
1461
- md: 'spacing.400',
1462
- sm: 'spacing.200',
1463
- xs: 'spacing.100'
1464
- }}
1465
- \>
1466
- <IressPlaceholder
1467
- style\={{
1468
- minHeight: '50px'
1469
- }}
1470
- width\="50"
1471
- />
1472
- <IressPlaceholder
1473
- style\={{
1474
- minHeight: '50px'
1475
- }}
1476
- width\="50"
1477
- />
1478
- <IressPlaceholder
1479
- style\={{
1480
- minHeight: '50px'
1481
- }}
1482
- width\="50"
1483
- />
1484
- <IressPlaceholder
1485
- style\={{
1486
- minHeight: '50px'
1487
- }}
1488
- width\="50"
1489
- />
1490
- <IressPlaceholder
1491
- style\={{
1492
- minHeight: '50px'
1493
- }}
1494
- width\="50"
1495
- />
1496
- </IressInline\>
1497
- </IressStack\>
1498
-
1499
- Copy
1500
-
1501
- ### [](#horizontal-align)Horizontal align
1502
-
1503
- Horizontal alignment of the children is controlled by the `horizontalAlign` prop. It defaults to left and can be set to the following:
1504
-
1505
- * `around` - space is distributed so each direct child has the same space on the left and on the right. This means that the gap between children is twice as large as the gap between the first / last items and the edges of the container, because the gap between children is comprised one child's spacing right plus the next child's spacing left.
1506
- * `between` - space is distributed evenly between direct children, but the first and last children sit tight to the edges of the container.
1507
- * `center` - children are aligned center, similar to `text-align: center`.
1508
- * `evenly` - space is distributed evenly between direct children.
1509
- * `left` - children are aligned left, similar to `text-align: left`.
1510
- * `right` - children are aligned right, similar to `text-align: right`.
1511
-
1512
- around
1513
- ------
1514
-
1515
- between
1516
- -------
1517
-
1518
- center
1519
- ------
1520
-
1521
- evenly
1522
- ------
1523
-
1524
- left
1525
- ----
1526
-
1527
- right
1528
- -----
1529
-
1530
- Hide code
1531
-
1532
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
1533
-
1534
- <IressContainer\>
1535
- <IressStack gap\="spacing.1200"\>
1536
- <IressText\>
1537
- <h2\>
1538
- around </h2\>
1539
- <IressInline
1540
- gap\="spacing.200"
1541
- horizontalAlign\="around"
1542
- \>
1543
- <IressPlaceholder
1544
- style\={{
1545
- minHeight: '50px'
1546
- }}
1547
- width\="50"
1548
- />
1549
- <IressPlaceholder
1550
- style\={{
1551
- minHeight: '50px'
1552
- }}
1553
- width\="50"
1554
- />
1555
- <IressPlaceholder
1556
- style\={{
1557
- minHeight: '50px'
1558
- }}
1559
- width\="50"
1560
- />
1561
- <IressPlaceholder
1562
- style\={{
1563
- minHeight: '50px'
1564
- }}
1565
- width\="50"
1566
- />
1567
- <IressPlaceholder
1568
- style\={{
1569
- minHeight: '50px'
1570
- }}
1571
- width\="50"
1572
- />
1573
- </IressInline\>
1574
- </IressText\>
1575
- <IressText\>
1576
- <h2\>
1577
- between </h2\>
1578
- <IressInline
1579
- gap\="spacing.200"
1580
- horizontalAlign\="between"
1581
- \>
1582
- <IressPlaceholder
1583
- style\={{
1584
- minHeight: '50px'
1585
- }}
1586
- width\="50"
1587
- />
1588
- <IressPlaceholder
1589
- style\={{
1590
- minHeight: '50px'
1591
- }}
1592
- width\="50"
1593
- />
1594
- <IressPlaceholder
1595
- style\={{
1596
- minHeight: '50px'
1597
- }}
1598
- width\="50"
1599
- />
1600
- <IressPlaceholder
1601
- style\={{
1602
- minHeight: '50px'
1603
- }}
1604
- width\="50"
1605
- />
1606
- <IressPlaceholder
1607
- style\={{
1608
- minHeight: '50px'
1609
- }}
1610
- width\="50"
1611
- />
1612
- </IressInline\>
1613
- </IressText\>
1614
- <IressText\>
1615
- <h2\>
1616
- center </h2\>
1617
- <IressInline
1618
- gap\="spacing.200"
1619
- horizontalAlign\="center"
1620
- \>
1621
- <IressPlaceholder
1622
- style\={{
1623
- minHeight: '50px'
1624
- }}
1625
- width\="50"
1626
- />
1627
- <IressPlaceholder
1628
- style\={{
1629
- minHeight: '50px'
1630
- }}
1631
- width\="50"
1632
- />
1633
- <IressPlaceholder
1634
- style\={{
1635
- minHeight: '50px'
1636
- }}
1637
- width\="50"
1638
- />
1639
- <IressPlaceholder
1640
- style\={{
1641
- minHeight: '50px'
1642
- }}
1643
- width\="50"
1644
- />
1645
- <IressPlaceholder
1646
- style\={{
1647
- minHeight: '50px'
1648
- }}
1649
- width\="50"
1650
- />
1651
- </IressInline\>
1652
- </IressText\>
1653
- <IressText\>
1654
- <h2\>
1655
- evenly </h2\>
1656
- <IressInline
1657
- gap\="spacing.200"
1658
- horizontalAlign\="evenly"
1659
- \>
1660
- <IressPlaceholder
1661
- style\={{
1662
- minHeight: '50px'
1663
- }}
1664
- width\="50"
1665
- />
1666
- <IressPlaceholder
1667
- style\={{
1668
- minHeight: '50px'
1669
- }}
1670
- width\="50"
1671
- />
1672
- <IressPlaceholder
1673
- style\={{
1674
- minHeight: '50px'
1675
- }}
1676
- width\="50"
1677
- />
1678
- <IressPlaceholder
1679
- style\={{
1680
- minHeight: '50px'
1681
- }}
1682
- width\="50"
1683
- />
1684
- <IressPlaceholder
1685
- style\={{
1686
- minHeight: '50px'
1687
- }}
1688
- width\="50"
1689
- />
1690
- </IressInline\>
1691
- </IressText\>
1692
- <IressText\>
1693
- <h2\>
1694
- left </h2\>
1695
- <IressInline
1696
- gap\="spacing.200"
1697
- horizontalAlign\="left"
1698
- \>
1699
- <IressPlaceholder
1700
- style\={{
1701
- minHeight: '50px'
1702
- }}
1703
- width\="50"
1704
- />
1705
- <IressPlaceholder
1706
- style\={{
1707
- minHeight: '50px'
1708
- }}
1709
- width\="50"
1710
- />
1711
- <IressPlaceholder
1712
- style\={{
1713
- minHeight: '50px'
1714
- }}
1715
- width\="50"
1716
- />
1717
- <IressPlaceholder
1718
- style\={{
1719
- minHeight: '50px'
1720
- }}
1721
- width\="50"
1722
- />
1723
- <IressPlaceholder
1724
- style\={{
1725
- minHeight: '50px'
1726
- }}
1727
- width\="50"
1728
- />
1729
- </IressInline\>
1730
- </IressText\>
1731
- <IressText\>
1732
- <h2\>
1733
- right </h2\>
1734
- <IressInline
1735
- gap\="spacing.200"
1736
- horizontalAlign\="right"
1737
- \>
1738
- <IressPlaceholder
1739
- style\={{
1740
- minHeight: '50px'
1741
- }}
1742
- width\="50"
1743
- />
1744
- <IressPlaceholder
1745
- style\={{
1746
- minHeight: '50px'
1747
- }}
1748
- width\="50"
1749
- />
1750
- <IressPlaceholder
1751
- style\={{
1752
- minHeight: '50px'
1753
- }}
1754
- width\="50"
1755
- />
1756
- <IressPlaceholder
1757
- style\={{
1758
- minHeight: '50px'
1759
- }}
1760
- width\="50"
1761
- />
1762
- <IressPlaceholder
1763
- style\={{
1764
- minHeight: '50px'
1765
- }}
1766
- width\="50"
1767
- />
1768
- </IressInline\>
1769
- </IressText\>
1770
- </IressStack\>
1771
- </IressContainer\>
1772
-
1773
- Copy
1774
-
1775
- ### [](#vertical-align)Vertical align
1776
-
1777
- Vertical alignment of the children is controlled by the `verticalAlign` prop. It defaults to top and can be set to the following:
1778
-
1779
- * `bottom` - children are aligned to the bottom of the container.
1780
- * `middle` - children are aligned to the middle of the container.
1781
- * `stretch` - each direct child stretches to the full height of the inline container.
1782
- * `top` - children are aligned to the top of the container.
1783
-
1784
- top
1785
- ---
1786
-
1787
- middle
1788
- ------
1789
-
1790
- bottom
1791
- ------
1792
-
1793
- stretch
1794
- -------
1795
-
1796
- Hide code
1797
-
1798
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
1799
-
1800
- <IressContainer\>
1801
- <IressStack gap\="spacing.1200"\>
1802
- <IressText textAlign\="center"\>
1803
- <h2\>
1804
- top </h2\>
1805
- <IressInline
1806
- gap\="spacing.200"
1807
- horizontalAlign\="center"
1808
- verticalAlign\="top"
1809
- \>
1810
- <IressPlaceholder
1811
- style\={{
1812
- minHeight: '30px'
1813
- }}
1814
- width\="50"
1815
- />
1816
- <IressPlaceholder
1817
- style\={{
1818
- minHeight: '50px'
1819
- }}
1820
- width\="50"
1821
- />
1822
- <IressPlaceholder
1823
- style\={{
1824
- minHeight: '80px'
1825
- }}
1826
- width\="50"
1827
- />
1828
- <IressPlaceholder
1829
- style\={{
1830
- minHeight: '60px'
1831
- }}
1832
- width\="50"
1833
- />
1834
- <IressPlaceholder
1835
- style\={{
1836
- minHeight: '10px'
1837
- }}
1838
- width\="50"
1839
- />
1840
- </IressInline\>
1841
- </IressText\>
1842
- <IressText textAlign\="center"\>
1843
- <h2\>
1844
- middle </h2\>
1845
- <IressInline
1846
- gap\="spacing.200"
1847
- horizontalAlign\="center"
1848
- verticalAlign\="middle"
1849
- \>
1850
- <IressPlaceholder
1851
- style\={{
1852
- minHeight: '30px'
1853
- }}
1854
- width\="50"
1855
- />
1856
- <IressPlaceholder
1857
- style\={{
1858
- minHeight: '50px'
1859
- }}
1860
- width\="50"
1861
- />
1862
- <IressPlaceholder
1863
- style\={{
1864
- minHeight: '80px'
1865
- }}
1866
- width\="50"
1867
- />
1868
- <IressPlaceholder
1869
- style\={{
1870
- minHeight: '60px'
1871
- }}
1872
- width\="50"
1873
- />
1874
- <IressPlaceholder
1875
- style\={{
1876
- minHeight: '10px'
1877
- }}
1878
- width\="50"
1879
- />
1880
- </IressInline\>
1881
- </IressText\>
1882
- <IressText textAlign\="center"\>
1883
- <h2\>
1884
- bottom </h2\>
1885
- <IressInline
1886
- gap\="spacing.200"
1887
- horizontalAlign\="center"
1888
- verticalAlign\="bottom"
1889
- \>
1890
- <IressPlaceholder
1891
- style\={{
1892
- minHeight: '30px'
1893
- }}
1894
- width\="50"
1895
- />
1896
- <IressPlaceholder
1897
- style\={{
1898
- minHeight: '50px'
1899
- }}
1900
- width\="50"
1901
- />
1902
- <IressPlaceholder
1903
- style\={{
1904
- minHeight: '80px'
1905
- }}
1906
- width\="50"
1907
- />
1908
- <IressPlaceholder
1909
- style\={{
1910
- minHeight: '60px'
1911
- }}
1912
- width\="50"
1913
- />
1914
- <IressPlaceholder
1915
- style\={{
1916
- minHeight: '10px'
1917
- }}
1918
- width\="50"
1919
- />
1920
- </IressInline\>
1921
- </IressText\>
1922
- <IressText textAlign\="center"\>
1923
- <h2\>
1924
- stretch </h2\>
1925
- <IressInline
1926
- gap\="spacing.200"
1927
- horizontalAlign\="center"
1928
- verticalAlign\="stretch"
1929
- \>
1930
- <IressPlaceholder
1931
- style\={{
1932
- minHeight: '30px'
1933
- }}
1934
- width\="50"
1935
- />
1936
- <IressPlaceholder
1937
- style\={{
1938
- minHeight: '50px'
1939
- }}
1940
- width\="50"
1941
- />
1942
- <IressPlaceholder
1943
- style\={{
1944
- minHeight: '80px'
1945
- }}
1946
- width\="50"
1947
- />
1948
- <IressPlaceholder
1949
- style\={{
1950
- minHeight: '60px'
1951
- }}
1952
- width\="50"
1953
- />
1954
- <IressPlaceholder
1955
- style\={{
1956
- minHeight: '10px'
1957
- }}
1958
- width\="50"
1959
- />
1960
- </IressInline\>
1961
- </IressText\>
1962
- </IressStack\>
1963
- </IressContainer\>
1964
-
1965
- Copy
1966
-
1967
- ### [](#no-wrap)No wrap
1968
-
1969
- The `IressInline` component automatically wraps children. There may be some scenarios where you do not require children to be wrapped. For this you can use the `noWrap` prop.
1970
-
1971
- His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor.
1972
-
1973
- Hide code
1974
-
1975
- \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
1976
-
1977
- <IressInline
1978
- gap\="spacing.1200"
1979
- noWrap
1980
- \>
1981
- <IressPlaceholder
1982
- height\="100px"
1983
- style\={{
1984
- minWidth: '100px'
1985
- }}
1986
- width\="100px"
1987
- />
1988
- <IressText\>
1989
- His head is gone, it is like it is been erased... Erased from existence. That was the day I invented time travel. I remember it vividly. I was standing on the edge of my toilet hanging a clock, the porces was wet, I slipped, hit my head on the edge of the sink. And when I came to I had a revelation, a picture, a picture in my head, a picture of this. This is what makes time travel possible. The flux capacitor. </IressText\>
1990
- </IressInline\>
1991
-
1992
- Copy
1993
-
1994
- On this page
1995
-
1996
- * [Overview](#overview)
1997
- * [Props](#props)
1998
- * [Examples](#examples)
1999
- * [Gap](#gap)
2000
- * [Responsive gap](#responsive-gap)
2001
- * [Horizontal align](#horizontal-align)
2002
- * [Vertical align](#vertical-align)
2003
- * [No wrap](#no-wrap)