@iress-oss/ids-mcp-server 5.15.0 → 5.20.2

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 (134) hide show
  1. package/generated/docs/components_components-alert-docs.md +496 -0
  2. package/generated/docs/components_components-autocomplete-docs.md +3429 -0
  3. package/generated/docs/{components-autocomplete-recipes-docs.md → components_components-autocomplete-recipes-docs.md} +39 -14
  4. package/generated/docs/{components-badge-docs.md → components_components-badge-docs.md} +222 -30
  5. package/generated/docs/components_components-button-docs.md +2078 -0
  6. package/generated/docs/components_components-button-recipes-docs.md +37 -0
  7. package/generated/docs/components_components-buttongroup-docs.md +1045 -0
  8. package/generated/docs/components_components-card-docs.md +2290 -0
  9. package/generated/docs/{components-card-recipes-docs.md → components_components-card-recipes-docs.md} +132 -15
  10. package/generated/docs/components_components-checkbox-docs.md +1040 -0
  11. package/generated/docs/{components-checkboxgroup-docs.md → components_components-checkboxgroup-docs.md} +1001 -82
  12. package/generated/docs/{components-checkboxgroup-recipes-docs.md → components_components-checkboxgroup-recipes-docs.md} +102 -12
  13. package/generated/docs/{components-col-docs.md → components_components-col-docs.md} +331 -58
  14. package/generated/docs/components_components-combobox-docs.md +3735 -0
  15. package/generated/docs/{components-container-docs.md → components_components-container-docs.md} +61 -24
  16. package/generated/docs/{components-divider-docs.md → components_components-divider-docs.md} +83 -24
  17. package/generated/docs/{components-expander-docs.md → components_components-expander-docs.md} +266 -33
  18. package/generated/docs/components_components-field-docs.md +1369 -0
  19. package/generated/docs/components_components-filter-docs.md +4080 -0
  20. package/generated/docs/{components-form-docs.md → components_components-form-docs.md} +1556 -360
  21. package/generated/docs/{components-form-recipes-docs.md → components_components-form-recipes-docs.md} +277 -60
  22. package/generated/docs/{components-hide-docs.md → components_components-hide-docs.md} +195 -124
  23. package/generated/docs/components_components-icon-docs.md +1337 -0
  24. package/generated/docs/{components-inline-docs.md → components_components-inline-docs.md} +462 -42
  25. package/generated/docs/components_components-input-docs.md +1468 -0
  26. package/generated/docs/components_components-input-recipes-docs.md +367 -0
  27. package/generated/docs/components_components-inputcurrency-docs.md +432 -0
  28. package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md} +113 -17
  29. package/generated/docs/components_components-label-docs.md +323 -0
  30. package/generated/docs/components_components-menu-docs.md +2345 -0
  31. package/generated/docs/components_components-menu-menuitem-docs.md +633 -0
  32. package/generated/docs/{components-modal-docs.md → components_components-modal-docs.md} +1640 -231
  33. package/generated/docs/components_components-navbar-docs.md +1847 -0
  34. package/generated/docs/{components-navbar-recipes-docs.md → components_components-navbar-recipes-docs.md} +721 -40
  35. package/generated/docs/{components-panel-docs.md → components_components-panel-docs.md} +754 -57
  36. package/generated/docs/components_components-placeholder-docs.md +92 -0
  37. package/generated/docs/components_components-popover-docs.md +1643 -0
  38. package/generated/docs/components_components-popover-recipes-docs.md +491 -0
  39. package/generated/docs/components_components-progress-docs.md +115 -0
  40. package/generated/docs/{components-provider-docs.md → components_components-provider-docs.md} +42 -33
  41. package/generated/docs/components_components-radio-docs.md +491 -0
  42. package/generated/docs/{components-radiogroup-docs.md → components_components-radiogroup-docs.md} +927 -75
  43. package/generated/docs/components_components-readonly-docs.md +263 -0
  44. package/generated/docs/components_components-richselect-docs.md +6521 -0
  45. package/generated/docs/{components-row-docs.md → components_components-row-docs.md} +353 -43
  46. package/generated/docs/{components-select-docs.md → components_components-select-docs.md} +719 -61
  47. package/generated/docs/components_components-skeleton-docs.md +480 -0
  48. package/generated/docs/{components-skeleton-recipes-docs.md → components_components-skeleton-recipes-docs.md} +51 -11
  49. package/generated/docs/{components-skiplink-docs.md → components_components-skiplink-docs.md} +53 -14
  50. package/generated/docs/components_components-slideout-docs.md +2293 -0
  51. package/generated/docs/components_components-slider-docs.md +1276 -0
  52. package/generated/docs/components_components-spinner-docs.md +82 -0
  53. package/generated/docs/{components-stack-docs.md → components_components-stack-docs.md} +223 -40
  54. package/generated/docs/components_components-table-docs.md +3658 -0
  55. package/generated/docs/components_components-tabset-docs.md +772 -0
  56. package/generated/docs/components_components-tabset-tab-docs.md +262 -0
  57. package/generated/docs/components_components-tag-docs.md +257 -0
  58. package/generated/docs/{components-text-docs.md → components_components-text-docs.md} +491 -51
  59. package/generated/docs/{components-toaster-docs.md → components_components-toaster-docs.md} +187 -85
  60. package/generated/docs/components_components-toaster-toast-docs.md +634 -0
  61. package/generated/docs/components_components-toggle-docs.md +461 -0
  62. package/generated/docs/{components-tooltip-docs.md → components_components-tooltip-docs.md} +286 -41
  63. package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md} +230 -61
  64. package/generated/docs/components_contact-us-docs.md +12 -0
  65. package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md} +11 -21
  66. package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md} +8 -15
  67. package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md} +12 -20
  68. package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md} +6 -11
  69. package/generated/docs/components_foundations-introduction-docs.md +15 -0
  70. package/generated/docs/{foundations-principles-docs.md → components_foundations-principles-docs.md} +14 -24
  71. package/generated/docs/components_foundations-typography-docs.md +608 -0
  72. package/generated/docs/{foundations-user-experience-docs.md → components_foundations-user-experience-docs.md} +16 -26
  73. package/generated/docs/{foundations-visual-design-docs.md → components_foundations-visual-design-docs.md} +10 -17
  74. package/generated/docs/{frequently-asked-questions-docs.md → components_frequently-asked-questions-docs.md} +14 -23
  75. package/generated/docs/components_get-started-develop-docs.md +84 -0
  76. package/generated/docs/components_get-started-using-storybook-docs.md +55 -0
  77. package/generated/docs/components_introduction-docs.md +15 -0
  78. package/generated/docs/{patterns-loading-docs.md → components_patterns-loading-docs.md} +798 -153
  79. package/generated/docs/components_resources-changelog-docs.md +4 -0
  80. package/generated/docs/{resources-code-katas-docs.md → components_resources-code-katas-docs.md} +5 -9
  81. package/generated/docs/{resources-migration-guides-from-v4-to-v5-docs.md → components_resources-migration-guides-from-v4-to-v5-docs.md} +54 -239
  82. package/generated/docs/components_sandbox-docs.md +4 -0
  83. package/generated/docs/{versions-docs.md → components_versions-docs.md} +5 -8
  84. package/generated/docs/guidelines.md +484 -200
  85. package/generated/docs/introduction-docs.md +19 -30
  86. package/package.json +41 -45
  87. package/generated/docs/components-alert-docs.md +0 -130
  88. package/generated/docs/components-autocomplete-docs.md +0 -754
  89. package/generated/docs/components-button-docs.md +0 -362
  90. package/generated/docs/components-button-recipes-docs.md +0 -76
  91. package/generated/docs/components-buttongroup-docs.md +0 -310
  92. package/generated/docs/components-card-docs.md +0 -494
  93. package/generated/docs/components-checkbox-docs.md +0 -193
  94. package/generated/docs/components-combobox-docs.md +0 -1016
  95. package/generated/docs/components-field-docs.md +0 -675
  96. package/generated/docs/components-filter-docs.md +0 -1109
  97. package/generated/docs/components-icon-docs.md +0 -553
  98. package/generated/docs/components-input-docs.md +0 -335
  99. package/generated/docs/components-input-recipes-docs.md +0 -140
  100. package/generated/docs/components-inputcurrency-docs.md +0 -157
  101. package/generated/docs/components-label-docs.md +0 -135
  102. package/generated/docs/components-menu-docs.md +0 -704
  103. package/generated/docs/components-menu-menuitem-docs.md +0 -193
  104. package/generated/docs/components-navbar-docs.md +0 -291
  105. package/generated/docs/components-placeholder-docs.md +0 -27
  106. package/generated/docs/components-popover-docs.md +0 -464
  107. package/generated/docs/components-popover-recipes-docs.md +0 -245
  108. package/generated/docs/components-progress-docs.md +0 -104
  109. package/generated/docs/components-radio-docs.md +0 -107
  110. package/generated/docs/components-readonly-docs.md +0 -89
  111. package/generated/docs/components-richselect-docs.md +0 -2433
  112. package/generated/docs/components-skeleton-docs.md +0 -214
  113. package/generated/docs/components-slideout-docs.md +0 -538
  114. package/generated/docs/components-slider-docs.md +0 -346
  115. package/generated/docs/components-spinner-docs.md +0 -59
  116. package/generated/docs/components-table-ag-grid-docs.md +0 -1074
  117. package/generated/docs/components-table-docs.md +0 -1305
  118. package/generated/docs/components-tabset-docs.md +0 -341
  119. package/generated/docs/components-tabset-tab-docs.md +0 -86
  120. package/generated/docs/components-tag-docs.md +0 -115
  121. package/generated/docs/components-toaster-toast-docs.md +0 -157
  122. package/generated/docs/components-toggle-docs.md +0 -158
  123. package/generated/docs/contact-us-docs.md +0 -27
  124. package/generated/docs/extensions-editor-docs.md +0 -288
  125. package/generated/docs/extensions-editor-recipes-docs.md +0 -39
  126. package/generated/docs/foundations-introduction-docs.md +0 -17
  127. package/generated/docs/foundations-typography-docs.md +0 -191
  128. package/generated/docs/get-started-develop-docs.md +0 -209
  129. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  130. package/generated/docs/resources-changelog-docs.md +0 -6
  131. package/generated/docs/themes-available-themes-docs.md +0 -66
  132. package/generated/docs/themes-introduction-docs.md +0 -121
  133. package/generated/docs/themes-tokens-docs.md +0 -1200
  134. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,191 +0,0 @@
