@iress-oss/ids-mcp-server 6.0.0-alpha.0 → 6.0.0-alpha.1

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 (105) hide show
  1. package/package.json +30 -29
  2. package/generated/docs/components-alert-docs.md +0 -702
  3. package/generated/docs/components-autocomplete-docs.md +0 -1433
  4. package/generated/docs/components-autocomplete-recipes-docs.md +0 -104
  5. package/generated/docs/components-badge-docs.md +0 -531
  6. package/generated/docs/components-button-docs.md +0 -1442
  7. package/generated/docs/components-buttongroup-docs.md +0 -748
  8. package/generated/docs/components-card-docs.md +0 -944
  9. package/generated/docs/components-checkbox-docs.md +0 -694
  10. package/generated/docs/components-checkboxgroup-docs.md +0 -1087
  11. package/generated/docs/components-checkboxgroup-recipes-docs.md +0 -119
  12. package/generated/docs/components-col-docs.md +0 -881
  13. package/generated/docs/components-container-docs.md +0 -123
  14. package/generated/docs/components-divider-docs.md +0 -576
  15. package/generated/docs/components-expander-docs.md +0 -594
  16. package/generated/docs/components-field-docs.md +0 -2007
  17. package/generated/docs/components-filter-docs.md +0 -1322
  18. package/generated/docs/components-hide-docs.md +0 -702
  19. package/generated/docs/components-icon-docs.md +0 -816
  20. package/generated/docs/components-image-docs.md +0 -493
  21. package/generated/docs/components-inline-docs.md +0 -2003
  22. package/generated/docs/components-input-docs.md +0 -867
  23. package/generated/docs/components-input-recipes-docs.md +0 -140
  24. package/generated/docs/components-inputcurrency-docs.md +0 -689
  25. package/generated/docs/components-inputcurrency-recipes-docs.md +0 -115
  26. package/generated/docs/components-introduction-docs.md +0 -450
  27. package/generated/docs/components-label-docs.md +0 -562
  28. package/generated/docs/components-link-docs.md +0 -586
  29. package/generated/docs/components-menu-docs.md +0 -1146
  30. package/generated/docs/components-menu-menuitem-docs.md +0 -739
  31. package/generated/docs/components-modal-docs.md +0 -1346
  32. package/generated/docs/components-panel-docs.md +0 -600
  33. package/generated/docs/components-placeholder-docs.md +0 -446
  34. package/generated/docs/components-popover-docs.md +0 -1529
  35. package/generated/docs/components-popover-recipes-docs.md +0 -211
  36. package/generated/docs/components-progress-docs.md +0 -568
  37. package/generated/docs/components-provider-docs.md +0 -160
  38. package/generated/docs/components-radio-docs.md +0 -563
  39. package/generated/docs/components-radiogroup-docs.md +0 -1153
  40. package/generated/docs/components-readonly-docs.md +0 -535
  41. package/generated/docs/components-richselect-docs.md +0 -5836
  42. package/generated/docs/components-row-docs.md +0 -2354
  43. package/generated/docs/components-select-docs.md +0 -940
  44. package/generated/docs/components-skeleton-docs.md +0 -597
  45. package/generated/docs/components-skeleton-recipes-docs.md +0 -76
  46. package/generated/docs/components-skiplink-docs.md +0 -587
  47. package/generated/docs/components-slideout-docs.md +0 -1036
  48. package/generated/docs/components-slider-docs.md +0 -828
  49. package/generated/docs/components-spinner-docs.md +0 -450
  50. package/generated/docs/components-stack-docs.md +0 -923
  51. package/generated/docs/components-table-ag-grid-docs.md +0 -1444
  52. package/generated/docs/components-table-docs.md +0 -2327
  53. package/generated/docs/components-tabset-docs.md +0 -768
  54. package/generated/docs/components-tabset-tab-docs.md +0 -550
  55. package/generated/docs/components-tag-docs.md +0 -548
  56. package/generated/docs/components-text-docs.md +0 -585
  57. package/generated/docs/components-toaster-docs.md +0 -755
  58. package/generated/docs/components-toggle-docs.md +0 -614
  59. package/generated/docs/components-tooltip-docs.md +0 -747
  60. package/generated/docs/components-validationmessage-docs.md +0 -1161
  61. package/generated/docs/contact-us-docs.md +0 -27
  62. package/generated/docs/extensions-editor-docs.md +0 -1181
  63. package/generated/docs/extensions-editor-recipes-docs.md +0 -89
  64. package/generated/docs/foundations-accessibility-docs.md +0 -40
  65. package/generated/docs/foundations-consistency-docs.md +0 -52
  66. package/generated/docs/foundations-content-docs.md +0 -23
  67. package/generated/docs/foundations-grid-docs.md +0 -74
  68. package/generated/docs/foundations-introduction-docs.md +0 -19
  69. package/generated/docs/foundations-principles-docs.md +0 -70
  70. package/generated/docs/foundations-responsive-breakpoints-docs.md +0 -193
  71. package/generated/docs/foundations-tokens-colour-docs.md +0 -564
  72. package/generated/docs/foundations-tokens-elevation-docs.md +0 -155
  73. package/generated/docs/foundations-tokens-introduction-docs.md +0 -190
  74. package/generated/docs/foundations-tokens-radius-docs.md +0 -71
  75. package/generated/docs/foundations-tokens-spacing-docs.md +0 -89
  76. package/generated/docs/foundations-tokens-typography-docs.md +0 -322
  77. package/generated/docs/foundations-user-experience-docs.md +0 -63
  78. package/generated/docs/foundations-visual-design-docs.md +0 -46
  79. package/generated/docs/foundations-z-index-stacking-docs.md +0 -31
  80. package/generated/docs/frequently-asked-questions-docs.md +0 -53
  81. package/generated/docs/get-started-develop-docs.md +0 -209
  82. package/generated/docs/get-started-using-storybook-docs.md +0 -68
  83. package/generated/docs/guidelines.md +0 -2054
  84. package/generated/docs/introduction-docs.md +0 -87
  85. package/generated/docs/news-version-6-docs.md +0 -93
  86. package/generated/docs/patterns-form-docs.md +0 -3902
  87. package/generated/docs/patterns-form-recipes-docs.md +0 -1370
  88. package/generated/docs/patterns-introduction-docs.md +0 -24
  89. package/generated/docs/patterns-loading-docs.md +0 -4043
  90. package/generated/docs/resources-code-katas-docs.md +0 -29
  91. package/generated/docs/resources-introduction-docs.md +0 -38
  92. package/generated/docs/resources-mcp-server-docs.md +0 -27
  93. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  94. package/generated/docs/styling-props-colour-docs.md +0 -172
  95. package/generated/docs/styling-props-elevation-docs.md +0 -88
  96. package/generated/docs/styling-props-radius-docs.md +0 -86
  97. package/generated/docs/styling-props-reference-docs.md +0 -160
  98. package/generated/docs/styling-props-screen-readers-docs.md +0 -71
  99. package/generated/docs/styling-props-sizing-docs.md +0 -627
  100. package/generated/docs/styling-props-spacing-docs.md +0 -2282
  101. package/generated/docs/styling-props-typography-docs.md +0 -121
  102. package/generated/docs/themes-available-themes-docs.md +0 -66
  103. package/generated/docs/themes-introduction-docs.md +0 -121
  104. package/generated/docs/versions-docs.md +0 -17
  105. /package/{LICENSE.txt → LICENSE} +0 -0
