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

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 (104) hide show
  1. package/generated/docs/components-alert-docs.md +579 -7
  2. package/generated/docs/components-autocomplete-docs.md +694 -15
  3. package/generated/docs/components-autocomplete-recipes-docs.md +1 -1
  4. package/generated/docs/components-badge-docs.md +442 -59
  5. package/generated/docs/components-button-docs.md +1150 -70
  6. package/generated/docs/components-buttongroup-docs.md +441 -3
  7. package/generated/docs/components-card-docs.md +487 -37
  8. package/generated/docs/components-checkbox-docs.md +506 -5
  9. package/generated/docs/components-checkboxgroup-docs.md +586 -191
  10. package/generated/docs/components-checkboxgroup-recipes-docs.md +3 -3
  11. package/generated/docs/components-col-docs.md +451 -36
  12. package/generated/docs/components-container-docs.md +32 -0
  13. package/generated/docs/components-divider-docs.md +427 -27
  14. package/generated/docs/components-expander-docs.md +487 -108
  15. package/generated/docs/components-field-docs.md +1400 -68
  16. package/generated/docs/components-filter-docs.md +268 -55
  17. package/generated/docs/components-hide-docs.md +447 -10
  18. package/generated/docs/components-icon-docs.md +522 -259
  19. package/generated/docs/components-image-docs.md +493 -0
  20. package/generated/docs/components-inline-docs.md +1179 -44
  21. package/generated/docs/components-input-docs.md +544 -12
  22. package/generated/docs/components-input-recipes-docs.md +4 -4
  23. package/generated/docs/components-inputcurrency-docs.md +532 -0
  24. package/generated/docs/components-inputcurrency-recipes-docs.md +4 -5
  25. package/generated/docs/components-introduction-docs.md +450 -0
  26. package/generated/docs/components-label-docs.md +454 -27
  27. package/generated/docs/components-link-docs.md +586 -0
  28. package/generated/docs/components-menu-docs.md +531 -89
  29. package/generated/docs/components-menu-menuitem-docs.md +556 -10
  30. package/generated/docs/components-modal-docs.md +814 -55
  31. package/generated/docs/components-panel-docs.md +418 -198
  32. package/generated/docs/components-placeholder-docs.md +420 -1
  33. package/generated/docs/components-popover-docs.md +1097 -32
  34. package/generated/docs/components-popover-recipes-docs.md +39 -73
  35. package/generated/docs/components-progress-docs.md +464 -0
  36. package/generated/docs/components-provider-docs.md +57 -2
  37. package/generated/docs/components-radio-docs.md +460 -4
  38. package/generated/docs/components-radiogroup-docs.md +586 -116
  39. package/generated/docs/components-readonly-docs.md +450 -4
  40. package/generated/docs/components-richselect-docs.md +4660 -1257
  41. package/generated/docs/components-row-docs.md +2065 -588
  42. package/generated/docs/components-select-docs.md +489 -5
  43. package/generated/docs/components-skeleton-docs.md +399 -16
  44. package/generated/docs/components-skeleton-recipes-docs.md +7 -7
  45. package/generated/docs/components-skiplink-docs.md +548 -27
  46. package/generated/docs/components-slideout-docs.md +648 -150
  47. package/generated/docs/components-slider-docs.md +515 -33
  48. package/generated/docs/components-spinner-docs.md +393 -2
  49. package/generated/docs/components-stack-docs.md +732 -74
  50. package/generated/docs/components-table-ag-grid-docs.md +497 -127
  51. package/generated/docs/components-table-docs.md +1049 -27
  52. package/generated/docs/components-tabset-docs.md +454 -27
  53. package/generated/docs/components-tabset-tab-docs.md +464 -0
  54. package/generated/docs/components-tag-docs.md +452 -19
  55. package/generated/docs/components-text-docs.md +322 -131
  56. package/generated/docs/components-toaster-docs.md +463 -53
  57. package/generated/docs/components-toggle-docs.md +476 -20
  58. package/generated/docs/components-tooltip-docs.md +443 -7
  59. package/generated/docs/components-validationmessage-docs.md +933 -13
  60. package/generated/docs/extensions-editor-docs.md +906 -13
  61. package/generated/docs/extensions-editor-recipes-docs.md +51 -1
  62. package/generated/docs/foundations-accessibility-docs.md +1 -23
  63. package/generated/docs/foundations-grid-docs.md +74 -0
  64. package/generated/docs/foundations-introduction-docs.md +6 -4
  65. package/generated/docs/foundations-responsive-breakpoints-docs.md +193 -0
  66. package/generated/docs/foundations-tokens-colour-docs.md +564 -0
  67. package/generated/docs/foundations-tokens-elevation-docs.md +155 -0
  68. package/generated/docs/foundations-tokens-introduction-docs.md +190 -0
  69. package/generated/docs/foundations-tokens-radius-docs.md +71 -0
  70. package/generated/docs/foundations-tokens-spacing-docs.md +89 -0
  71. package/generated/docs/foundations-tokens-typography-docs.md +322 -0
  72. package/generated/docs/foundations-z-index-stacking-docs.md +31 -0
  73. package/generated/docs/guidelines.md +1537 -295
  74. package/generated/docs/introduction-docs.md +65 -21
  75. package/generated/docs/news-version-6-docs.md +93 -0
  76. package/generated/docs/patterns-form-docs.md +3902 -0
  77. package/generated/docs/patterns-form-recipes-docs.md +1370 -0
  78. package/generated/docs/patterns-introduction-docs.md +24 -0
  79. package/generated/docs/patterns-loading-docs.md +2940 -201
  80. package/generated/docs/resources-introduction-docs.md +38 -0
  81. package/generated/docs/resources-mcp-server-docs.md +27 -0
  82. package/generated/docs/styling-props-colour-docs.md +172 -0
  83. package/generated/docs/styling-props-elevation-docs.md +88 -0
  84. package/generated/docs/styling-props-radius-docs.md +86 -0
  85. package/generated/docs/styling-props-reference-docs.md +160 -0
  86. package/generated/docs/styling-props-screen-readers-docs.md +71 -0
  87. package/generated/docs/styling-props-sizing-docs.md +627 -0
  88. package/generated/docs/styling-props-spacing-docs.md +2282 -0
  89. package/generated/docs/styling-props-typography-docs.md +121 -0
  90. package/generated/docs/themes-available-themes-docs.md +29 -29
  91. package/generated/docs/themes-introduction-docs.md +1 -1
  92. package/package.json +3 -22
  93. package/generated/docs/components-button-recipes-docs.md +0 -76
  94. package/generated/docs/components-card-recipes-docs.md +0 -89
  95. package/generated/docs/components-combobox-docs.md +0 -1016
  96. package/generated/docs/components-form-docs.md +0 -2410
  97. package/generated/docs/components-form-recipes-docs.md +0 -886
  98. package/generated/docs/components-navbar-docs.md +0 -291
  99. package/generated/docs/components-navbar-recipes-docs.md +0 -413
  100. package/generated/docs/components-toaster-toast-docs.md +0 -157
  101. package/generated/docs/foundations-colours-docs.md +0 -257
  102. package/generated/docs/foundations-typography-docs.md +0 -191
  103. package/generated/docs/resources-changelog-docs.md +0 -6
  104. package/generated/docs/themes-tokens-docs.md +0 -1200
