@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,172 +0,0 @@
|
|
|
1
|
-
[](#colour)Colour
|
|
2
|
-
=================
|
|
3
|
-
|
|
4
|
-
These are all styling props related to changing the foreground and background colours of a component.
|
|
5
|
-
|
|
6
|
-
[](#bg)`bg`
|
|
7
|
-
-----------
|
|
8
|
-
|
|
9
|
-
The `bg` prop allows you to change the background of any component to the value of a colour token. It should be used sparingly, and usually alongside the `color` prop to ensure accessibility.
|
|
10
|
-
|
|
11
|
-
Below is an example of a component using `bg` and `color` to create a featured panel that changes colour depending on the theme.
|
|
12
|
-
|
|
13
|
-
##### Featured panel
|
|
14
|
-
|
|
15
|
-
This is a featured panel, in case you want to highlight something important or draw attention to a specific piece of content.
|
|
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
|
-
<IressPanel
|
|
22
|
-
bg\="colour.primary.fill"
|
|
23
|
-
color\="colour.primary.onFill"
|
|
24
|
-
\>
|
|
25
|
-
<h5\>
|
|
26
|
-
Featured panel </h5\>
|
|
27
|
-
<p\>
|
|
28
|
-
This is a featured panel, in case you want to highlight something important or draw attention to a specific piece of content. </p\>
|
|
29
|
-
</IressPanel\>
|
|
30
|
-
|
|
31
|
-
Copy
|
|
32
|
-
|
|
33
|
-
#### [](#bg-props)Props
|
|
34
|
-
|
|
35
|
-
| Name | Description | Default | Control |
|
|
36
|
-
| --- | --- | --- | --- |
|
|
37
|
-
| bg |
|
|
38
|
-
**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
|
|
39
|
-
|
|
40
|
-
We recommend using the following token values for best background contrast:
|
|
41
|
-
|
|
42
|
-
* `colour.primary.fill` for primary backgrounds that need to stand out
|
|
43
|
-
* `colour.primary.surface` for primary backgrounds that need to be less prominent
|
|
44
|
-
* `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
|
|
45
|
-
* `colour.neutral.20` for a slightly darker background color, used in neutral state components
|
|
46
|
-
* `colour.system.danger.fill` for error backgrounds that need to stand out
|
|
47
|
-
* `colour.system.danger.surface` for error backgrounds that need to be less prominent
|
|
48
|
-
* `colour.system.success.fill` for success backgrounds that need to stand out
|
|
49
|
-
* `colour.system.success.surface` for success backgrounds that need to be less prominent
|
|
50
|
-
* `colour.system.warning.fill` for warning backgrounds that need to stand out
|
|
51
|
-
* `colour.system.warning.surface` for warning backgrounds that need to be less prominent
|
|
52
|
-
* `colour.system.info.fill` for info backgrounds that need to stand out
|
|
53
|
-
* `colour.system.info.surface` for info backgrounds that need to be less prominent
|
|
54
|
-
|
|
55
|
-
ResponsiveProp<ColorToken> | undefined
|
|
56
|
-
|
|
57
|
-
| \- |
|
|
58
|
-
|
|
59
|
-
"colour.primary.fill"
|
|
60
|
-
|
|
61
|
-
|
|
|
62
|
-
| color |
|
|
63
|
-
|
|
64
|
-
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`.
|
|
65
|
-
|
|
66
|
-
We recommend using the following token values for best color contrast:
|
|
67
|
-
|
|
68
|
-
* `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
|
|
69
|
-
* `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
|
|
70
|
-
* `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
|
|
71
|
-
* `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
|
|
72
|
-
* `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
|
|
73
|
-
* `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
|
|
74
|
-
* `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
|
|
75
|
-
* `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
|
|
76
|
-
* `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
|
|
77
|
-
* `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
|
|
78
|
-
* `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
|
|
79
|
-
* `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
|
|
80
|
-
|
|
81
|
-
ResponsiveProp<ColorToken> | undefined
|
|
82
|
-
|
|
83
|
-
| \- |
|
|
84
|
-
|
|
85
|
-
"colour.primary.onFill"
|
|
86
|
-
|
|
87
|
-
|
|
|
88
|
-
|
|
89
|
-
[](#color)`color`
|
|
90
|
-
-----------------
|
|
91
|
-
|
|
92
|
-
The `color` prop allows you to change the foreground of any component to the value of a colour token. It should be used sparingly, and usually alongside the `bg` prop to ensure accessibility.
|
|
93
|
-
|
|
94
|
-
Below is an example of using the `color` prop to highlight text throughout a component.
|
|
95
|
-
|
|
96
|
-
Sometimes actions are **successful**, and sometimes they are **dangerous**.
|
|
97
|
-
|
|
98
|
-
Hide code
|
|
99
|
-
|
|
100
|
-
\[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; }
|
|
101
|
-
|
|
102
|
-
<IressPanel\>
|
|
103
|
-
<p\>
|
|
104
|
-
Sometimes actions are{' '}
|
|
105
|
-
<IressText
|
|
106
|
-
color\="colour.system.success.text"
|
|
107
|
-
element\="strong"
|
|
108
|
-
\>
|
|
109
|
-
successful </IressText\>
|
|
110
|
-
, and sometimes they are{' '}
|
|
111
|
-
<IressText
|
|
112
|
-
color\="colour.system.danger.text"
|
|
113
|
-
element\="strong"
|
|
114
|
-
\>
|
|
115
|
-
dangerous </IressText\>
|
|
116
|
-
. </p\>
|
|
117
|
-
</IressPanel\>
|
|
118
|
-
|
|
119
|
-
Copy
|
|
120
|
-
|
|
121
|
-
#### [](#color-props)Props
|
|
122
|
-
|
|
123
|
-
| Name | Description | Default | Control |
|
|
124
|
-
| --- | --- | --- | --- |
|
|
125
|
-
| bg |
|
|
126
|
-
**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
|
|
127
|
-
|
|
128
|
-
We recommend using the following token values for best background contrast:
|
|
129
|
-
|
|
130
|
-
* `colour.primary.fill` for primary backgrounds that need to stand out
|
|
131
|
-
* `colour.primary.surface` for primary backgrounds that need to be less prominent
|
|
132
|
-
* `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
|
|
133
|
-
* `colour.neutral.20` for a slightly darker background color, used in neutral state components
|
|
134
|
-
* `colour.system.danger.fill` for error backgrounds that need to stand out
|
|
135
|
-
* `colour.system.danger.surface` for error backgrounds that need to be less prominent
|
|
136
|
-
* `colour.system.success.fill` for success backgrounds that need to stand out
|
|
137
|
-
* `colour.system.success.surface` for success backgrounds that need to be less prominent
|
|
138
|
-
* `colour.system.warning.fill` for warning backgrounds that need to stand out
|
|
139
|
-
* `colour.system.warning.surface` for warning backgrounds that need to be less prominent
|
|
140
|
-
* `colour.system.info.fill` for info backgrounds that need to stand out
|
|
141
|
-
* `colour.system.info.surface` for info backgrounds that need to be less prominent
|
|
142
|
-
|
|
143
|
-
ResponsiveProp<ColorToken> | undefined
|
|
144
|
-
|
|
145
|
-
| \- | Set object |
|
|
146
|
-
| color |
|
|
147
|
-
|
|
148
|
-
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`.
|
|
149
|
-
|
|
150
|
-
We recommend using the following token values for best color contrast:
|
|
151
|
-
|
|
152
|
-
* `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
|
|
153
|
-
* `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
|
|
154
|
-
* `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
|
|
155
|
-
* `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
|
|
156
|
-
* `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
|
|
157
|
-
* `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
|
|
158
|
-
* `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
|
|
159
|
-
* `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
|
|
160
|
-
* `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
|
|
161
|
-
* `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
|
|
162
|
-
* `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
|
|
163
|
-
* `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
|
|
164
|
-
|
|
165
|
-
ResponsiveProp<ColorToken> | undefined
|
|
166
|
-
|
|
167
|
-
| \- | Set object |
|
|
168
|
-
|
|
169
|
-
On this page
|
|
170
|
-
|
|
171
|
-
* [bg](#bg)
|
|
172
|
-
* [color](#color)
|
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
[](#elevation)Elevation
|
|
2
|
-
=======================
|
|
3
|
-
|
|
4
|
-
These are all styling props related to changing the elevation of a component to help guide visual hierarchy.
|
|
5
|
-
|
|
6
|
-
[](#layerstyle)`layerStyle`
|
|
7
|
-
---------------------------
|
|
8
|
-
|
|
9
|
-
The `layerStyle` prop allows you to draw attention to certain parts of the screen, making a screen easier to scan. The following styles are available:
|
|
10
|
-
|
|
11
|
-
* `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.
|
|
12
|
-
* `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.
|
|
13
|
-
* `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.
|
|
14
|
-
|
|
15
|
-
This panel is raised. This is useful for creating a visual hierarchy and drawing attention to important content.
|
|
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
|
-
<IressPanel layerStyle\="elevation.raised"\>
|
|
22
|
-
This panel is raised. This is useful for creating a visual hierarchy and drawing attention to important content.
|
|
23
|
-
</IressPanel\>
|
|
24
|
-
|
|
25
|
-
Copy
|
|
26
|
-
|
|
27
|
-
#### [](#layerStyle-props)Props
|
|
28
|
-
|
|
29
|
-
| Name | Description | Default | Control |
|
|
30
|
-
| --- | --- | --- | --- |
|
|
31
|
-
| layerStyle |
|
|
32
|
-
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.
|
|
33
|
-
|
|
34
|
-
* `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.
|
|
35
|
-
* `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.
|
|
36
|
-
* `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.
|
|
37
|
-
|
|
38
|
-
ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact"> | undefined
|
|
39
|
-
|
|
40
|
-
| \- |
|
|
41
|
-
|
|
42
|
-
"elevation.raised"
|
|
43
|
-
|
|
44
|
-
|
|
|
45
|
-
|
|
46
|
-
[](#focusable)`focusable`
|
|
47
|
-
-------------------------
|
|
48
|
-
|
|
49
|
-
The `focusable` prop allows you to set the focus state of a component. This is useful for components that need to be interactive via keyboard, but are not necessarily a button or input.
|
|
50
|
-
|
|
51
|
-
It can be set to `true` to enable focus styles when the element is focused using keyboard navigation, or `within` to show focus styles when an element within is focused.
|
|
52
|
-
|
|
53
|
-
This element will have focus styles applied when it is focused. This is useful for accessibility and keyboard navigation.
|
|
54
|
-
|
|
55
|
-
Hide code
|
|
56
|
-
|
|
57
|
-
\[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; }
|
|
58
|
-
|
|
59
|
-
<IressPanel
|
|
60
|
-
focusable\="true"
|
|
61
|
-
tabIndex\={0}
|
|
62
|
-
\>
|
|
63
|
-
This element will have focus styles applied when it is focused. This is useful for accessibility and keyboard navigation.
|
|
64
|
-
</IressPanel\>
|
|
65
|
-
|
|
66
|
-
Copy
|
|
67
|
-
|
|
68
|
-
#### [](#focusable-props)Props
|
|
69
|
-
|
|
70
|
-
| Name | Description | Default | Control |
|
|
71
|
-
| --- | --- | --- | --- |
|
|
72
|
-
| focusable |
|
|
73
|
-
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.
|
|
74
|
-
|
|
75
|
-
"true""within"undefined
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
| \- |
|
|
80
|
-
|
|
81
|
-
"true"
|
|
82
|
-
|
|
83
|
-
|
|
|
84
|
-
|
|
85
|
-
On this page
|
|
86
|
-
|
|
87
|
-
* [layerStyle](#layerstyle)
|
|
88
|
-
* [focusable](#focusable)
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
[](#radius)Radius
|
|
2
|
-
=================
|
|
3
|
-
|
|
4
|
-
These are all styling props related to changing the radius of a component affects the visual softness and perceived friendliness of the interface, influencing the overall user experience.
|
|
5
|
-
|
|
6
|
-
[](#borderradius)`borderRadius`
|
|
7
|
-
-------------------------------
|
|
8
|
-
|
|
9
|
-
The `borderRadius` prop allows you to change the border radius of any component. It should be used sparingly, and often used when creating custom components that are not part of the design system, however you still want to retain the look and feel of the rest of the system.
|
|
10
|
-
|
|
11
|
-
Hide code
|
|
12
|
-
|
|
13
|
-
\[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; }
|
|
14
|
-
|
|
15
|
-
<IressInput
|
|
16
|
-
borderRadius\="radius.system.layout"
|
|
17
|
-
p\="spacing.400"
|
|
18
|
-
placeholder\="Search everything"
|
|
19
|
-
textStyle\="typography.body.lg"
|
|
20
|
-
/>
|
|
21
|
-
|
|
22
|
-
Copy
|
|
23
|
-
|
|
24
|
-
#### [](#borderRadius-props)Props
|
|
25
|
-
|
|
26
|
-
| Name | Description | Default | Control |
|
|
27
|
-
| --- | --- | --- | --- |
|
|
28
|
-
| borderRadius |
|
|
29
|
-
The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
|
|
30
|
-
|
|
31
|
-
| Chrome | Firefox | Safari | Edge | IE |
|
|
32
|
-
| --- | --- | --- | --- | --- |
|
|
33
|
-
| **4** | **4** | **5** | **12** | **9** |
|
|
34
|
-
| 1 _\-x-_ | | 3 _\-x-_ | | |
|
|
35
|
-
|
|
36
|
-
ResponsiveProp<RadiusToken> | undefined
|
|
37
|
-
|
|
38
|
-
| \- |
|
|
39
|
-
|
|
40
|
-
"radius.system.layout"
|
|
41
|
-
|
|
42
|
-
|
|
|
43
|
-
|
|
44
|
-
### [](#removing-border-radius)Removing border radius
|
|
45
|
-
|
|
46
|
-
In some cases you may need to remove the border-radius to achieve design requirements. This can be done using `radius.000` or `none`.
|
|
47
|
-
|
|
48
|
-
No radius here
|
|
49
|
-
|
|
50
|
-
Hide code
|
|
51
|
-
|
|
52
|
-
\[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; }
|
|
53
|
-
|
|
54
|
-
<IressPanel
|
|
55
|
-
bg\="alt"
|
|
56
|
-
borderRadius\="none"
|
|
57
|
-
\>
|
|
58
|
-
No radius here
|
|
59
|
-
</IressPanel\>
|
|
60
|
-
|
|
61
|
-
Copy
|
|
62
|
-
|
|
63
|
-
#### [](#noBorderRadius-props)Props
|
|
64
|
-
|
|
65
|
-
| Name | Description | Default | Control |
|
|
66
|
-
| --- | --- | --- | --- |
|
|
67
|
-
| borderRadius |
|
|
68
|
-
The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
|
|
69
|
-
|
|
70
|
-
| Chrome | Firefox | Safari | Edge | IE |
|
|
71
|
-
| --- | --- | --- | --- | --- |
|
|
72
|
-
| **4** | **4** | **5** | **12** | **9** |
|
|
73
|
-
| 1 _\-x-_ | | 3 _\-x-_ | | |
|
|
74
|
-
|
|
75
|
-
ResponsiveProp<RadiusToken> | undefined
|
|
76
|
-
|
|
77
|
-
| \- |
|
|
78
|
-
|
|
79
|
-
"none"
|
|
80
|
-
|
|
81
|
-
|
|
|
82
|
-
|
|
83
|
-
On this page
|
|
84
|
-
|
|
85
|
-
* [borderRadius](#borderradius)
|
|
86
|
-
* [Removing border radius](#removing-border-radius)
|
|
@@ -1,160 +0,0 @@
|
|
|
1
|
-
[](#styling-props)Styling props
|
|
2
|
-
===============================
|
|
3
|
-
|
|
4
|
-
This page lists all the custom styling properties available in our components, which design tokens they are mapped to and which CSS properties they affect.
|
|
5
|
-
|
|
6
|
-
Styling properties are the recommended way of customising components for your needs, as they ensure your styles are compatible when any theme is applied to your application. If you need further customisation, you can use regular CSS and reference the tokens directly.
|
|
7
|
-
|
|
8
|
-
These replace the utility classes and internal component tokens provided by previous versions of the design system.
|
|
9
|
-
|
|
10
|
-
[](#reference)Reference
|
|
11
|
-
-----------------------
|
|
12
|
-
|
|
13
|
-
Styling props reference
|
|
14
|
-
| JSX prop | CSS property | Token mapping | Responsive |
|
|
15
|
-
| --- | --- | --- | --- |
|
|
16
|
-
| [bg](/?path=/docs/styling-props-colour--docs#bg) | background | [Colour](/?path=/docs/foundations-tokens-colour--docs) | Yes |
|
|
17
|
-
| [borderRadius](/?path=/docs/styling-props-radius--docs#borderradius) | border-radius | [Radius](/?path=/docs/foundations-tokens-radius--docs) | Yes |
|
|
18
|
-
| [color](/?path=/docs/styling-props-colour--docs#color) | color | [Colour](/?path=/docs/foundations-tokens-colour--docs) | Yes |
|
|
19
|
-
| [focusable](/?path=/docs/styling-props-elevation--docs#focusable) | border and box-shadow | [Elevation](/?path=/docs/foundations-tokens-elevation--docs) | No |
|
|
20
|
-
| [layerStyle](/?path=/docs/styling-props-elevation--docs#layerstyle) | border and box-shadow | [Elevation](/?path=/docs/foundations-tokens-elevation--docs) | Yes |
|
|
21
|
-
| [maxWidth](/?path=/docs/styling-props-sizing--docs#container-widths) | max-width | N/A | Yes |
|
|
22
|
-
| [m](/?path=/docs/styling-props-spacing--docs#margin) | margin | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
23
|
-
| [mx](/?path=/docs/styling-props-spacing--docs#margin) | margin-inline | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
24
|
-
| [my](/?path=/docs/styling-props-spacing--docs#margin) | margin-block | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
25
|
-
| [mb](/?path=/docs/styling-props-spacing--docs#margin) | margin-bottom | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
26
|
-
| [ml](/?path=/docs/styling-props-spacing--docs#margin) | margin-left | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
27
|
-
| [mr](/?path=/docs/styling-props-spacing--docs#margin) | margin-right | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
28
|
-
| [mt](/?path=/docs/styling-props-spacing--docs#margin) | margin-top | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
29
|
-
| [noGutter](/?path=/docs/styling-props-spacing--docs#nogutter) | margin-block-end | N/A | No |
|
|
30
|
-
| [p](/?path=/docs/styling-props-spacing--docs#padding) | padding | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
31
|
-
| [px](/?path=/docs/styling-props-spacing--docs#padding) | padding-inline | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
32
|
-
| [py](/?path=/docs/styling-props-spacing--docs#padding) | padding-block | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
33
|
-
| [pb](/?path=/docs/styling-props-spacing--docs#padding) | padding-bottom | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
34
|
-
| [pl](/?path=/docs/styling-props-spacing--docs#padding) | padding-left | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
35
|
-
| [pr](/?path=/docs/styling-props-spacing--docs#padding) | padding-right | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
36
|
-
| [pt](/?path=/docs/styling-props-spacing--docs#padding) | padding-top | [Spacing](/?path=/docs/foundations-tokens-spacing--docs) | Yes |
|
|
37
|
-
| [srOnly](/?path=/docs/styling-props-screen-readers--docs#sronly) | Multiple properties | N/A | Yes |
|
|
38
|
-
| [stretch](/?path=/docs/styling-props-spacing--docs#stretch) | align-self: stretch and height: 100% | N/A | No |
|
|
39
|
-
| [textAlign](/?path=/docs/styling-props-typography--docs#textalign) | text-align | N/A | Yes |
|
|
40
|
-
| [textStyle](/?path=/docs/styling-props-typography--docs#textStyle) | font | [Typography](/?path=/docs/foundations-tokens-typography--docs) | Yes |
|
|
41
|
-
| [width](/?path=/docs/styling-props-sizing--docs#inputwidths) | width | N/A | Yes |
|
|
42
|
-
|
|
43
|
-
[](#responsive)Responsive
|
|
44
|
-
-------------------------
|
|
45
|
-
|
|
46
|
-
Props marked responsive can accept either a single value that affects all breakpoints, or a responsive object map that sets a different value based on breakpoint.
|
|
47
|
-
|
|
48
|
-
\[data-radix-scroll-area-viewport\] {
|
|
49
|
-
scrollbar-width: none;
|
|
50
|
-
-ms-overflow-style: none;
|
|
51
|
-
-webkit-overflow-scrolling: touch;
|
|
52
|
-
}
|
|
53
|
-
\[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
|
|
54
|
-
display: none;
|
|
55
|
-
}
|
|
56
|
-
:where(\[data-radix-scroll-area-viewport\]) {
|
|
57
|
-
display: flex;
|
|
58
|
-
flex-direction: column;
|
|
59
|
-
align-items: stretch;
|
|
60
|
-
}
|
|
61
|
-
:where(\[data-radix-scroll-area-content\]) {
|
|
62
|
-
flex-grow: 1;
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
<IressPanel p\="xs" /> // applies extra small padding to all breakpoints
|
|
66
|
-
<IressPanel p\={{ base: 'lg', md: 'sm' }} /> // applies large padding by default, and changes to small padding once on medium sized screens.
|
|
67
|
-
|
|
68
|
-
Copy
|
|
69
|
-
|
|
70
|
-
[](#iresscss)`iressCss`
|
|
71
|
-
-----------------------
|
|
72
|
-
|
|
73
|
-
In some cases you may need to apply styling props to a non-IDS component. You can do this by using the `iressCss` prop, which accepts an object of styling props and returns a string of class names that can be applied to any element.
|
|
74
|
-
|
|
75
|
-
This will also work without JSX, allowing you to apply styling props to any element in your application.
|
|
76
|
-
|
|
77
|
-
\[data-radix-scroll-area-viewport\] {
|
|
78
|
-
scrollbar-width: none;
|
|
79
|
-
-ms-overflow-style: none;
|
|
80
|
-
-webkit-overflow-scrolling: touch;
|
|
81
|
-
}
|
|
82
|
-
\[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
|
|
83
|
-
display: none;
|
|
84
|
-
}
|
|
85
|
-
:where(\[data-radix-scroll-area-viewport\]) {
|
|
86
|
-
display: flex;
|
|
87
|
-
flex-direction: column;
|
|
88
|
-
align-items: stretch;
|
|
89
|
-
}
|
|
90
|
-
:where(\[data-radix-scroll-area-content\]) {
|
|
91
|
-
flex-grow: 1;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
<div className\={iressCss({ p: 'xs', bg: 'colour.primary.surface' })}\>
|
|
95
|
-
This div has extra small padding and a primary background colour.
|
|
96
|
-
</div\>
|
|
97
|
-
|
|
98
|
-
Copy
|
|
99
|
-
|
|
100
|
-
[](#iressstyled)`iressStyled`
|
|
101
|
-
-----------------------------
|
|
102
|
-
|
|
103
|
-
If you need your own component or a third-party component to accept styling props, you can use the `iressStyled` function to create a styled component that accepts styling props. This is similar to how you would use `styled-components` or `emotion`.
|
|
104
|
-
|
|
105
|
-
\[data-radix-scroll-area-viewport\] {
|
|
106
|
-
scrollbar-width: none;
|
|
107
|
-
-ms-overflow-style: none;
|
|
108
|
-
-webkit-overflow-scrolling: touch;
|
|
109
|
-
}
|
|
110
|
-
\[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
|
|
111
|
-
display: none;
|
|
112
|
-
}
|
|
113
|
-
:where(\[data-radix-scroll-area-viewport\]) {
|
|
114
|
-
display: flex;
|
|
115
|
-
flex-direction: column;
|
|
116
|
-
align-items: stretch;
|
|
117
|
-
}
|
|
118
|
-
:where(\[data-radix-scroll-area-content\]) {
|
|
119
|
-
flex-grow: 1;
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
const MyComponent \= iressStyled('div', {
|
|
123
|
-
p: 'xs',
|
|
124
|
-
bg: 'colour.primary.surface',
|
|
125
|
-
});
|
|
126
|
-
<MyComponent\>
|
|
127
|
-
This div has extra small padding and a primary background colour.
|
|
128
|
-
</MyComponent\>;
|
|
129
|
-
|
|
130
|
-
Copy
|
|
131
|
-
|
|
132
|
-
[](#migrating-from-version-5)Migrating from version 5
|
|
133
|
-
-----------------------------------------------------
|
|
134
|
-
|
|
135
|
-
### [](#utility-classes)Utility classes
|
|
136
|
-
|
|
137
|
-
If you have been using the utility classes from previous versions of IDS (eg. `iress-p--xs`), you will need to replace them with the new styling props. The utility classes are no longer supported in version 6.
|
|
138
|
-
|
|
139
|
-
<table class="css-1n5o7vh-diff-container"><tbody><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"><IressPanel className="iress-m--sm" /></pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"><IressPanel m="sm" /></pre></td></tr></tbody></table>
|
|
140
|
-
|
|
141
|
-
### [](#internal-component-tokens)Internal component tokens
|
|
142
|
-
|
|
143
|
-
If you have been using the internal component tokens (eg. `--iress-background-color`), you will need to replace them with the new styling props. The internal component tokens are no longer supported in version 6.
|
|
144
|
-
|
|
145
|
-
#### [](#note)Note
|
|
146
|
-
|
|
147
|
-
* Not every single internal component token has a direct mapping to a styling prop. For example, things like border width are no longer customisable. This helps ensure a consistent and accessible experience for all applications no matter the theme that is applied to them.
|
|
148
|
-
* Styling props only allow token values, not custom values (eg. `colour.system.status.danger` is allowed but not `red`). This is to ensure that the styling props are theme agnostic and can be used with any theme. If you need to use a custom value, you can use custom CSS or inline styles.
|
|
149
|
-
|
|
150
|
-
<table class="css-1n5o7vh-diff-container"><tbody><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"><IressPanel style={{ '--iress-background-color': 'var(--iress-g-success-color)' }} /></pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"><IressPanel bg="colour.system.success.fill" /></pre></td></tr></tbody></table>
|
|
151
|
-
|
|
152
|
-
On this page
|
|
153
|
-
|
|
154
|
-
* [Reference](#reference)
|
|
155
|
-
* [Responsive](#responsive)
|
|
156
|
-
* [iressCss](#iresscss)
|
|
157
|
-
* [iressStyled](#iressstyled)
|
|
158
|
-
* [Migrating from version 5](#migrating-from-version-5)
|
|
159
|
-
* [Utility classes](#utility-classes)
|
|
160
|
-
* [Internal component tokens](#internal-component-tokens)
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
[](#screen-readers)Screen readers
|
|
2
|
-
=================================
|
|
3
|
-
|
|
4
|
-
These are all styling props related to adjusting components for screen readers.
|
|
5
|
-
|
|
6
|
-
[](#sronly)`srOnly`
|
|
7
|
-
-------------------
|
|
8
|
-
|
|
9
|
-
The `srOnly` prop allows you to set a component to be only visible on screen readers. It is used to ensure the screen reader has context of the screen to help the user understand the tasks required of them.
|
|
10
|
-
|
|
11
|
-
Hello screen readers
|
|
12
|
-
|
|
13
|
-
Show code
|
|
14
|
-
|
|
15
|
-
#### [](#srOnly-props)Props
|
|
16
|
-
|
|
17
|
-
| Name | Description | Default | Control |
|
|
18
|
-
| --- | --- | --- | --- |
|
|
19
|
-
| srOnly |
|
|
20
|
-
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.
|
|
21
|
-
|
|
22
|
-
Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
23
|
-
|
|
24
|
-
ResponsiveProp<boolean> | undefined
|
|
25
|
-
|
|
26
|
-
| \- |
|
|
27
|
-
|
|
28
|
-
true
|
|
29
|
-
|
|
30
|
-
|
|
|
31
|
-
|
|
32
|
-
### [](#responsive)Responsive
|
|
33
|
-
|
|
34
|
-
The `srOnly` prop is responsive, allowing you to show content on larger screens and hiding them on smaller ones, enabling screen readers to have the same context as larger screens as they are not limited by device size.
|
|
35
|
-
|
|
36
|
-
This content is visible on large screens and screen readers
|
|
37
|
-
|
|
38
|
-
Show code
|
|
39
|
-
|
|
40
|
-
#### [](#srOnlyResponsive-props)Props
|
|
41
|
-
|
|
42
|
-
| Name | Description | Default | Control |
|
|
43
|
-
| --- | --- | --- | --- |
|
|
44
|
-
| srOnly |
|
|
45
|
-
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.
|
|
46
|
-
|
|
47
|
-
Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
|
|
48
|
-
|
|
49
|
-
ResponsiveProp<boolean> | undefined
|
|
50
|
-
|
|
51
|
-
| \- |
|
|
52
|
-
|
|
53
|
-
RAW
|
|
54
|
-
|
|
55
|
-
srOnly : {
|
|
56
|
-
|
|
57
|
-
* base : true
|
|
58
|
-
* lg : false
|
|
59
|
-
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
|
67
|
-
|
|
68
|
-
On this page
|
|
69
|
-
|
|
70
|
-
* [srOnly](#sronly)
|
|
71
|
-
* [Responsive](#responsive)
|