@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.
- package/dist/searchHandlers.test.js +8 -2
- package/dist/toolHandler.test.js +9 -9
- package/dist/utils.test.js +6 -2
- package/package.json +32 -30
- package/generated/docs/components-alert-docs.md +0 -702
- package/generated/docs/components-autocomplete-docs.md +0 -1433
- package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
- package/generated/docs/components-badge-docs.md +0 -531
- package/generated/docs/components-button-docs.md +0 -1442
- package/generated/docs/components-buttongroup-docs.md +0 -748
- package/generated/docs/components-card-docs.md +0 -944
- package/generated/docs/components-checkbox-docs.md +0 -694
- package/generated/docs/components-checkboxgroup-docs.md +0 -1087
- package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
- package/generated/docs/components-col-docs.md +0 -881
- package/generated/docs/components-container-docs.md +0 -123
- package/generated/docs/components-divider-docs.md +0 -576
- package/generated/docs/components-expander-docs.md +0 -594
- package/generated/docs/components-field-docs.md +0 -2007
- package/generated/docs/components-filter-docs.md +0 -1322
- package/generated/docs/components-hide-docs.md +0 -702
- package/generated/docs/components-icon-docs.md +0 -816
- package/generated/docs/components-image-docs.md +0 -493
- package/generated/docs/components-inline-docs.md +0 -2003
- package/generated/docs/components-input-docs.md +0 -867
- package/generated/docs/components-input-recipes-docs.md +0 -140
- package/generated/docs/components-inputcurrency-docs.md +0 -689
- package/generated/docs/components-inputcurrency-recipes-docs.md +0 -115
- package/generated/docs/components-introduction-docs.md +0 -450
- package/generated/docs/components-label-docs.md +0 -562
- package/generated/docs/components-link-docs.md +0 -586
- package/generated/docs/components-menu-docs.md +0 -1146
- package/generated/docs/components-menu-menuitem-docs.md +0 -739
- package/generated/docs/components-modal-docs.md +0 -1346
- package/generated/docs/components-panel-docs.md +0 -600
- package/generated/docs/components-placeholder-docs.md +0 -446
- package/generated/docs/components-popover-docs.md +0 -1529
- package/generated/docs/components-popover-recipes-docs.md +0 -211
- package/generated/docs/components-progress-docs.md +0 -568
- package/generated/docs/components-provider-docs.md +0 -160
- package/generated/docs/components-radio-docs.md +0 -563
- package/generated/docs/components-radiogroup-docs.md +0 -1153
- package/generated/docs/components-readonly-docs.md +0 -535
- package/generated/docs/components-richselect-docs.md +0 -5836
- package/generated/docs/components-row-docs.md +0 -2354
- package/generated/docs/components-select-docs.md +0 -940
- package/generated/docs/components-skeleton-docs.md +0 -597
- package/generated/docs/components-skeleton-recipes-docs.md +0 -76
- package/generated/docs/components-skiplink-docs.md +0 -587
- package/generated/docs/components-slideout-docs.md +0 -1036
- package/generated/docs/components-slider-docs.md +0 -828
- package/generated/docs/components-spinner-docs.md +0 -450
- package/generated/docs/components-stack-docs.md +0 -923
- package/generated/docs/components-table-ag-grid-docs.md +0 -1444
- package/generated/docs/components-table-docs.md +0 -2327
- package/generated/docs/components-tabset-docs.md +0 -768
- package/generated/docs/components-tabset-tab-docs.md +0 -550
- package/generated/docs/components-tag-docs.md +0 -548
- package/generated/docs/components-text-docs.md +0 -585
- package/generated/docs/components-toaster-docs.md +0 -755
- package/generated/docs/components-toggle-docs.md +0 -614
- package/generated/docs/components-tooltip-docs.md +0 -747
- package/generated/docs/components-validationmessage-docs.md +0 -1161
- package/generated/docs/contact-us-docs.md +0 -27
- package/generated/docs/extensions-editor-docs.md +0 -1181
- package/generated/docs/extensions-editor-recipes-docs.md +0 -89
- package/generated/docs/foundations-accessibility-docs.md +0 -40
- package/generated/docs/foundations-consistency-docs.md +0 -52
- package/generated/docs/foundations-content-docs.md +0 -23
- package/generated/docs/foundations-grid-docs.md +0 -74
- package/generated/docs/foundations-introduction-docs.md +0 -19
- package/generated/docs/foundations-principles-docs.md +0 -70
- package/generated/docs/foundations-responsive-breakpoints-docs.md +0 -193
- package/generated/docs/foundations-tokens-colour-docs.md +0 -564
- package/generated/docs/foundations-tokens-elevation-docs.md +0 -155
- package/generated/docs/foundations-tokens-introduction-docs.md +0 -190
- package/generated/docs/foundations-tokens-radius-docs.md +0 -71
- package/generated/docs/foundations-tokens-spacing-docs.md +0 -89
- package/generated/docs/foundations-tokens-typography-docs.md +0 -322
- package/generated/docs/foundations-user-experience-docs.md +0 -63
- package/generated/docs/foundations-visual-design-docs.md +0 -46
- package/generated/docs/foundations-z-index-stacking-docs.md +0 -31
- package/generated/docs/frequently-asked-questions-docs.md +0 -53
- package/generated/docs/get-started-develop-docs.md +0 -209
- package/generated/docs/get-started-using-storybook-docs.md +0 -68
- package/generated/docs/guidelines.md +0 -2054
- package/generated/docs/introduction-docs.md +0 -87
- package/generated/docs/news-version-6-docs.md +0 -93
- package/generated/docs/patterns-form-docs.md +0 -3902
- package/generated/docs/patterns-form-recipes-docs.md +0 -1370
- package/generated/docs/patterns-introduction-docs.md +0 -24
- package/generated/docs/patterns-loading-docs.md +0 -4043
- package/generated/docs/resources-code-katas-docs.md +0 -29
- package/generated/docs/resources-introduction-docs.md +0 -38
- package/generated/docs/resources-mcp-server-docs.md +0 -27
- package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
- package/generated/docs/styling-props-colour-docs.md +0 -172
- package/generated/docs/styling-props-elevation-docs.md +0 -88
- package/generated/docs/styling-props-radius-docs.md +0 -86
- package/generated/docs/styling-props-reference-docs.md +0 -160
- package/generated/docs/styling-props-screen-readers-docs.md +0 -71
- package/generated/docs/styling-props-sizing-docs.md +0 -627
- package/generated/docs/styling-props-spacing-docs.md +0 -2282
- package/generated/docs/styling-props-typography-docs.md +0 -121
- package/generated/docs/themes-available-themes-docs.md +0 -66
- package/generated/docs/themes-introduction-docs.md +0 -121
- package/generated/docs/versions-docs.md +0 -17
- /package/{LICENSE.txt → LICENSE} +0 -0
|
@@ -1,190 +0,0 @@
|
|
|
1
|
-
[](#tokens)Tokens
|
|
2
|
-
=================
|
|
3
|
-
|
|
4
|
-
Design tokens are an integral part of the design system. They help us create consistency across components by sharing common design decisions and simplify our theming ecosystem.
|
|
5
|
-
|
|
6
|
-
[](#what-are-tokens)What are tokens?
|
|
7
|
-
------------------------------------
|
|
8
|
-
|
|
9
|
-
Tokens are a set of variables that define the design properties of a component. They are used to define the visual properties of a component, such as colours, typography, spacing, and more.
|
|
10
|
-
|
|
11
|
-
[](#token-list)Token list
|
|
12
|
-
-------------------------
|
|
13
|
-
|
|
14
|
-
The table below shows all the new and old tokens in the design system. Use the filters to narrow down the list of tokens.
|
|
15
|
-
|
|
16
|
-
Columns: 4 selected
|
|
17
|
-
|
|
18
|
-
labelaliasdescriptionreadonly
|
|
19
|
-
|
|
20
|
-
* * *
|
|
21
|
-
|
|
22
|
-
typedefaultValuedeprecated
|
|
23
|
-
|
|
24
|
-
None selected
|
|
25
|
-
|
|
26
|
-
Show deprecated tokens
|
|
27
|
-
|
|
28
|
-
Tokens (88)
|
|
29
|
-
| Name
|
|
30
|
-
| Alias
|
|
31
|
-
|
|
32
|
-
| Description
|
|
33
|
-
|
|
34
|
-
| Themeable
|
|
35
|
-
|
|
36
|
-
|
|
|
37
|
-
| --- | --- | --- | --- |
|
|
38
|
-
| colour.primary.fill | | Used for primary buttons and the active state of form controls such as checkboxes and radio buttons. Also used for the border of tags when they have a custom button. | |
|
|
39
|
-
| colour.primary.fillHover | | Used for the hover state of primary buttons as well as hovering over active form controls. | |
|
|
40
|
-
| colour.primary.onFill | | Used as the foreground colour on primary buttons and active form controls. | |
|
|
41
|
-
| colour.primary.surface | | Used as the background colour for secondary buttons and the focused state of menu and tab items. Also used as the background colour of active buttons. | |
|
|
42
|
-
| colour.primary.surfaceHover | | Used for the hover state of secondary buttons, form controls and hovering over focused menu and tab items. Also used when hovering over table rows. | |
|
|
43
|
-
| colour.primary.text | | Used for text on primary buttons, active form controls and focused tab and menu items. Also used for the link text colour and tertiary buttons. | |
|
|
44
|
-
| colour.neutral.10 | | Used as the default background colour for most components. For tooltips, it is used as the foreground colour for the tooltip content. | |
|
|
45
|
-
| colour.neutral.20 | | Used as the alternating background colour for components such as tables. Used as the background colour behind panels and cards for highly interactive screens. | |
|
|
46
|
-
| colour.neutral.30 | | Used as the border colour for dividers, and the default divider colour for components with in-built headers and footers such as cards. | |
|
|
47
|
-
| colour.neutral.40 | | Used for borders in subtle interactive components, such as checkboxes and radios with hidden controls and the progress bar. | |
|
|
48
|
-
| colour.neutral.50 | | Used as the background colour for interactive components such as the slider. | |
|
|
49
|
-
| colour.neutral.60 | | Used for placeholder text in form controls and disabled states. | |
|
|
50
|
-
| colour.neutral.70 | | Used for muted text such as hints and descriptions to allow for content hierarchy. | |
|
|
51
|
-
| colour.neutral.80 | | Used as the default text colour for most components. For tooltips, it is used as the background colour. | |
|
|
52
|
-
| colour.accent.brand | | The brand accent is useful for grabbing attention and to support your primary/brand colour. It should be used sparingly to draw attention to key elements. | |
|
|
53
|
-
| colour.system.success.fill | | Used for the background colour of primary success buttons, as well as the border of alerts and badges. It is also used for the foreground colour of icons inside toasts and alerts. | |
|
|
54
|
-
| colour.system.success.fillHover | | Used for the hover state of primary success buttons. | |
|
|
55
|
-
| colour.system.success.onFill | | Used for the foreground colour of primary success buttons and badges. | |
|
|
56
|
-
| colour.system.success.surface | | Used for the background colour of success alerts and toasts, and the background of secondary success buttons. | |
|
|
57
|
-
| colour.system.success.surfaceHover | | Used for the hover state of secondary success buttons. | |
|
|
58
|
-
| colour.system.success.text | | Used for the text colour of success alerts and toasts, and success tertiary buttons. | |
|
|
59
|
-
| colour.system.danger.fill | | Used for the background colour of primary danger buttons, as well as the border of alerts and badges. It is also used for the foreground colour of icons inside toasts and alerts. | |
|
|
60
|
-
| colour.system.danger.fillHover | | Used for the hover state of primary danger buttons. | |
|
|
61
|
-
| colour.system.danger.onFill | | Used for the foreground colour of primary danger buttons and badges. | |
|
|
62
|
-
| colour.system.danger.surface | | Used for the background colour of danger alerts and toasts, and the background of secondary danger buttons. | |
|
|
63
|
-
| colour.system.danger.surfaceHover | | Used for the hover state of secondary danger buttons. | |
|
|
64
|
-
| colour.system.danger.text | | Used for the text colour of danger alerts and toasts, and danger tertiary buttons. | |
|
|
65
|
-
| colour.system.warning.fill | | Used for the border of warning alerts and the background of warning badges. | |
|
|
66
|
-
| colour.system.warning.onFill | | Used for the foreground colour of warning badges. | |
|
|
67
|
-
| colour.system.warning.surface | | Used for the background colour of warning alerts. | |
|
|
68
|
-
| colour.system.warning.text | | Used for the text colour of warning alerts. | |
|
|
69
|
-
| colour.system.info.fill | | Used for the border of info alerts and toasts and the background of info badges. | |
|
|
70
|
-
| colour.system.info.onFill | | Used for the foreground colour of info badges. | |
|
|
71
|
-
| colour.system.info.surface | | Used for the background colour of info alerts and toasts. | |
|
|
72
|
-
| colour.system.info.text | | Used for the text colour of info alerts and toasts. | |
|
|
73
|
-
| colour.system.backdrop.fill | | Used for the background colour of the backdrop. | |
|
|
74
|
-
| elevation.raised.shadow | | Shadow for raised elevations | |
|
|
75
|
-
| elevation.raised.border | | Border for raised elevations | |
|
|
76
|
-
| elevation.floating.shadow | | Shadow for floating elevations | |
|
|
77
|
-
| elevation.floating.border | | Border for floating elevations | |
|
|
78
|
-
| elevation.overflow.shadow | | Shadow for overflow elevations | |
|
|
79
|
-
| elevation.overflow.border | | Border for overflow elevations | |
|
|
80
|
-
| elevation.focus.shadow | | Shadow for focus elevations | |
|
|
81
|
-
| elevation.focusCompact.shadow | | Shadow for focus compact elevations | |
|
|
82
|
-
| elevation.focusCompact.borderColor | | Border color for focus compact elevations | |
|
|
83
|
-
| radius.100 | | The base unit for radius. The fallback for all other values will be calculated from this value. | |
|
|
84
|
-
| radius.000 | none | No radius | |
|
|
85
|
-
| radius.025 | | 25% (0.25x) radius | |
|
|
86
|
-
| radius.050 | | 50% (0.5x) radius | |
|
|
87
|
-
| radius.075 | | 75% (0.75x) radius | |
|
|
88
|
-
| radius.system.badge | | Applies to badges and tags (that have not been designated to be a circle). | |
|
|
89
|
-
| radius.system.button | | Applies to buttons and other interactive elements such as the hover state of links. | |
|
|
90
|
-
| radius.system.form | | Applies to form inputs and alerts. | |
|
|
91
|
-
| radius.system.layout | | Applies to panels, modals and slideouts. | |
|
|
92
|
-
| spacing.100 | xs | The base unit for spacing. The fallback for all other values will be calculated from this value. | |
|
|
93
|
-
| spacing.150 | | 150% (1.5x) spacing | |
|
|
94
|
-
| spacing.200 | sm | 200% (2x) spacing | |
|
|
95
|
-
| spacing.250 | | 250% (2.5x) spacing | |
|
|
96
|
-
| spacing.300 | | 300% (3x) spacing | |
|
|
97
|
-
| spacing.350 | | 350% (3.5x) spacing | |
|
|
98
|
-
| spacing.400 | md | 400% (4x) spacing | |
|
|
99
|
-
| spacing.500 | | 500% (5x) spacing | |
|
|
100
|
-
| spacing.600 | lg | 600% (6x) spacing | |
|
|
101
|
-
| spacing.700 | | 700% (7x) spacing | |
|
|
102
|
-
| spacing.800 | | 800% (8x) spacing | |
|
|
103
|
-
| spacing.900 | | 900% (9x) spacing | |
|
|
104
|
-
| spacing.1000 | | 1000% (10x) spacing | |
|
|
105
|
-
| spacing.1200 | xl | 1200% (12x) spacing | |
|
|
106
|
-
| spacing.000 | none | No spacing | |
|
|
107
|
-
| spacing.050 | | 50% (0.5x) spacing | |
|
|
108
|
-
| typography.base.size | | This is the base font size, and is used to calculate the font sizes of each token. | |
|
|
109
|
-
| typography.base.headingFont | | This is the base font family for headings, used for heading tokens. | |
|
|
110
|
-
| typography.base.bodyFont | | This is the base font family for body, used for body tokens. | |
|
|
111
|
-
| typography.heading.1 | | Use for the main page title to establish a clear hierarchy. There is only one H1 per screen, emphasising the primary purpose or context of the page. | |
|
|
112
|
-
| 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. | |
|
|
113
|
-
| 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. | |
|
|
114
|
-
| 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. | |
|
|
115
|
-
| 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. | |
|
|
116
|
-
| typography.body.sm.regular | | The default small text, most commonly used to display text in small components and compact tables and lists. | |
|
|
117
|
-
| typography.body.sm.strong | | Strong text is used to highlight important information in a paragraph of text. | |
|
|
118
|
-
| typography.body.sm.em | | Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes. | |
|
|
119
|
-
| typography.body.md.regular | | The default medium text, most commonly used to display text across all products. | |
|
|
120
|
-
| typography.body.md.strong | | Strong text is used to highlight important information in a paragraph of text. | |
|
|
121
|
-
| typography.body.md.em | | Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes. | |
|
|
122
|
-
| typography.body.lg.regular | | The default large text, most commonly used to display large text across all products. | |
|
|
123
|
-
| typography.body.lg.strong | | Strong text is used to highlight important information in a paragraph of text. | |
|
|
124
|
-
| typography.body.lg.em | | Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes. | |
|
|
125
|
-
| typography.code | | Used to display code snippets in the product, such as in the API documentation. | |
|
|
126
|
-
|
|
127
|
-
* * *
|
|
128
|
-
|
|
129
|
-
[](#for-developers)For developers
|
|
130
|
-
---------------------------------
|
|
131
|
-
|
|
132
|
-
If you are using the IDS components, the tokens have already been mapped out to their respective components. You can use the tokens in the component props to change the visual properties of the component.
|
|
133
|
-
|
|
134
|
-
[
|
|
135
|
-
|
|
136
|
-
Learn more about styling props
|
|
137
|
-
|
|
138
|
-
](/?path=/docs/styling-props-reference--docs)
|
|
139
|
-
|
|
140
|
-
\[data-radix-scroll-area-viewport\] {
|
|
141
|
-
scrollbar-width: none;
|
|
142
|
-
-ms-overflow-style: none;
|
|
143
|
-
-webkit-overflow-scrolling: touch;
|
|
144
|
-
}
|
|
145
|
-
\[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
|
|
146
|
-
display: none;
|
|
147
|
-
}
|
|
148
|
-
:where(\[data-radix-scroll-area-viewport\]) {
|
|
149
|
-
display: flex;
|
|
150
|
-
flex-direction: column;
|
|
151
|
-
align-items: stretch;
|
|
152
|
-
}
|
|
153
|
-
:where(\[data-radix-scroll-area-content\]) {
|
|
154
|
-
flex-grow: 1;
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
import { IressText } from '@iress-oss/ids-components';
|
|
158
|
-
<IressText color\="colour.primary.text"\>I am branded text</IressText\>;
|
|
159
|
-
|
|
160
|
-
Copy
|
|
161
|
-
|
|
162
|
-
If you are not using the IDS components, you can use the tokens directly by using the `cssVars` object from `@iress-oss/ids-tokens`.
|
|
163
|
-
|
|
164
|
-
\[data-radix-scroll-area-viewport\] {
|
|
165
|
-
scrollbar-width: none;
|
|
166
|
-
-ms-overflow-style: none;
|
|
167
|
-
-webkit-overflow-scrolling: touch;
|
|
168
|
-
}
|
|
169
|
-
\[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
|
|
170
|
-
display: none;
|
|
171
|
-
}
|
|
172
|
-
:where(\[data-radix-scroll-area-viewport\]) {
|
|
173
|
-
display: flex;
|
|
174
|
-
flex-direction: column;
|
|
175
|
-
align-items: stretch;
|
|
176
|
-
}
|
|
177
|
-
:where(\[data-radix-scroll-area-content\]) {
|
|
178
|
-
flex-grow: 1;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
|
-
import { cssVars } from '@iress-oss/ids-tokens';
|
|
182
|
-
<div style\={{ color: cssVars.colour.primary.text }}\>I am branded text</div\>;
|
|
183
|
-
|
|
184
|
-
Copy
|
|
185
|
-
|
|
186
|
-
On this page
|
|
187
|
-
|
|
188
|
-
* [What are tokens?](#what-are-tokens)
|
|
189
|
-
* [Token list](#token-list)
|
|
190
|
-
* [For developers](#for-developers)
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
[](#radius)Radius
|
|
2
|
-
=================
|
|
3
|
-
|
|
4
|
-
Radius is the curvature of the corners of elements. It is used to soften the appearance of elements and make them more visually appealing.
|
|
5
|
-
|
|
6
|
-
Radius tokens
|
|
7
|
-
| Token Name | Alias | Description | Visual |
|
|
8
|
-
| --- | --- | --- | --- |
|
|
9
|
-
| radius.000 | none | No radius |
|
|
10
|
-
0px
|
|
11
|
-
|
|
12
|
-
|
|
|
13
|
-
| radius.025 | | 25% (0.25x) radius |
|
|
14
|
-
|
|
15
|
-
4px
|
|
16
|
-
|
|
17
|
-
|
|
|
18
|
-
| radius.050 | | 50% (0.5x) radius |
|
|
19
|
-
|
|
20
|
-
8px
|
|
21
|
-
|
|
22
|
-
|
|
|
23
|
-
| radius.075 | | 75% (0.75x) radius |
|
|
24
|
-
|
|
25
|
-
12px
|
|
26
|
-
|
|
27
|
-
|
|
|
28
|
-
| radius.100 | | The base unit for radius. The fallback for all other values will be calculated from this value. |
|
|
29
|
-
|
|
30
|
-
16px
|
|
31
|
-
|
|
32
|
-
|
|
|
33
|
-
|
|
34
|
-
[](#system)System
|
|
35
|
-
-----------------
|
|
36
|
-
|
|
37
|
-
Some components have a default radius to better align to a brand. Although usually they inherit from the base units, for some brands you may need to customise this to further emphasise their identity.
|
|
38
|
-
|
|
39
|
-
### Badge
|
|
40
|
-
|
|
41
|
-
Applies to badges and tags (that have not been designated to be a circle).
|
|
42
|
-
|
|
43
|
-
radius.system.badge
|
|
44
|
-
|
|
45
|
-
* * *
|
|
46
|
-
|
|
47
|
-
### Button
|
|
48
|
-
|
|
49
|
-
Applies to buttons and other interactive elements such as the hover state of links.
|
|
50
|
-
|
|
51
|
-
radius.system.button
|
|
52
|
-
|
|
53
|
-
* * *
|
|
54
|
-
|
|
55
|
-
### Form
|
|
56
|
-
|
|
57
|
-
Applies to form inputs and alerts.
|
|
58
|
-
|
|
59
|
-
radius.system.form
|
|
60
|
-
|
|
61
|
-
* * *
|
|
62
|
-
|
|
63
|
-
### Layout
|
|
64
|
-
|
|
65
|
-
Applies to panels, modals and slideouts.
|
|
66
|
-
|
|
67
|
-
radius.system.layout
|
|
68
|
-
|
|
69
|
-
On this page
|
|
70
|
-
|
|
71
|
-
* [System](#system)
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
[](#spacing)Spacing
|
|
2
|
-
===================
|
|
3
|
-
|
|
4
|
-
Spacing is the distance between elements. It is used to create visual balance and hierarchy in the UI to ensure a cohesive experience for the user.
|
|
5
|
-
|
|
6
|
-
Spacing tokens
|
|
7
|
-
| Token Name | Alias | Description | Visual |
|
|
8
|
-
| --- | --- | --- | --- |
|
|
9
|
-
| spacing.000 | none | No spacing |
|
|
10
|
-
0px
|
|
11
|
-
|
|
12
|
-
|
|
|
13
|
-
| spacing.050 | | 50% (0.5x) spacing |
|
|
14
|
-
|
|
15
|
-
2px
|
|
16
|
-
|
|
17
|
-
|
|
|
18
|
-
| spacing.100 | xs | The base unit for spacing. The fallback for all other values will be calculated from this value. |
|
|
19
|
-
|
|
20
|
-
4px
|
|
21
|
-
|
|
22
|
-
|
|
|
23
|
-
| spacing.150 | | 150% (1.5x) spacing |
|
|
24
|
-
|
|
25
|
-
6px
|
|
26
|
-
|
|
27
|
-
|
|
|
28
|
-
| spacing.200 | sm | 200% (2x) spacing |
|
|
29
|
-
|
|
30
|
-
8px
|
|
31
|
-
|
|
32
|
-
|
|
|
33
|
-
| spacing.250 | | 250% (2.5x) spacing |
|
|
34
|
-
|
|
35
|
-
10px
|
|
36
|
-
|
|
37
|
-
|
|
|
38
|
-
| spacing.300 | | 300% (3x) spacing |
|
|
39
|
-
|
|
40
|
-
12px
|
|
41
|
-
|
|
42
|
-
|
|
|
43
|
-
| spacing.350 | | 350% (3.5x) spacing |
|
|
44
|
-
|
|
45
|
-
14px
|
|
46
|
-
|
|
47
|
-
|
|
|
48
|
-
| spacing.400 | md | 400% (4x) spacing |
|
|
49
|
-
|
|
50
|
-
16px
|
|
51
|
-
|
|
52
|
-
|
|
|
53
|
-
| spacing.500 | | 500% (5x) spacing |
|
|
54
|
-
|
|
55
|
-
20px
|
|
56
|
-
|
|
57
|
-
|
|
|
58
|
-
| spacing.600 | lg | 600% (6x) spacing |
|
|
59
|
-
|
|
60
|
-
24px
|
|
61
|
-
|
|
62
|
-
|
|
|
63
|
-
| spacing.700 | | 700% (7x) spacing |
|
|
64
|
-
|
|
65
|
-
28px
|
|
66
|
-
|
|
67
|
-
|
|
|
68
|
-
| spacing.800 | | 800% (8x) spacing |
|
|
69
|
-
|
|
70
|
-
32px
|
|
71
|
-
|
|
72
|
-
|
|
|
73
|
-
| spacing.900 | | 900% (9x) spacing |
|
|
74
|
-
|
|
75
|
-
36px
|
|
76
|
-
|
|
77
|
-
|
|
|
78
|
-
| spacing.1000 | | 1000% (10x) spacing |
|
|
79
|
-
|
|
80
|
-
40px
|
|
81
|
-
|
|
82
|
-
|
|
|
83
|
-
| spacing.1200 | xl | 1200% (12x) spacing |
|
|
84
|
-
|
|
85
|
-
48px
|
|
86
|
-
|
|
87
|
-
|
|
|
88
|
-
|
|
89
|
-
On this page
|
|
@@ -1,322 +0,0 @@
|
|
|
1
|
-
[](#typography)Typography
|
|
2
|
-
=========================
|
|
3
|
-
|
|
4
|
-
Typography is controlled by the `IressText` component, or the `textStyle` prop on other components. They implement consistent line heights and font weights.
|
|
5
|
-
|
|
6
|
-
[](#body)Body
|
|
7
|
-
-------------
|
|
8
|
-
|
|
9
|
-
This is the default text variant, and is designed to be clear and easy to read. This high level token also styles other tags beneath it such as `ul`, `ol`, `em` and `strong`, so that they inherit the same styling as the body text.
|
|
10
|
-
|
|
11
|
-
Nobis odit nesciunt in, **harum provident** deleniti molestiae dolorum aliquid tempora optio accusamus dolore _porro voluptatibus_. Dolorum, repellat expedita.
|
|
12
|
-
|
|
13
|
-
* Voluptatem assumenda soluta!
|
|
14
|
-
* Illum et atque alias possimus maiores rem in corrupti consectetur!
|
|
15
|
-
* Dolorum, repellat expedita!
|
|
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
|
-
<IressText\>
|
|
22
|
-
<p\>
|
|
23
|
-
Nobis odit nesciunt in,{' '}
|
|
24
|
-
<strong\>
|
|
25
|
-
harum provident </strong\>
|
|
26
|
-
{' '}deleniti molestiae dolorum aliquid tempora optio accusamus dolore{' '}
|
|
27
|
-
<em\>
|
|
28
|
-
porro voluptatibus </em\>
|
|
29
|
-
. Dolorum, repellat expedita. </p\>
|
|
30
|
-
<ul\>
|
|
31
|
-
<li\>
|
|
32
|
-
Voluptatem assumenda soluta! </li\>
|
|
33
|
-
<li\>
|
|
34
|
-
Illum et atque alias possimus maiores rem in corrupti consectetur! </li\>
|
|
35
|
-
<li\>
|
|
36
|
-
Dolorum, repellat expedita! </li\>
|
|
37
|
-
</ul\>
|
|
38
|
-
</IressText\>
|
|
39
|
-
|
|
40
|
-
Copy
|
|
41
|
-
|
|
42
|
-
### [](#sizes)Sizes
|
|
43
|
-
|
|
44
|
-
Body text can be set in a variety of sizes, from small to large. The size of the text should be chosen based on the context and importance of the content.
|
|
45
|
-
|
|
46
|
-
typography.body.sm Used for small components such as badges and field hints, as well as compact variations of tables and lists.
|
|
47
|
-
|
|
48
|
-
typography.body.md The most commonly used body text size, used for most text content in the product.
|
|
49
|
-
|
|
50
|
-
typography.body.lg Used for tag lines, subtitles, and other large text content in the product.
|
|
51
|
-
|
|
52
|
-
Hide code
|
|
53
|
-
|
|
54
|
-
\[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; }
|
|
55
|
-
|
|
56
|
-
<IressStack gap\="md"\>
|
|
57
|
-
<IressText textStyle\="typography.body.sm"\>
|
|
58
|
-
<TokenTag\>
|
|
59
|
-
typography.body.sm </TokenTag\>
|
|
60
|
-
{' '}Used for small components such as badges and field hints, as well as compact variations of tables and lists.
|
|
61
|
-
</IressText\>
|
|
62
|
-
<IressText textStyle\="typography.body.md"\>
|
|
63
|
-
<TokenTag\>
|
|
64
|
-
typography.body.md </TokenTag\>
|
|
65
|
-
{' '}The most commonly used body text size, used for most text content in the product.
|
|
66
|
-
</IressText\>
|
|
67
|
-
<IressText textStyle\="typography.body.lg"\>
|
|
68
|
-
<TokenTag\>
|
|
69
|
-
typography.body.lg </TokenTag\>
|
|
70
|
-
{' '}Used for tag lines, subtitles, and other large text content in the product.
|
|
71
|
-
</IressText\>
|
|
72
|
-
</IressStack\>
|
|
73
|
-
|
|
74
|
-
Copy
|
|
75
|
-
|
|
76
|
-
### [](#variants)Variants
|
|
77
|
-
|
|
78
|
-
Body text can be combined with bold (strong) and italic (emphasis) text to create emphasis or hierarchy within the content.
|
|
79
|
-
|
|
80
|
-
* Bold text should be used to **draw attention** to part of a sentence, or to provide a visual label for readonly text.
|
|
81
|
-
* Italic text should be used to add _emphasis_ to content, or to add stress to part of a sentence.
|
|
82
|
-
|
|
83
|
-
#### Strong
|
|
84
|
-
|
|
85
|
-
Strong variant is used to draw attention to certain text, making a large block of text easier to scan. This token is used to style the <strong /> tag in a body of text.
|
|
86
|
-
|
|
87
|
-
typography.body.sm.strongStrong text is used to highlight important information in a paragraph of text.
|
|
88
|
-
|
|
89
|
-
typography.body.md.strongStrong text is used to highlight important information in a paragraph of text.
|
|
90
|
-
|
|
91
|
-
typography.body.lg.strongStrong text is used to highlight important information in a paragraph of text.
|
|
92
|
-
|
|
93
|
-
* * *
|
|
94
|
-
|
|
95
|
-
#### Emphasis
|
|
96
|
-
|
|
97
|
-
Emphasis (em) variant is used to emphasise certain text to indicate they make a reference to a standard/legal term. This token is used to style the <em /> tag in a body of text.
|
|
98
|
-
|
|
99
|
-
typography.body.sm.em Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes.
|
|
100
|
-
|
|
101
|
-
typography.body.md.em Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes.
|
|
102
|
-
|
|
103
|
-
typography.body.lg.em Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes.
|
|
104
|
-
|
|
105
|
-
Hide code
|
|
106
|
-
|
|
107
|
-
\[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; }
|
|
108
|
-
|
|
109
|
-
<IressStack gap\="md"\>
|
|
110
|
-
<IressText\>
|
|
111
|
-
<h4\>
|
|
112
|
-
Strong </h4\>
|
|
113
|
-
<p\>
|
|
114
|
-
{\`Strong variant is used to draw attention to certain text, making a large block of text easier to scan. This token is used to style the <strong /> tag in a body of text.\`}
|
|
115
|
-
</p\>
|
|
116
|
-
</IressText\>
|
|
117
|
-
<IressText textStyle\="typography.body.sm.strong"\>
|
|
118
|
-
<TokenTag\>
|
|
119
|
-
typography.body.sm.strong </TokenTag\>
|
|
120
|
-
Strong text is used to highlight important information in a paragraph of text. </IressText\>
|
|
121
|
-
<IressText textStyle\="typography.body.md.strong"\>
|
|
122
|
-
<TokenTag\>
|
|
123
|
-
typography.body.md.strong </TokenTag\>
|
|
124
|
-
Strong text is used to highlight important information in a paragraph of text. </IressText\>
|
|
125
|
-
<IressText textStyle\="typography.body.lg.strong"\>
|
|
126
|
-
<TokenTag\>
|
|
127
|
-
typography.body.lg.strong </TokenTag\>
|
|
128
|
-
Strong text is used to highlight important information in a paragraph of text. </IressText\>
|
|
129
|
-
<IressDivider />
|
|
130
|
-
<IressText\>
|
|
131
|
-
<h4\>
|
|
132
|
-
Emphasis </h4\>
|
|
133
|
-
<p\>
|
|
134
|
-
{\`Emphasis (em) variant is used to emphasise certain text to indicate they make a reference to a standard/legal term. This token is used to style the <em /> tag in a body of text.\`}
|
|
135
|
-
</p\>
|
|
136
|
-
</IressText\>
|
|
137
|
-
<IressText textStyle\="typography.body.sm.em"\>
|
|
138
|
-
<TokenTag\>
|
|
139
|
-
typography.body.sm.em </TokenTag\>
|
|
140
|
-
{' '}Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes.
|
|
141
|
-
</IressText\>
|
|
142
|
-
<IressText textStyle\="typography.body.md.em"\>
|
|
143
|
-
<TokenTag\>
|
|
144
|
-
typography.body.md.em </TokenTag\>
|
|
145
|
-
{' '}Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes.
|
|
146
|
-
</IressText\>
|
|
147
|
-
<IressText textStyle\="typography.body.lg.em"\>
|
|
148
|
-
<TokenTag\>
|
|
149
|
-
typography.body.lg.em </TokenTag\>
|
|
150
|
-
{' '}Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes.
|
|
151
|
-
</IressText\>
|
|
152
|
-
</IressStack\>
|
|
153
|
-
|
|
154
|
-
Copy
|
|
155
|
-
|
|
156
|
-
[](#headings)Headings
|
|
157
|
-
---------------------
|
|
158
|
-
|
|
159
|
-
Headings form the structure of a web page. They're designed to stand out visually, drawing a user's eye to distinct sections of the document. They can be set in a variety of sizes based on systematic font sizing with native heading scales (H1-H6).
|
|
160
|
-
|
|
161
|
-
Heading 1 `<h1 />`
|
|
162
|
-
==================
|
|
163
|
-
|
|
164
|
-
typography.heading.1
|
|
165
|
-
|
|
166
|
-
Use for the main page title to establish a clear hierarchy. There is only one H1 per screen, emphasising the primary purpose or context of the page.
|
|
167
|
-
|
|
168
|
-
Heading 2 `<h2 />`
|
|
169
|
-
------------------
|
|
170
|
-
|
|
171
|
-
typography.heading.2
|
|
172
|
-
|
|
173
|
-
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.
|
|
174
|
-
|
|
175
|
-
### Heading 3 `<h3 />`
|
|
176
|
-
|
|
177
|
-
typography.heading.3
|
|
178
|
-
|
|
179
|
-
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.
|
|
180
|
-
|
|
181
|
-
#### Heading 4 `<h4 />`
|
|
182
|
-
|
|
183
|
-
typography.heading.4
|
|
184
|
-
|
|
185
|
-
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.
|
|
186
|
-
|
|
187
|
-
##### Heading 5 `<h5 />`
|
|
188
|
-
|
|
189
|
-
typography.heading.5
|
|
190
|
-
|
|
191
|
-
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.
|
|
192
|
-
|
|
193
|
-
An H2 styled as an H3.
|
|
194
|
-
----------------------
|
|
195
|
-
|
|
196
|
-
Hide code
|
|
197
|
-
|
|
198
|
-
\[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; }
|
|
199
|
-
|
|
200
|
-
<IressStack gap\="lg"\>
|
|
201
|
-
<IressText\>
|
|
202
|
-
<h1\>
|
|
203
|
-
Heading 1{' '}
|
|
204
|
-
<code\>
|
|
205
|
-
{\`<h1 />\`}
|
|
206
|
-
</code\>
|
|
207
|
-
</h1\>
|
|
208
|
-
<IressText
|
|
209
|
-
mb\="sm"
|
|
210
|
-
mt\="\-sm"
|
|
211
|
-
\>
|
|
212
|
-
<TokenTag\>
|
|
213
|
-
typography.heading.1 </TokenTag\>
|
|
214
|
-
</IressText\>
|
|
215
|
-
<p\>
|
|
216
|
-
Use for the main page title to establish a clear hierarchy. There is only one H1 per screen, emphasising the primary purpose or context of the page. </p\>
|
|
217
|
-
</IressText\>
|
|
218
|
-
<IressText\>
|
|
219
|
-
<h2\>
|
|
220
|
-
Heading 2{' '}
|
|
221
|
-
<code\>
|
|
222
|
-
{\`<h2 />\`}
|
|
223
|
-
</code\>
|
|
224
|
-
</h2\>
|
|
225
|
-
<IressText
|
|
226
|
-
mb\="sm"
|
|
227
|
-
mt\="\-xs"
|
|
228
|
-
\>
|
|
229
|
-
<TokenTag\>
|
|
230
|
-
typography.heading.2 </TokenTag\>
|
|
231
|
-
</IressText\>
|
|
232
|
-
<p\>
|
|
233
|
-
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. </p\>
|
|
234
|
-
</IressText\>
|
|
235
|
-
<IressText\>
|
|
236
|
-
<h3\>
|
|
237
|
-
Heading 3{' '}
|
|
238
|
-
<code\>
|
|
239
|
-
{\`<h3 />\`}
|
|
240
|
-
</code\>
|
|
241
|
-
</h3\>
|
|
242
|
-
<IressText
|
|
243
|
-
mb\="sm"
|
|
244
|
-
mt\="\-xs"
|
|
245
|
-
\>
|
|
246
|
-
<TokenTag\>
|
|
247
|
-
typography.heading.3 </TokenTag\>
|
|
248
|
-
</IressText\>
|
|
249
|
-
<p\>
|
|
250
|
-
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. </p\>
|
|
251
|
-
</IressText\>
|
|
252
|
-
<IressText\>
|
|
253
|
-
<h4\>
|
|
254
|
-
Heading 4{' '}
|
|
255
|
-
<code\>
|
|
256
|
-
{\`<h4 />\`}
|
|
257
|
-
</code\>
|
|
258
|
-
</h4\>
|
|
259
|
-
<IressText
|
|
260
|
-
mb\="sm"
|
|
261
|
-
mt\="\-xs"
|
|
262
|
-
\>
|
|
263
|
-
<TokenTag\>
|
|
264
|
-
typography.heading.4 </TokenTag\>
|
|
265
|
-
</IressText\>
|
|
266
|
-
<p\>
|
|
267
|
-
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. </p\>
|
|
268
|
-
</IressText\>
|
|
269
|
-
<IressText\>
|
|
270
|
-
<h5\>
|
|
271
|
-
Heading 5{' '}
|
|
272
|
-
<code\>
|
|
273
|
-
{\`<h5 />\`}
|
|
274
|
-
</code\>
|
|
275
|
-
</h5\>
|
|
276
|
-
<IressText
|
|
277
|
-
mb\="sm"
|
|
278
|
-
mt\="\-xs"
|
|
279
|
-
\>
|
|
280
|
-
<TokenTag\>
|
|
281
|
-
typography.heading.5 </TokenTag\>
|
|
282
|
-
</IressText\>
|
|
283
|
-
<p\>
|
|
284
|
-
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. </p\>
|
|
285
|
-
</IressText\>
|
|
286
|
-
<IressText
|
|
287
|
-
element\="h2"
|
|
288
|
-
textStyle\="typography.heading.3"
|
|
289
|
-
\>
|
|
290
|
-
An H2 styled as an H3. </IressText\>
|
|
291
|
-
</IressStack\>
|
|
292
|
-
|
|
293
|
-
Copy
|
|
294
|
-
|
|
295
|
-
[](#code)Code
|
|
296
|
-
-------------
|
|
297
|
-
|
|
298
|
-
The code variant is used to display code snippets or other monospaced text. It is designed to be clear and easy to read, with a fixed-width font that makes it easy to distinguish between characters.
|
|
299
|
-
|
|
300
|
-
typography.code Used to display code snippets in the product, such as in the API documentation.
|
|
301
|
-
|
|
302
|
-
Hide code
|
|
303
|
-
|
|
304
|
-
\[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; }
|
|
305
|
-
|
|
306
|
-
<IressStack gap\="md"\>
|
|
307
|
-
<IressText textStyle\="typography.code"\>
|
|
308
|
-
<TokenTag\>
|
|
309
|
-
typography.code </TokenTag\>
|
|
310
|
-
{' '}Used to display code snippets in the product, such as in the API documentation.
|
|
311
|
-
</IressText\>
|
|
312
|
-
</IressStack\>
|
|
313
|
-
|
|
314
|
-
Copy
|
|
315
|
-
|
|
316
|
-
On this page
|
|
317
|
-
|
|
318
|
-
* [Body](#body)
|
|
319
|
-
* [Sizes](#sizes)
|
|
320
|
-
* [Variants](#variants)
|
|
321
|
-
* [Headings](#headings)
|
|
322
|
-
* [Code](#code)
|