@@ -1,43 +1,87 @@
1
- [](#iress-design-system)Iress Design System
2
- ===========================================
1
+ Iress Design System
2
+ ===================
3
3
 
4
- 5.15.0
4
+ 6.0.0-alpha.0
5
+
6
+ The Iress Design System (IDS) serves as a shared visual language, working code, design tools and resources, human interface guidelines, and a community. It supports designers and developers building digital products for both B2B (Financial Advisors, Paraplanners) and B2B2C (client customers) segments.
7
+
8
+ [Start developing](/?path=/docs/get-started-develop--docs)[Read foundations](/?path=/docs/foundations-introduction--docs)
5
9
 
6
10
  * * *
7
11
 
8
- The Iress Design System (IDS) serves as a shared visual language, working code, design tools and resources, human interface guidelines, and a community of contributors. It supports designers and developers building digital products for both B2B (Financial Advisors, Paraplanners) and B2B2C (client customers) segments.
12
+ Quick links
13
+ -----------
14
+
15
+ [
16
+
17
+ Version 6
18
+ ---------
19
+
20
+ Start developing with the latest version of the Iress Design System. Version 6 has had a complete styling overhaul to keep IDS modern.
21
+
22
+ ](https://docs.google.com/document/d/17K81rHBZjjF_tsrC8QFrSsmjrC0IJu_bpU4sB2N7PSQ/edit?usp=sharing)
23
+
24
+ [
25
+
26
+ Foundations
27
+ -----------
28
+
29
+ Core design principles, colors, typography, spacing, and visual guidelines that form the foundation of our design system.
30
+
31
+ ](/?path=/docs/foundations-introduction--docs)
32
+
33
+ [
9
34
 
10
- [](#whats-new)What's new?
11
- -------------------------
35
+ Components
36
+ ----------
37
+
38
+ Pre-built UI components like buttons, forms, tables, and navigation elements ready to use in your applications.
39
+
40
+ ](/?path=/docs/components-introduction--docs)
41
+
42
+ [
43
+
44
+ Design Tokens
45
+ -------------
46
+
47
+ Shared design values for colors, spacing, typography, and other visual properties that ensure consistency across products.
48
+
49
+ ](/?path=/docs/foundations-tokens-introduction--docs)
50
+
51
+ [
12
52
 
13
53
  Patterns
14
54
  --------
15
55
 
16
- IDS has released our first pattern, `IressLoading`, allowing you to display loading feedback to users consistently across different applications no matter the scenario.
56
+ Common UI patterns and layouts for forms and complex interations.
57
+
58
+ ](/?path=/docs/patterns-introduction--docs)
17
59
 
18
- It is available as of `5.10.0`.
60
+ [
61
+
62
+ Styling props
63
+ -------------
19
64
 
20
- [Learn more](/?path=/docs/patterns-loading--docs)
65
+ Safely customise any component in the design system using styling props to create engaging UIs.
21
66
 
22
- Theme components
23
- ----------------
67
+ ](/?path=/docs/styling-props-reference--docs)
24
68
 
25
- You can now use `IressTheme` from the `@iress/ids-themes` package to quickly add a theme to your application. No more messing around with CDN urls, now you just need the name of the theme and you are good to go.
69
+ [
26
70
 
27
- [Learn more](/?path=/docs/themes-introduction--docs)
71
+ Themes
72
+ ------
28
73
 
29
- [](#ready-to-dive-in)Ready to dive in?
30
- --------------------------------------
74
+ IDS is white-labelled, allowing you to create custom themes tailored to your client's identity.
31
75
 
32
- Start shipping faster with IDS.
76
+ ](/?path=/docs/themes-introduction--docs)
33
77
 
34
78
  [
35
79
 
36
- Get started
80
+ Resources
81
+ ---------
37
82
 
38
- ](/?path=/docs/get-started-develop--docs)
83
+ MCP server and other tools to help you make the most of the Iress Design System.
39
84
 
40
- On this page
85
+ ](/?path=/docs/resources-introduction--docs)
41
86
 
42
- * [What's new?](#whats-new)
43
- * [Ready to dive in?](#ready-to-dive-in)
87
+ On this page
@@ -0,0 +1,93 @@
1
+ [](#version-6)Version 6
2
+ =======================
3
+
4
+ Version 6 will introduce a simplified design token system, enhancing consistency and maintainability across all Iress products.
5
+
6
+ [](#vision)Vision
7
+ -----------------
8
+
9
+ Beautiful, user-friendly applications seamlessly align with client branding, delivering consistent, memorable experiences that embody the organisation’s identity
10
+
11
+ [](#impact)Impact
12
+ -----------------
13
+
14
+ * **Faster development**: The new design tokens and CSS-in-JS approach streamline application development, reducing code complexity.
15
+ * **Improved brand consistency**: Easier branding integration enhances professionalism and uniformity.
16
+ * **Enable no-code theming**: Non-developers can create and manage themes, reducing development resource demands.
17
+ * **Better collaboration**: With less design tokens, we can provide a unified language for designers and developers to work together more effectively.
18
+ * **Enhanced usability**: A modern UI improves user experience and satisfaction, as per the [aesthetic-usability effect](https://www.nngroup.com/articles/aesthetic-usability-effect).
19
+
20
+ [](#goals)Goals
21
+ ---------------
22
+
23
+ ### [](#simplifying-tokens)Simplifying tokens
24
+
25
+ A key challenge has been the complexity of the current design token structure. We are simplifying it by:
26
+
27
+ * **Flattening the token structure:** Reducing semantic naming conventions to minimise the number of tokens, making them easier to use across code and Figma.
28
+ * **Using composite tokens:** Merging related tokens (e.g. font-size and line-height) into a single token, reducing the number of tokens required.
29
+ * **Figma style guide:** Aligning design system tokens with a Figma guide for seamless designer-developer collaboration.
30
+
31
+ ### [](#modern-ui-out-of-the-box)Modern UI out-of-the-box
32
+
33
+ We are refreshing the design system to ensure applications look modern and professional by default. Key updates will include:
34
+
35
+ * **A refined white-label theme**: More polished out-of-the-box design instead of a completely neutral theme.
36
+ * **Simplified variations:** Fewer and smarter variations to reduce complexity and improve consistency.
37
+ * **Increased use of animations and layering:** Enhancing accessibility and engagement beyond color-based differentiation.
38
+
39
+ ### [](#theme-management-system-styler)Theme management system (Styler)
40
+
41
+ Styler will be updated to support the new token structure, enabling:
42
+
43
+ * **Complete token control:** Full customization of colors, typography, spacing, and more (even custom fonts!).
44
+ * **Sub-themes instead of view modes:** Allowing extensions of base themes for specific use cases (e.g. larger text without changing colors for mobile-first products).
45
+
46
+ ### [](#css-in-js-transition)CSS-in-JS Transition
47
+
48
+ IDS is adopting [Panda CSS](https://pandacss.dev/), a lightweight, zero-runtime CSS-in-JS solution, offering:
49
+
50
+ * Smaller CSS bundles & faster performance.
51
+ * Type-safe styles that use the design tokens, removing the need for you to remember which `--iress-*` CSS variable to use when styling components. They will all automatically mapped instead (eg. `<IressBox px="spacing.600" />`).
52
+ * CSS layers for clear separation between IDS and application styles for easier overrides.
53
+ * Utilising Panda CSS recipes and utilities for streamlined styling.
54
+
55
+ [](#other-questions)Other questions
56
+ -----------------------------------
57
+
58
+ ### [](#how-can-i-make-it-easier-to-migrate-to-version-6)How can I make it easier to migrate to version 6?
59
+
60
+ 1. **Good news!**: Some components will not require any changes on your side, but they will have all the good features of version 6. These are marked as `Updated` in Storybook, please tell us if there were any issues with these components.
61
+ 2. **Use the new design tokens**: Use the new design tokens in your codebase. The new design tokens are available in the `@iress-oss/ids-tokens` package. You can import tokens as CSS variables by using `cssVars.elevation.raised.shadow`, or you can access the underlying metadata by using `designTokens.elevation.raised.shadow`.
62
+ 3. **Provide feedback**: Reach out to the team if you have any concerns on our approach
63
+
64
+ ### [](#can-i-migrate-to-version-6-and-keep-the-same-look-and-feel-to-the-old-themes)Can I migrate to version 6 and keep the same look and feel to the old themes?
65
+
66
+ Yes, the old themes will still be available in version 6 as we know that multiple products will need to be transitioned at the same time (such as Xplan). They will look mostly the same as they did in previous versions apart from a few things no longer living in design tokens, such as:
67
+
68
+ * **Border widths:** These are now hard coded in components and can no longer be customised at the theme level. Borders play a big part in usability hence they are now hard coded, with some being controlled at the component level such as `IressBox` and `IressTable`.
69
+ * **Animations/transitions:** These are now hard coded in components and can no longer be customised at the theme level. They play a big part in usability hence they are now hard coded.
70
+ * **Sizes:** These are now hard coded in components and can no longer be customised at the theme level. Some components such as `IressTable` and `IressButton` have variations that will re-size the component.
71
+
72
+ [](#breaking-changes)Breaking Changes
73
+ -------------------------------------
74
+
75
+ [
76
+
77
+ View the breaking changes document
78
+
79
+ ](https://docs.google.com/document/d/17K81rHBZjjF_tsrC8QFrSsmjrC0IJu_bpU4sB2N7PSQ/edit?tab=t.0#heading=h.z7kwtn6paey6)
80
+
81
+ On this page
82
+
83
+ * [Vision](#vision)
84
+ * [Impact](#impact)
85
+ * [Goals](#goals)
86
+ * [Simplifying tokens](#simplifying-tokens)
87
+ * [Modern UI out-of-the-box](#modern-ui-out-of-the-box)
88
+ * [Theme management system (Styler)](#theme-management-system-styler)
89
+ * [CSS-in-JS Transition](#css-in-js-transition)
90
+ * [Other questions](#other-questions)
91
+ * [How can I make it easier to migrate to version 6?](#how-can-i-make-it-easier-to-migrate-to-version-6)
92
+ * [Can I migrate to version 6 and keep the same look and feel to the old themes?](#can-i-migrate-to-version-6-and-keep-the-same-look-and-feel-to-the-old-themes)
93
+ * [Breaking Changes](#breaking-changes)