1
- [](#typography)Typography
2
- =========================
3
-
4
- Typography is set up as part of the theming. Typography is controlled by the `IressText` component and the `iress-u-text` utility class. They implement consistent line heights and font weights.
5
-
6
- Typography styles are designed to be encapsulated. If you want text to pick up the Iress styling, you'll need to wrap it in an `IressText` component.
7
-
8
- [](#body)Body
9
- -------------
10
-
11
- This is the default text variant, and is designed to be clear and easy to read.
12
-
13
- Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
14
-
15
- * Voluptatem assumenda soluta!
16
- * Illum et atque alias possimus maiores rem in corrupti consectetur!
17
- * Dolorum, repellat expedita!
18
-
19
- Hide code
20
-
21
- \[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; }
22
-
23
- <IressText\>
24
- <p\>
25
- Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita. </p\>
26
- <ul\>
27
- <li\>
28
- Voluptatem assumenda soluta! </li\>
29
- <li\>
30
- Illum et atque alias possimus maiores rem in corrupti consectetur! </li\>
31
- <li\>
32
- Dolorum, repellat expedita! </li\>
33
- </ul\>
34
- </IressText\>
35
-
36
- Copy
37
-
38
- [](#headings)Headings
39
- ---------------------
40
-
41
- 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).
42
-
43
- Hello, we are a company that puts clients first.
44
- ================================================
45
-
46
- Hello, we are a company that puts clients first.
47
- ------------------------------------------------
48
-
49
- ### Hello, we are a company that puts clients first.
50
-
51
- #### Hello, we are a company that puts clients first.
52
-
53
- ##### Hello, we are a company that puts clients first.
54
-
55
- An H2 styled as an H3.
56
- ----------------------
57
-
58
- Hide code
59
-
60
- \[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; }
61
-
62
- <IressStack gutter\="md"\>
63
- <IressText element\="h1"\>
64
- Hello, we are a company that puts clients first. </IressText\>
65
- <IressText element\="h2"\>
66
- Hello, we are a company that puts clients first. </IressText\>
67
- <IressText element\="h3"\>
68
- Hello, we are a company that puts clients first. </IressText\>
69
- <IressText element\="h4"\>
70
- Hello, we are a company that puts clients first. </IressText\>
71
- <IressText element\="h5"\>
72
- Hello, we are a company that puts clients first. </IressText\>
73
- <IressText
74
- element\="h2"
75
- variant\="h3"
76
- \>
77
- An H2 styled as an H3. </IressText\>
78
- </IressStack\>
79
-
80
- Copy
81
-
82
- [](#display)Display
83
- -------------------
84
-
85
- Display text is used to draw attention to specific pieces of content, like introductory text on a landing page. It has larger font sizes than the heading variants, and a lighter font weight.
86
-
87
- Hello, we are a company that puts clients first.
88
-
89
- Hello, we are a company that puts clients first.
90
-
91
- Hello, we are a company that puts clients first.
92
-
93
- Hello, we are a company that puts clients first.
94
-
95
- Hide code
96
-
97
- \[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; }
98
-
99
- <IressStack gutter\="md"\>
100
- <IressText variant\="display1"\>
101
- Hello, we are a company that puts clients first. </IressText\>
102
- <IressText variant\="display2"\>
103
- Hello, we are a company that puts clients first. </IressText\>
104
- <IressText variant\="display3"\>
105
- Hello, we are a company that puts clients first. </IressText\>
106
- <IressText variant\="display4"\>
107
- Hello, we are a company that puts clients first. </IressText\>
108
- </IressStack\>
109
-
110
- Copy
111
-
112
- [](#lead)Lead
113
- -------------
114
-
115
- Lead text is used to introduce users to a new section, and often gives a brief summary of a section. It has a larger font size than body text, but a lighter font weight so that it doesn't clash with headings.
116
-
117
- Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
118
-
119
- Hide code
120
-
121
- \[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; }
122
-
123
- <IressText
124
- element\="p"
125
- variant\="lead"
126
- \>
127
- Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
128
- </IressText\>
129
-
130
- Copy
131
-
132
- [](#caption)Caption
133
- -------------------
134
-
135
- The caption variant is used for small text that provides additional information about a table or image. It has a smaller font size than body text, and a lighter font weight.
136
-
137
- Example caption
138
-
139
- Hide code
140
-
141
- \[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; }
142
-
143
- <IressText element\="caption"\>
144
- Example caption
145
- </IressText\>
146
-
147
- Copy
148
-
149
- [](#other-variants)Other variants
150
- ---------------------------------
151
-
152
- IDS also includes bold, italic and small text variants.
153
-
154
- * Bold text should be used to **draw attention** to part of a sentence, or to provide a visual label for readonly text.
155
- * Italic text should be used to add _emphasis_ to content, or to add stress to part of a sentence.
156
- * Small text is used for side comments or for text that's secondary to the main content.
157
- * Muted text is used to de-emphasise content, such as when displaying informative text that is not critical to the user experience.
158
-
159
- Bold text
160
-
161
- Italic text
162
-
163
- Small text
164
-
165
- Muted text
166
-
167
- Hide code
168
-
169
- \[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; }
170
-
171
- <IressStack gutter\="md"\>
172
- <IressText variant\="bold"\>
173
- Bold text </IressText\>
174
- <IressText variant\="italic"\>
175
- Italic text </IressText\>
176
- <IressText variant\="small"\>
177
- Small text </IressText\>
178
- <IressText mode\="muted"\>
179
- Muted text </IressText\>
180
- </IressStack\>
181
-
182
- Copy
183
-
184
- On this page
185
-
186
- * [Body](#body)
187
- * [Headings](#headings)
188
- * [Display](#display)
189
- * [Lead](#lead)
190
- * [Caption](#caption)
191
- * [Other variants](#other-variants)
@@ -1,209 +0,0 @@
1
- [](#develop)Develop
2
- ===================
3
-
4
- Set up your environment to use the latest version of the Iress Design System (IDS). You can use this library to build React applications that align to IDS, and ensure a consistent and modern look and feel across all Iress products.
5
-
6
- [](#requirements)Requirements
7
- -----------------------------
8
-
9
- * [React 17 or later](https://reactjs.org/)
10
- * Access to Iress Artifactory
11
-
12
- [](#set-up-the-component-library)Set up the component library
13
- -------------------------------------------------------------
14
-
15
- 1. Install using the command line:
16
-
17
- \[data-radix-scroll-area-viewport\] {
18
- scrollbar-width: none;
19
- -ms-overflow-style: none;
20
- -webkit-overflow-scrolling: touch;
21
- }
22
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
23
- display: none;
24
- }
25
- :where(\[data-radix-scroll-area-viewport\]) {
26
- display: flex;
27
- flex-direction: column;
28
- align-items: stretch;
29
- }
30
- :where(\[data-radix-scroll-area-content\]) {
31
- flex-grow: 1;
32
- }
33
-
34
- yarn add @iress-oss/ids-components
35
-
36
- Copy
37
-
38
- 2. Import the styles:
39
-
40
- \[data-radix-scroll-area-viewport\] {
41
- scrollbar-width: none;
42
- -ms-overflow-style: none;
43
- -webkit-overflow-scrolling: touch;
44
- }
45
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
46
- display: none;
47
- }
48
- :where(\[data-radix-scroll-area-viewport\]) {
49
- display: flex;
50
- flex-direction: column;
51
- align-items: stretch;
52
- }
53
- :where(\[data-radix-scroll-area-content\]) {
54
- flex-grow: 1;
55
- }
56
-
57
- import '@iress-oss/ids-components/dist/style.css';
58
-
59
- Copy
60
-
61
- 3. Import the components. The provider is optional, but recommended for most applications. It sets up the design system and provides a consistent container for components like modals, slideouts, and toasts.
62
-
63
- \[data-radix-scroll-area-viewport\] {
64
- scrollbar-width: none;
65
- -ms-overflow-style: none;
66
- -webkit-overflow-scrolling: touch;
67
- }
68
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
69
- display: none;
70
- }
71
- :where(\[data-radix-scroll-area-viewport\]) {
72
- display: flex;
73
- flex-direction: column;
74
- align-items: stretch;
75
- }
76
- :where(\[data-radix-scroll-area-content\]) {
77
- flex-grow: 1;
78
- }
79
-
80
- import { IressProvider, IressButton } from '@iress-oss/ids-components';
81
-
82
- Copy
83
-
84
- 4. Use the components:
85
-
86
- \[data-radix-scroll-area-viewport\] {
87
- scrollbar-width: none;
88
- -ms-overflow-style: none;
89
- -webkit-overflow-scrolling: touch;
90
- }
91
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
92
- display: none;
93
- }
94
- :where(\[data-radix-scroll-area-viewport\]) {
95
- display: flex;
96
- flex-direction: column;
97
- align-items: stretch;
98
- }
99
- :where(\[data-radix-scroll-area-content\]) {
100
- flex-grow: 1;
101
- }
102
-
103
- const App \= () \=> (
104
- <IressButton onClick\={() \=> success({ children: 'Toast triggered' })}\>
105
- Trigger toast </IressButton\>
106
- );
107
- ReactDOM.createRoot(document.getElementById('root')!).render(
108
- <IressProvider\>
109
- <App />
110
- </IressProvider\>,
111
- );
112
-
113
- Copy
114
-
115
-
116
- * * *
117
-
118
- [](#set-up-the-theme)Set up the theme
119
- -------------------------------------
120
-
121
- The component library comes with the white label theme by default. You can add a theme by importing the theme file and including it in your application.
122
-
123
- Microfrontends
124
- --------------
125
-
126
- If you are building a React App that is intended to be used as a microfrontend, please skip this step. Microfrontends should inherit the parent application's theme, and not define a theme itself, as it may conflict with other microfrontends in the same parent application.
127
-
128
- 1. Install using the command line:
129
-
130
- \[data-radix-scroll-area-viewport\] {
131
- scrollbar-width: none;
132
- -ms-overflow-style: none;
133
- -webkit-overflow-scrolling: touch;
134
- }
135
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
136
- display: none;
137
- }
138
- :where(\[data-radix-scroll-area-viewport\]) {
139
- display: flex;
140
- flex-direction: column;
141
- align-items: stretch;
142
- }
143
- :where(\[data-radix-scroll-area-content\]) {
144
- flex-grow: 1;
145
- }
146
-
147
- yarn add @iress/ids-themes
148
-
149
- Copy
150
-
151
- 2. Import the component:
152
-
153
- \[data-radix-scroll-area-viewport\] {
154
- scrollbar-width: none;
155
- -ms-overflow-style: none;
156
- -webkit-overflow-scrolling: touch;
157
- }
158
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
159
- display: none;
160
- }
161
- :where(\[data-radix-scroll-area-viewport\]) {
162
- display: flex;
163
- flex-direction: column;
164
- align-items: stretch;
165
- }
166
- :where(\[data-radix-scroll-area-content\]) {
167
- flex-grow: 1;
168
- }
169
-
170
- import { IressTheme } from '@iress-oss/ids-components';
171
-
172
- Copy
173
-
174
- 3. Add the component to your application:
175
-
176
- \[data-radix-scroll-area-viewport\] {
177
- scrollbar-width: none;
178
- -ms-overflow-style: none;
179
- -webkit-overflow-scrolling: touch;
180
- }
181
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
182
- display: none;
183
- }
184
- :where(\[data-radix-scroll-area-viewport\]) {
185
- display: flex;
186
- flex-direction: column;
187
- align-items: stretch;
188
- }
189
- :where(\[data-radix-scroll-area-content\]) {
190
- flex-grow: 1;
191
- }
192
-
193
- ReactDOM.createRoot(document.getElementById('root')!).render(
194
- <IressProvider\>
195
- <IressTheme />
196
- <App />
197
- </IressProvider\>,
198
- );
199
-
200
- Copy
201
-
202
-
203
- For alternative ways to import the theme, see the [Themes documentation](./?path=/docs/themes-introduction--docs).
204
-
205
- On this page
206
-
207
- * [Requirements](#requirements)
208
- * [Set up the component library](#set-up-the-component-library)
209
- * [Set up the theme](#set-up-the-theme)
@@ -1,68 +0,0 @@
1
- [](#using-storybook)Using Storybook
2
- ===================================
3
-
4
- The IDS team uses Storybook to develop and document our components. Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively develop and test components. It is most likely what you are looking at right now.
5
-
6
- Here we have just highlighted a few of our top tips on how you can use Storybook more efficiently. We have separated it by different stages of the product delivery cycle, but you can use these tips at any stage.
7
-
8
- * * *
9
-
10
- [](#first-time-users)First-time users
11
- -------------------------------------
12
-
13
- When you first come to the IDS Storybook, you may notice the pages look un-styled. This is the default theme of IDS. You can change the theme to the theme you normally use in your product by clicking the `brush` icon in the top left, right above this page.
14
-
15
- You can also change to use the dark theme of Storybook itself by clicking the `moon` icon in the top left, right above this page.
16
-
17
- These settings are saved so the next time you come back to Storybook, it will remember your preferences.
18
-
19
- [](#scoping-work)Scoping work
20
- -----------------------------
21
-
22
- If you are scoping work, you can use Storybook to see what components are available to you. You can also see how they are used and what states they can be in. This can help you to understand what is possible and what is not.
23
-
24
- Every IDS component has a `Docs` page and a `Guidelines` (coming soon) page. The `Docs` page will show you how to use the component and what props it accepts, helping you understand what is available, and how each property behaves to allow you to understand the final user experience of your feature.
25
-
26
- The `Guidelines` page will show you how to use the component in a way that is consistent with other Iress applications. It covers things like accessibility, usability, and design principles, as well as which scenario to use which component and common pitfalls.
27
-
28
- [](#design)Design
29
- -----------------
30
-
31
- When designing a new feature, you can use Storybook to see how your designs will look and behave in a real application.
32
-
33
- `Docs` and `Guidelines` (coming soon) pages will help you understand how to use the components and what is possible, and help you align to any design decisions made previously.
34
-
35
- `Examples` are a good way to see how variations of a component look and behave. You can see how a component looks in different states, and how it behaves with different props. If there is a variation that is not shown in the `Examples`, you can use the `Controls` tab to change the props of the component to see how it behaves with different values. You can also toggle how each component looks at different breakpoints (screen sizes/devices), how they look to users with certain eyesight conditions, and how they look in different states.
36
-
37
- Storybook is a starting point for your designs. It is the language developers will be using as they convert your designs into live user experiences. However, not everything is covered here. It is good to discuss your designs with developers to understand what is possible and what is not.
38
-
39
- [](#development)Development
40
- ---------------------------
41
-
42
- During development, you can refer to Storybook for code examples and understand the API available to you.
43
-
44
- If you are using Typescript, majority of the API is available in your IDE. However, Storybook provides more than just the API. It provides examples of how to use and combine the properties, as well as which components were designed to work with each other.
45
-
46
- `Docs` covers the API of the component, and also discusses `Examples` in detail. Code examples are shown here as well.
47
-
48
- `Examples` in the sidebar actually allow you to toggle the props in the `Controls` tab to see how combinations look and behave. The `Actions` tab will show you what events are being emitted by the component, and the `Accessibility` tab will show you whether the combination of props is accessible or not in this component. You can also toggle how each component looks at different breakpoints (screen sizes/devices), how they look to users with certain eyesight conditions, and how they look in different states.
49
-
50
- IDS is a starting point for your application development. It provides the foundations to make your application look and behave in a consistent way to other Iress products. However, not everything is covered here. It is good to discuss with designers and other developers to understand any constraints or guidelines that are not covered by IDS.
51
-
52
- * * *
53
-
54
- [](#common-issues)Common issues
55
- -------------------------------
56
-
57
- ### [](#i-cant-find-the-controls-actions-or-accessibility-tab)I can't find the `Controls`, `Actions` or `Accessibility` tab
58
-
59
- These tabs are only shown in the `Examples` area of the component. Some tabs are not applicable to some components. If you click on an example and still cannot see it, you may need to toggle the orientation of the addon. You can do this by tapping the `d` key twice, or using the settings as shown in the video.
60
-
61
- On this page
62
-
63
- * [First-time users](#first-time-users)
64
- * [Scoping work](#scoping-work)
65
- * [Design](#design)
66
- * [Development](#development)
67
- * [Common issues](#common-issues)
68
- * [I can't find the Controls, Actions or Accessibility tab](#i-cant-find-the-controls-actions-or-accessibility-tab)
@@ -1,6 +0,0 @@
1
- [](#changelog)Changelog
2
- =======================
3
-
4
- To view the changelog, you can check the Iress repository.
5
-
6
- On this page
@@ -1,66 +0,0 @@
1
- [](#available-themes)Available themes
2
- =====================================
3
-
4
- These are the available themes you can apply to Iress products. If you are using the component library, these themes will automatically style the components to match the theme.
5
-
6
- [](#versions)Versions
7
- ---------------------
8
-
9
- Themes are no longer connected to the version of IDS you are using. Instead they will support a range of IDS versions.
10
-
11
- | `@iress/ids-themes` | `@iress-oss/ids-components` |
12
- | --- | --- |
13
- | 5.x | 5.x |
14
- | 4.x | 3.x - 4.x |
15
- | 3.x | 3.x - 4.x |
16
-
17
- [](#list)List
18
- -------------
19
-
20
- Version: 5.5.0-29845
21
-
22
- * * *
23
-
24
- 5.5.0-29845Latest5.4.8-262445.4.7-261205.4.6-260525.4.5-260275.4.4-260225.4.3-259955.4.2-259585.4.1-259415.4.0-294265.3.2-290865.3.1-29028
25
-
26
- None selected
27
-
28
- Latest build only
29
-
30
- * * *
31
-
32
- ### Version: 5.5.0-29845
33
-
34
- * [css/demo-theme-1--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-1--touch.css)
35
- * [css/demo-theme-1.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-1.css)
36
- * [css/demo-theme-2--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-2--touch.css)
37
- * [css/demo-theme-2.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-2.css)
38
- * [css/demo-theme-3--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-3--touch.css)
39
- * [css/demo-theme-3.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-3.css)
40
- * [css/demo-theme-4--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-4--touch.css)
41
- * [css/demo-theme-4.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-4.css)
42
- * [css/demo-theme-5--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-5--touch.css)
43
- * [css/demo-theme-5.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-5.css)
44
- * [css/demo-theme-6--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-6--touch.css)
45
- * [css/demo-theme-6.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/demo-theme-6.css)
46
- * [css/hostplus-theme-light--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/hostplus-theme-light--touch.css)
47
- * [css/hostplus-theme-light.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/hostplus-theme-light.css)
48
- * [css/iress-beta-theme-dark--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-beta-theme-dark--touch.css)
49
- * [css/iress-beta-theme-dark.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-beta-theme-dark.css)
50
- * [css/iress-beta-theme-light--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-beta-theme-light--touch.css)
51
- * [css/iress-beta-theme-light.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-beta-theme-light.css)
52
- * [css/iress-theme-dark--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-theme-dark--touch.css)
53
- * [css/iress-theme-dark.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-theme-dark.css)
54
- * [css/iress-theme-light--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-theme-light--touch.css)
55
- * [css/iress-theme-light.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-theme-light.css)
56
- * [css/iress-theme-wealth--touch.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-theme-wealth--touch.css)
57
- * [css/iress-theme-wealth.css](https://cdn-staging.iress.com/ids/5.5.0-29845/themes/css/iress-theme-wealth.css)
58
-
59
- #### Theme mappings
60
-
61
- * [ag-theme-iress-lite.css](https://cdn-staging.iress.com/ids/5.5.0-29845/ag-theme-iress-lite.css)
62
-
63
- On this page
64
-
65
- * [Versions](#versions)
66
- * [List](#list)
@@ -1,121 +0,0 @@
1
- [](#themes)Themes
2
- =================
3
-
4
- The Iress Design System is designed to be white-labelled, allowing you to change the look and feel of the components to match your brand. This is done by using a theme.
5
-
6
- * * *
7
-
8
- Beta
9
-
10
- New component
11
-
12
- This component is new, please provide feedback to the IDS team if you encounter any issues.
13
-
14
- [](#what-are-themes)What are themes?
15
- ------------------------------------
16
-
17
- Themes are a collection of [design tokens](./?path=/docs/themes-tokens--docs) that are used to style the components to match a certain brand. These tokens are used to define the colours, typography, spacing, and other styles of the components.
18
-
19
- You can see the current themes available by using the theme switcher in the top left corner of this page.
20
-
21
- [](#using-a-theme)Using a theme
22
- -------------------------------
23
-
24
- To start using a theme in your own application, you can use the `IressTheme` component from the `@iress/ids-themes` package. This component takes the name of a theme and imports the theme CSS (via the Iress CDN) to display the components in that theme.
25
-
26
- \[data-radix-scroll-area-viewport\] {
27
- scrollbar-width: none;
28
- -ms-overflow-style: none;
29
- -webkit-overflow-scrolling: touch;
30
- }
31
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
32
- display: none;
33
- }
34
- :where(\[data-radix-scroll-area-viewport\]) {
35
- display: flex;
36
- flex-direction: column;
37
- align-items: stretch;
38
- }
39
- :where(\[data-radix-scroll-area-content\]) {
40
- flex-grow: 1;
41
- }
42
-
43
- import { IressTheme } from '@iress/ids-themes';
44
- <IressTheme name\="iress-beta-theme-light" />;
45
-
46
- Copy
47
-
48
- If you cannot use the Iress CDN, you can also use the dynamic `IressThemeImport` component to import the theme CSS from your dependencies. It will import the theme CSS from the `@iress/ids-themes` package.
49
-
50
- **Note:** This component dynamically injects CSS into the document, and may throw errors in your tests. Please see the [Testing](#testing) section for more information.
51
-
52
- \[data-radix-scroll-area-viewport\] {
53
- scrollbar-width: none;
54
- -ms-overflow-style: none;
55
- -webkit-overflow-scrolling: touch;
56
- }
57
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
58
- display: none;
59
- }
60
- :where(\[data-radix-scroll-area-viewport\]) {
61
- display: flex;
62
- flex-direction: column;
63
- align-items: stretch;
64
- }
65
- :where(\[data-radix-scroll-area-content\]) {
66
- flex-grow: 1;
67
- }
68
-
69
- import { IressThemeImport } from '@iress/ids-themes';
70
- <IressThemeImport
71
- name\="iress-beta-theme-light"
72
- fallback\={<IressSpinner screenReaderText\="Loading theme..." />}
73
- \>
74
- <App />
75
- </IressThemeImport\>;
76
-
77
- Copy
78
-
79
- [](#testing)Testing
80
- -------------------
81
-
82
- Due to the CSS being loaded dynamically, you will need to set up your test configuration to handle the dynamic CSS loading.
83
-
84
- ### [](#vitest)Vitest
85
-
86
- This will force the CSS from the `@iress/ids-themes` package to be loaded inline in the test environment.
87
-
88
- \[data-radix-scroll-area-viewport\] {
89
- scrollbar-width: none;
90
- -ms-overflow-style: none;
91
- -webkit-overflow-scrolling: touch;
92
- }
93
- \[data-radix-scroll-area-viewport\]::-webkit-scrollbar {
94
- display: none;
95
- }
96
- :where(\[data-radix-scroll-area-viewport\]) {
97
- display: flex;
98
- flex-direction: column;
99
- align-items: stretch;
100
- }
101
- :where(\[data-radix-scroll-area-content\]) {
102
- flex-grow: 1;
103
- }
104
-
105
- test: {
106
- // the rest of your Vitest configuration here
107
- server: {
108
- deps: {
109
- inline: \['@iress/ids-themes'\],
110
- },
111
- },
112
- },
113
-
114
- Copy
115
-
116
- On this page
117
-
118
- * [What are themes?](#what-are-themes)
119
- * [Using a theme](#using-a-theme)
120
- * [Testing](#testing)
121
- * [Vitest](#vitest)