@@ -1,121 +0,0 @@
1
- [](#typography)Typography
2
- =========================
3
-
4
- These are all styling props related to changing the typography of a component.
5
-
6
- [](#textstyle)`textStyle`
7
- -------------------------
8
-
9
- The `textStyle` prop allows you to change the default text style of a component. For more control and nested element styling, it is recommended to use `IressText` instead.
10
-
11
- A panel with large text
12
-
13
- Hide code
14
-
15
- \[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; }
16
-
17
- <IressPanel
18
- bg\="alt"
19
- textStyle\="typography.body.lg"
20
- \>
21
- A panel with large text
22
- </IressPanel\>
23
-
24
- Copy
25
-
26
- #### [](#textStyle-props)Props
27
-
28
- | Name | Description | Default | Control |
29
- | --- | --- | --- | --- |
30
- | textAlign |
31
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
32
-
33
- | Chrome | Firefox | Safari | Edge | IE |
34
- | --- | --- | --- | --- | --- |
35
- | **1** | **1** | **1** | **12** | **3** |
36
-
37
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
38
-
39
- | \- | Set object |
40
- | textStyle |
41
-
42
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
43
-
44
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
45
- * `typography.body.md` - The most commonly used body text size, used for most text content in the product and the default state of all components in the design system.
46
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
47
- * `typography.heading.1` - Use for the main page title to establish a clear hierarchy. There is typically only one H1 per screen, emphasising the primary purpose or context of the page.
48
- * `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.
49
- * `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.
50
- * `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.
51
- * `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.
52
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
53
-
54
- ResponsiveProp<"typography.heading.1" | "typography.heading.2" | "typography.heading.3" | "typography.heading.4" | "typography.heading.5" | "typography.body.sm" | "typography.body.sm.regular" | ... 10 more ... | "typography.code"> | undefined
55
-
56
- | \- |
57
-
58
- "typography.body.lg"
59
-
60
- |
61
-
62
- [](#textalign)`textAlign`
63
- -------------------------
64
-
65
- The `textAlign` prop allows you to change the alignment of text inside a component. For more control, it is recommended to use `IressText` instead.
66
-
67
- A panel with centered text
68
-
69
- Hide code
70
-
71
- \[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; }
72
-
73
- <IressPanel
74
- bg\="alt"
75
- textAlign\="center"
76
- \>
77
- A panel with centered text
78
- </IressPanel\>
79
-
80
- Copy
81
-
82
- #### [](#textAlign-props)Props
83
-
84
- | Name | Description | Default | Control |
85
- | --- | --- | --- | --- |
86
- | textAlign |
87
- The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
88
-
89
- | Chrome | Firefox | Safari | Edge | IE |
90
- | --- | --- | --- | --- | --- |
91
- | **1** | **1** | **1** | **12** | **3** |
92
-
93
- ResponsiveProp<"center" | "left" | "right" | "inherit" | "justify"> | undefined
94
-
95
- | \- |
96
-
97
- "center"
98
-
99
- |
100
- | textStyle |
101
-
102
- Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
103
-
104
- * `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
105
- * `typography.body.md` - The most commonly used body text size, used for most text content in the product and the default state of all components in the design system.
106
- * `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
107
- * `typography.heading.1` - Use for the main page title to establish a clear hierarchy. There is typically only one H1 per screen, emphasising the primary purpose or context of the page.
108
- * `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.
109
- * `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.
110
- * `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.
111
- * `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.
112
- * `typography.code` - Used to display code snippets in the product, such as in the API documentation.
113
-
114
- ResponsiveProp<"typography.heading.1" | "typography.heading.2" | "typography.heading.3" | "typography.heading.4" | "typography.heading.5" | "typography.body.sm" | "typography.body.sm.regular" | ... 10 more ... | "typography.code"> | undefined
115
-
116
- | \- | Set object |
117
-
118
- On this page
119
-
120
- * [textStyle](#textstyle)
121
- * [textAlign](#textalign)
@@ -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-30735
21
-
22
- * * *
23
-
24
- 5.5.0-30735Latest5.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-30735
33
-
34
- * [css/demo-theme-1--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-1--touch.css)
35
- * [css/demo-theme-1.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-1.css)
36
- * [css/demo-theme-2--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-2--touch.css)
37
- * [css/demo-theme-2.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-2.css)
38
- * [css/demo-theme-3--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-3--touch.css)
39
- * [css/demo-theme-3.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-3.css)
40
- * [css/demo-theme-4--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-4--touch.css)
41
- * [css/demo-theme-4.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-4.css)
42
- * [css/demo-theme-5--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-5--touch.css)
43
- * [css/demo-theme-5.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-5.css)
44
- * [css/demo-theme-6--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-6--touch.css)
45
- * [css/demo-theme-6.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/demo-theme-6.css)
46
- * [css/hostplus-theme-light--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/hostplus-theme-light--touch.css)
47
- * [css/hostplus-theme-light.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/hostplus-theme-light.css)
48
- * [css/iress-beta-theme-dark--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-beta-theme-dark--touch.css)
49
- * [css/iress-beta-theme-dark.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-beta-theme-dark.css)
50
- * [css/iress-beta-theme-light--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-beta-theme-light--touch.css)
51
- * [css/iress-beta-theme-light.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-beta-theme-light.css)
52
- * [css/iress-theme-dark--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-theme-dark--touch.css)
53
- * [css/iress-theme-dark.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-theme-dark.css)
54
- * [css/iress-theme-light--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-theme-light--touch.css)
55
- * [css/iress-theme-light.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-theme-light.css)
56
- * [css/iress-theme-wealth--touch.css](https://cdn-staging.iress.com/ids/5.5.0-30735/themes/css/iress-theme-wealth--touch.css)
57
- * [css/iress-theme-wealth.css](https://cdn-staging.iress.com/ids/5.5.0-30735/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-30735/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)
@@ -1,17 +0,0 @@
1
- [](#versions)Versions
2
- =====================
3
-
4
- Version 5 is the latest release of the library and recommended for new development.
5
-
6
- [](#list)List
7
- -------------
8
-
9
- | Version | Links |
10
- | --- | --- |
11
- | v5 | [Documentation](https://design.wm.iress.com) |
12
- | v4 | [Documentation](https://archive.design.aws-wmcore-production-au.iress.online/index.html) |
13
- | OneUI | No longer available |
14
-
15
- On this page
16
-
17
- * [List](#list)
File without changes