@iress-oss/ids-mcp-server 5.14.2 → 5.20.1

package/generated/docs/{components-validationmessage-docs.md → components_components-validationmessage-docs.md}

@@ -1,32 +1,52 @@
-[](#validation-message)Validation message
-=========================================
+Validation message
+==================
 
 Overview
 --------
 
 A validation message is used to inform the user of the status of a form input. If there are multiple messages, they can be combined using the `IressValidationSummary` component.
 
+[](./iframe.html?id=components-validationmessage--default)
+
 Error:
 
 Validation message
 
-Hide code
-
-\[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; }
+```
 
 <IressValidationMessage\>
   Validation message
 </IressValidationMessage\>
 
-Copy
+```
 
-[](#examples)Examples
----------------------
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children | 
+Validation content (what went wrong, what went right).
+
+ReactNode
+
+
+
+ | \- | 
+
+"Validation message"
+
+ |
+
+Examples
+--------
 
-### [](#status)Status
+### Status
 
 Validation status is controled by the status prop. It defaults to `error`.
 
+[](./iframe.html?id=components-validationmessage--status)
+
 Error:
 
 Something is wrong.
@@ -43,9 +63,7 @@ Warning:
 
 Something could go wrong.
 
-Hide code
-
-\[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; }
+```
 
 <IressStack\>
   <IressValidationMessage status\="danger"\>
@@ -58,14 +76,35 @@ Hide code
     Something could go wrong.  </IressValidationMessage\>
 </IressStack\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children | 
+Validation content (what went wrong, what went right).
+
+ReactNode
 
-### [](#prefix)Prefix
+
+
+ | \- | \- |
+| status | 
+
+\-
+
+ | \- | \- |
+| Show Storybook only itemsStorybook only | Show Storybook only items |
+
+### Prefix
 
 You can add a prefix to the message. If not provided, it uses the `status` prop to determine the prefix.
 
 It is hidden by default, but can be shown by setting the `visiblePrefix` prop to `true`.
 
+[](./iframe.html?id=components-validationmessage--prefix)
+
 Prefix:
 
 Something is wrong.
@@ -82,9 +121,7 @@ Prefix:
 
 Something could go wrong.
 
-Hide code
-
-\[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; }
+```
 
 <IressStack\>
   <IressValidationMessage
@@ -113,13 +150,48 @@ Hide code
     Something could go wrong.  </IressValidationMessage\>
 </IressStack\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children | 
+Validation content (what went wrong, what went right).
+
+ReactNode
+
+
+
+ | \- | \- |
+| prefix | 
+
+string
+
+
+
+ | \- | Prefix: |
+| status | 
+
+\-
 
-[](#iressvalidationlink)`IressValidationLink`
----------------------------------------------
+ | \- | \- |
+| visiblePrefix | 
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| Show Storybook only itemsStorybook only | Show Storybook only items |
+
+`IressValidationLink`
+---------------------
 
 The `IressValidationLink` component can be used to provide a link to the input that has the error. It has a `linkToTarget` prop that should match the `id` of the input.
 
+[](./iframe.html?id=components-validationmessage-validationlink--validation-link)
+
 [
 
 Error:
@@ -148,9 +220,7 @@ Something could go wrong.
 
 * * *
 
-Hide code
-
-\[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; }
+```
 
 <IressStack gutter\="md"\>
   <IressStack\>
@@ -176,16 +246,46 @@ Hide code
       Something could go wrong.    </IressValidationLink\>
   </IressStack\>
   <IressDivider />
-  <IressInput id\="input" />
+  <ForwardedInput id\="input" />
 </IressStack\>
 
-Copy
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children | 
+Validation content (what went wrong, what went right).
+
+ReactNode
+
 
-[](#iressvalidationsummary)`IressValidationSummary`
----------------------------------------------------
+
+ | \- | \- |
+| linkToTarget\* | 
+
+ID of element the message is describing. If nothing is supplied a link will not render.
+
+string
+
+
+
+ | \- | input |
+| status | 
+
+\-
+
+ | \- | \- |
+| Show Storybook only itemsStorybook only | Show Storybook only items |
+
+`IressValidationSummary`
+------------------------
 
 Messages can be passed programmatically as a `ValidationMessageObj[]` using the `messages` prop of the `IressValidationSummary` component.
 
+[](./iframe.html?id=components-validationmessage-validationsummary--validation-summary)
+
 *   Info:
     
     Something you should know.
@@ -203,39 +303,108 @@ Messages can be passed programmatically as a `ValidationMessageObj[]` using the
     Something went right.
     
 
-Hide code
-
-\[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; }
+```
 
 <IressValidationSummary
-  messages\={\[
-    {
-      message: 'Something you should know.',
-      status: 'info'
-    },
-    {
-      message: 'Something is wrong.',
-      status: 'danger'
-    },
-    {
-      message: 'Something could go wrong.',
-      status: 'warning'
-    },
-    {
-      message: 'Something went right.',
-      status: 'success'
-    }
-  \]}
- />
-
-Copy
-
-On this page
-
-*   [Overview](#overview)
-*   [Props](#props)
-*   [Examples](#examples)
-    *   [Status](#status)
-    *   [Prefix](#prefix)
-*   [IressValidationLink](#iressvalidationlink)
-*   [IressValidationSummary](#iressvalidationsummary)
+ messages\={\[
+   {
+     message: 'Something you should know.',
+     status: 'info'
+   },
+   {
+     message: 'Something is wrong.',
+     status: 'danger'
+   },
+   {
+     message: 'Something could go wrong.',
+     status: 'warning'
+   },
+   {
+     message: 'Something went right.',
+     status: 'success'
+   }
+ \]}
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| linkToTarget | 
+Renders validation messages as links pointing at the field it relates to, specified as a string Only works when used with the `messages` prop.
+
+string
+
+
+
+ | \- | Set string |
+| messages | 
+
+ValidationMessage Array containing the `id` of the field and the validation message
+
+ValidationMessageObj\[\]
+
+ | \[\] | 
+
+RAW
+
+*   messages :
+    
+    \[
+    
+    *   0 :
+        
+        {...} 2 keys
+        
+    *   1 :
+        
+        {...} 2 keys
+        
+    *   2 :
+        
+        {...} 2 keys
+        
+    *   3 :
+        
+        {...} 2 keys
+        
+    
+    \]
+    
+
+
+
+ |
+| prefix | 
+
+Prefix to all validation messages. Will be `status` prop if nothing is provided.
+
+ReactNode
+
+
+
+ | \- | Set object |
+| status | 
+
+Status for all child ValidationMessage components
+
+union
+
+
+
+ | 
+
+'danger'
+
+ | Set object |
+| visiblePrefix | 
+
+If set to true, the prefix will be visually displayed (default is only available to screen readers)
+
+boolean
+
+
+
+ | \- | Set boolean |

package/generated/docs/components_contact-us-docs.md

@@ -0,0 +1,12 @@
+Contact us
+==========
+
+Help desk
+---------
+
+Raise any issues, feature requests or questions through our slack channel.
+
+Team
+----
+
+Front-End Enablement (FEE) are the guys and gals making it happen, and you'll probably see us on Iress support channels. Please contact us if you need help with IDS or have any questions. We are here to help you.

package/generated/docs/{foundations-accessibility-docs.md → components_foundations-accessibility-docs.md}

@@ -1,28 +1,28 @@
-[](#accessibility)Accessibility
-===============================
+Accessibility
+=============
 
 Accessibility is everyone's responsibility. It ensures that all users, regardless of their abilities or disabilities, can access and interact with our components effectively. This document outlines the key practices for building accessible components we follow within IDS.
 
 Please note: The default behaviour of our components is to be accessible, but it is the responsibility of the product to ensure that they are used correctly in accessibile context, or any modifications made to them do not compromise accessibility.
 
-[](#interaction-patterns)Interaction Patterns
----------------------------------------------
+Interaction Patterns
+--------------------
 
-### [](#keyboard-navigation)Keyboard Navigation
+### Keyboard Navigation
 
 *   Support standard keyboard shortcuts (Tab, Arrow keys, Enter, Space, Escape)
 *   Implement proper focus order and visual focus indicators
 *   Provide keyboard alternatives for mouse-only interactions
 *   Follow established ARIA patterns for complex widgets
 
-### [](#touch-interactions)Touch Interactions
+### Touch Interactions
 
 *   Provide adequate touch target sizes (minimum 44px)
 *   Implement touch-friendly spacing between interactive elements
 *   Support gesture-based interactions where appropriate
 *   Ensure consistent behaviour across device types
 
-### [](#loading-and-feedback)Loading and Feedback
+### Loading and Feedback
 
 *   Use appropriate loading patterns based on context:
     *   **Page**: Full page loading states
@@ -34,29 +34,19 @@ Please note: The default behaviour of our components is to be accessible, but it
 
 * * *
 
-[](#responsive-design)Responsive Design
----------------------------------------
+Responsive Design
+-----------------
 
-### [](#breakpoint-strategy)Breakpoint Strategy
+### Breakpoint Strategy
 
 *   Implement mobile-first responsive design
 *   Use consistent breakpoint values across all components
 *   Provide appropriate component variants for different screen sizes
 *   Consider content priority and progressive disclosure on smaller screens
 
-### [](#adaptive-behaviour)Adaptive Behaviour
+### Adaptive Behaviour
 
 *   Reduce option counts on mobile devices where appropriate
 *   Implement responsive navigation patterns
 *   Adjust spacing and sizing for different contexts
 *   Maintain usability across all supported devices
-
-On this page
-
-*   [Interaction Patterns](#interaction-patterns)
-    *   [Keyboard Navigation](#keyboard-navigation)
-    *   [Touch Interactions](#touch-interactions)
-    *   [Loading and Feedback](#loading-and-feedback)
-*   [Responsive Design](#responsive-design)
-    *   [Breakpoint Strategy](#breakpoint-strategy)
-    *   [Adaptive Behaviour](#adaptive-behaviour)

package/generated/docs/{foundations-colours-docs.md → components_foundations-colour-030-colours.md}

@@ -1,12 +1,12 @@
-[](#colours)Colours
-===================
+Colours
+=======
 
 Colour is an integral aspect of conveying clear concise data. Our colours are optimized across two backgrounds, meeting or exceeding [WCAG 2.1 Level AA Accessibility Guidelines](https://www.w3.org/TR/WCAG21/#contrast-minimum).
 
 The Iress themes are designed to meet WCAG contrast guidelines (2.1 AA). We can't guarantee this when consumer branding is applied, so colour combinations should be checked to ensure conformance.
 
-[](#backgrounds)Backgrounds
----------------------------
+Backgrounds
+-----------
 
 ### Default Background
 
@@ -140,8 +140,8 @@ Used for the hover and active state of elements such as tables, button groups, e
     5.1 AA
     
 
-[](#primary)Primary
--------------------
+Primary
+-------
 
 ### Primary
 
@@ -169,8 +169,8 @@ Used for the hover state of primary buttons.
     15.5 AAA
     
 
-[](#system)System
------------------
+System
+------
 
 ### Info
 
@@ -248,10 +248,3 @@ Used to indicate an element that is above a threshold or limit. Usually used for
 *   \--iress-g-positive-contrast-color
     
     5.5 AA
-    
-
-On this page
-
-*   [Backgrounds](#backgrounds)
-*   [Primary](#primary)
-*   [System](#system)

package/generated/docs/{foundations-consistency-docs.md → components_foundations-consistency-docs.md}

@@ -1,8 +1,8 @@
-[](#using-components-consistently)Using components consistently
-===============================================================
+Using components consistently
+=============================
 
-[](#buttons)Buttons
--------------------
+Buttons
+-------
 
 *   **Primary**: Limit to one per view for main call-to-action
 *   **Secondary**: Use for secondary actions
@@ -11,42 +11,34 @@
 *   **Danger**: Destructive actions requiring extra confirmation
 *   **Positive/Negative**: Financial transactions (buy/sell)
 
-[](#forms)Forms
----------------
+Forms
+-----
 
 *   Always use `IressField` wrapper for proper label, hint, and error placement
 *   Provide clear validation feedback with appropriate error messages
 *   Use consistent input sizing based on expected content length
 *   Implement proper form state management and accessibility
 
-[](#navigation)Navigation
--------------------------
+Navigation
+----------
 
 *   Use semantic HTML5 navigation elements
 *   Provide skip links for keyboard users
 *   Implement proper ARIA labelling for navigation sections
 *   Ensure consistent navigation patterns across applications
 
-[](#data-display)Data Display
------------------------------
+Data Display
+------------
 
 *   Use semantic table structures with proper headers
 *   Provide clear visual hierarchy in data presentations
 *   Implement consistent sorting and filtering patterns
 *   Use appropriate loading states for data-heavy components
 
-[](#modals-and-overlays)Modals and Overlays
--------------------------------------------
+Modals and Overlays
+-------------------
 
 *   Reserve modals for critical tasks requiring full attention
 *   Provide multiple dismissal methods (backdrop, escape key, close button)
 *   Implement proper focus management and restoration
 *   Use slideouts for supplementary tasks where underlying content needs visibility
-
-On this page
-
-*   [Buttons](#buttons)
-*   [Forms](#forms)
-*   [Navigation](#navigation)
-*   [Data Display](#data-display)
-*   [Modals and Overlays](#modals-and-overlays)

package/generated/docs/{foundations-content-docs.md → components_foundations-content-docs.md}

@@ -1,23 +1,18 @@
-[](#content)Content
-===================
+Content
+=======
 
-[](#microcopy-guidelines)Microcopy Guidelines
----------------------------------------------
+Microcopy Guidelines
+--------------------
 
 *   Use clear, concise language that matches user mental models
 *   Provide helpful error messages with actionable guidance
 *   Implement consistent tone of voice across all interface text
 *   Use progressive disclosure for complex information
 
-[](#iconography)Iconography
----------------------------
+Iconography
+-----------
 
 *   Use icons consistently with established meanings
 *   Provide screen reader text for meaningful icons
 *   Avoid using icons as the sole means of communication
 *   Maintain consistent icon sizing and alignment
-
-On this page
-
-*   [Microcopy Guidelines](#microcopy-guidelines)
-*   [Iconography](#iconography)

package/generated/docs/components_foundations-introduction-docs.md

@@ -0,0 +1,15 @@
+Introduction
+============
+
+The IDS and product design team use the foundations to create a consistent user experience across all Iress products. This includes design principles and guidelines that ensure a cohesive look and feel.
+
+1.  [Principles](/docs/foundations-principles--docs)
+2.  [Accessibility](/docs/foundations-accessibility--docs)
+3.  [Colours](/docs/foundations-colours--docs)
+4.  [Typography](/docs/foundations-typography--docs)
+5.  [Visual Design](/docs/foundations-visual-design--docs)
+6.  [Consistency](/docs/foundations-consistency--docs)
+7.  [Content](/docs/foundations-content--docs)
+8.  [User Experience](/docs/foundations-user-experience--docs)
+
+_This document is a living standard. Revisit and revise regularly to reflect evolving needs, technologies, and user expectations._