@iress-oss/ids-mcp-server 0.0.1-dev.0

package/generated/docs/foundations-accessibility-docs.md

@@ -0,0 +1,62 @@
+[](#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
+---------------------------------------------
+
+### [](#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
+
+*   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
+
+*   Use appropriate loading patterns based on context:
+    *   **Page**: Full page loading states
+    *   **Component**: Local loading within sections
+    *   **Button**: Inline loading for form submissions
+    *   **Validate**: Server-side validation feedback
+*   Provide clear success and error feedback
+*   Use progressive enhancement for better perceived performance
+
+* * *
+
+[](#responsive-design)Responsive Design
+---------------------------------------
+
+### [](#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
+
+*   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

@@ -0,0 +1,257 @@
+[](#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
+---------------------------
+
+### Default Background
+
+\--iress-g-background-color
+
+Used for the default panel background.
+
+#### Allowed foregrounds
+
+*   \--iress-g-text-color
+    
+    9.7 AAA
+    
+*   \--iress-g-muted-text-color
+    
+    5.4 AA
+    
+*   \--iress-g-info-color
+    
+    5.4 AA
+    
+*   \--iress-g-success-color
+    
+    5.4 AA
+    
+*   \--iress-g-warning-color
+    
+    5.6 AA
+    
+*   \--iress-g-danger-color
+    
+    5.4 AA
+    
+
+### Page Background
+
+\--iress-g-page-background-color
+
+The background colour of the page.
+
+#### Allowed foregrounds
+
+*   \--iress-g-text-color
+    
+    10.4 AAA
+    
+*   \--iress-g-muted-text-color
+    
+    5.7 AA
+    
+*   \--iress-g-info-color
+    
+    5.8 AA
+    
+*   \--iress-g-success-color
+    
+    5.8 AA
+    
+*   \--iress-g-warning-color
+    
+    6.0 AA
+    
+*   \--iress-g-danger-color
+    
+    5.8 AA
+    
+
+### Alt Background
+
+\--iress-g-background-color-alt
+
+Used for the alt panel background.
+
+#### Allowed foregrounds
+
+*   \--iress-g-text-color
+    
+    8.2 AAA
+    
+*   \--iress-g-muted-text-color
+    
+    4.5 AA
+    
+*   \--iress-g-info-color
+    
+    4.6 AA
+    
+*   \--iress-g-success-color
+    
+    4.5 AA
+    
+*   \--iress-g-warning-color
+    
+    4.7 AA
+    
+*   \--iress-g-danger-color
+    
+    4.5 AA
+    
+
+### Hover Background
+
+\--iress-g-hover-background-color
+
+Used for the hover and active state of elements such as tables, button groups, expanders, checkboxes and more.
+
+#### Allowed foregrounds
+
+*   \--iress-g-text-color
+    
+    9.3 AAA
+    
+*   \--iress-g-muted-text-color
+    
+    5.1 AA
+    
+*   \--iress-g-info-color
+    
+    5.2 AA
+    
+*   \--iress-g-success-color
+    
+    5.1 AA
+    
+*   \--iress-g-warning-color
+    
+    5.3 AA
+    
+*   \--iress-g-danger-color
+    
+    5.1 AA
+    
+
+[](#primary)Primary
+-------------------
+
+### Primary
+
+\--iress-g-primary-color
+
+Used for the background colour of primary buttons, and to highlight other interactive/featured elements.
+
+#### Allowed foregrounds
+
+*   \--iress-g-primary-contrast-color
+    
+    10.7 AAA
+    
+
+### Primary Hover
+
+\--iress-g-primary-hover-color
+
+Used for the hover state of primary buttons.
+
+#### Allowed foregrounds
+
+*   \--iress-g-primary-contrast-color
+    
+    15.5 AAA
+    
+
+[](#system)System
+-----------------
+
+### Info
+
+\--iress-g-info-color
+
+Used to indicate an element that provides information, usually an element without an action. Used in alerts and badges.
+
+#### Allowed foregrounds
+
+*   \--iress-g-info-contrast-color
+    
+    5.8 AA
+    
+
+### Danger
+
+\--iress-g-danger-color
+
+Used to indicate an error that requires the user's attention and action. Used in alerts and badges.
+
+#### Allowed foregrounds
+
+*   \--iress-g-danger-contrast-color
+    
+    5.8 AA
+    
+
+### Warning
+
+\--iress-g-warning-color
+
+Used to indicate an action/information that may have consequences. Used in alerts and badges.
+
+#### Allowed foregrounds
+
+*   \--iress-g-warning-contrast-color
+    
+    6.0 AA
+    
+
+### Success
+
+\--iress-g-success-color
+
+Used to indicate a successful action. Used in alerts and badges.
+
+#### Allowed foregrounds
+
+*   \--iress-g-success-contrast-color
+    
+    5.8 AA
+    
+
+### Negative
+
+\--iress-g-negative-color
+
+Used to indicate an element that is below a threshold or limit. Usually used for trading to indicate a loss.
+
+#### Allowed foregrounds
+
+*   \--iress-g-negative-contrast-color
+    
+    5.8 AA
+    
+
+### Positive
+
+\--iress-g-positive-color
+
+Used to indicate an element that is above a threshold or limit. Usually used for trading to indicate a gain.
+
+#### Allowed foregrounds
+
+*   \--iress-g-positive-contrast-color
+    
+    5.5 AA
+    
+
+On this page
+
+*   [Backgrounds](#backgrounds)
+*   [Primary](#primary)
+*   [System](#system)

package/generated/docs/foundations-consistency-docs.md

@@ -0,0 +1,52 @@
+[](#using-components-consistently)Using components consistently
+===============================================================
+
+[](#buttons)Buttons
+-------------------
+
+*   **Primary**: Limit to one per view for main call-to-action
+*   **Secondary**: Use for secondary actions
+*   **Tertiary**: Extra affordance between secondary actions
+*   **Link**: Button styled as link (avoid with icon-only content)
+*   **Danger**: Destructive actions requiring extra confirmation
+*   **Positive/Negative**: Financial transactions (buy/sell)
+
+[](#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
+-------------------------
+
+*   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
+-----------------------------
+
+*   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
+-------------------------------------------
+
+*   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

@@ -0,0 +1,23 @@
+[](#content)Content
+===================
+
+[](#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
+---------------------------
+
+*   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/foundations-introduction-docs.md

@@ -0,0 +1,17 @@
+[](#introduction)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](./?path=/docs/foundations-principles--docs)
+2.  [Accessibility](./?path=/docs/foundations-accessibility--docs)
+3.  [Colours](./?path=/docs/foundations-colours--docs)
+4.  [Typography](./?path=/docs/foundations-typography--docs)
+5.  [Visual Design](./?path=/docs/foundations-visual-design--docs)
+6.  [Consistency](./?path=/docs/foundations-consistency--docs)
+7.  [Content](./?path=/docs/foundations-content--docs)
+8.  [User Experience](./?path=/docs/foundations-user-experience--docs)
+
+_This document is a living standard. Revisit and revise regularly to reflect evolving needs, technologies, and user expectations._
+
+On this page

package/generated/docs/foundations-principles-docs.md

@@ -0,0 +1,70 @@
+[](#core-design-principles)Core Design Principles
+=================================================
+
+[](#consistency)Consistency
+---------------------------
+
+*   Maintain brand consistency across all applications and experiences
+*   Use standardised component naming conventions (all components start with `Iress` prefix)
+*   Leverage shared design tokens for spacing, colours, typography, and interactive states
+*   Ensure consistent behaviour patterns across similar components
+
+[](#accessibility-first)Accessibility First
+-------------------------------------------
+
+*   Meet or exceed WCAG 2.1 Level AA Accessibility Guidelines
+*   Provide proper colour contrast ratios (minimum 4.5:1 for AA, 7:1 for AAA)
+*   Implement comprehensive keyboard navigation support
+*   Include screen reader compatibility with appropriate ARIA attributes
+*   Support focus management and skip navigation patterns
+*   Document accessibility considerations and requirements
+
+[](#clarity-and-usability)Clarity and Usability
+-----------------------------------------------
+
+*   Prioritise clear visual hierarchy through typography scales and spacing systems
+*   Use progressive disclosure to manage complexity
+*   Provide immediate feedback for user actions (loading states, validation, etc.)
+*   Design for touch-friendly interfaces with adequate target sizes
+
+[](#developer-experience)Developer Experience
+---------------------------------------------
+
+*   Maintain clean component APIs with predictable prop patterns
+*   Provide comprehensive documentation with usage examples
+*   Include common patterns and anti-patterns
+*   Support both controlled and uncontrolled component patterns
+*   Enable efficient testing strategies with semantic roles and accessible queries
+*   Maintain up-to-date prop documentation and type definitions
+
+[](#quality-assurance)Quality assurance
+---------------------------------------
+
+*   Test components across supported browsers and devices
+*   Validate accessibility compliance with automated and manual testing
+*   Ensure proper keyboard navigation functionality
+*   Test with assistive technologies (screen readers, voice control)
+
+### [](#code-standards)Code Standards
+
+*   Follow consistent naming conventions for CSS classes and component props
+*   Use semantic HTML elements where appropriate
+*   Implement proper TypeScript typing for better developer experience
+*   Maintain clean separation between presentation and logic
+
+### [](#performance-considerations)Performance Considerations
+
+*   Optimise component rendering and re-rendering
+*   Implement appropriate code splitting strategies
+*   Use efficient animation and transition patterns
+*   Consider bundle size impact of component dependencies
+
+On this page
+
+*   [Consistency](#consistency)
+*   [Accessibility First](#accessibility-first)
+*   [Clarity and Usability](#clarity-and-usability)
+*   [Developer Experience](#developer-experience)
+*   [Quality assurance](#quality-assurance)
+    *   [Code Standards](#code-standards)
+    *   [Performance Considerations](#performance-considerations)

package/generated/docs/foundations-typography-docs.md

@@ -0,0 +1,191 @@
+[](#typography)Typography
+=========================
+
+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.
+
+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.
+
+[](#body)Body
+-------------
+
+This is the default text variant, and is designed to be clear and easy to read.
+
+Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
+
+*   Voluptatem assumenda soluta!
+*   Illum et atque alias possimus maiores rem in corrupti consectetur!
+*   Dolorum, repellat expedita!
+
+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; }
+
+<IressText\>
+  <p\>
+    Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.  </p\>
+  <ul\>
+    <li\>
+      Voluptatem assumenda soluta!    </li\>
+    <li\>
+      Illum et atque alias possimus maiores rem in corrupti consectetur!    </li\>
+    <li\>
+      Dolorum, repellat expedita!    </li\>
+  </ul\>
+</IressText\>
+
+Copy
+
+[](#headings)Headings
+---------------------
+
+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).
+
+Hello, we are a company that puts clients first.
+================================================
+
+Hello, we are a company that puts clients first.
+------------------------------------------------
+
+### Hello, we are a company that puts clients first.
+
+#### Hello, we are a company that puts clients first.
+
+##### Hello, we are a company that puts clients first.
+
+An H2 styled as an H3.
+----------------------
+
+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"\>
+  <IressText element\="h1"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+  <IressText element\="h2"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+  <IressText element\="h3"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+  <IressText element\="h4"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+  <IressText element\="h5"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+  <IressText
+    element\="h2"
+    variant\="h3"
+  \>
+    An H2 styled as an H3.  </IressText\>
+</IressStack\>
+
+Copy
+
+[](#display)Display
+-------------------
+
+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.
+
+Hello, we are a company that puts clients first.
+
+Hello, we are a company that puts clients first.
+
+Hello, we are a company that puts clients first.
+
+Hello, we are a company that puts clients first.
+
+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"\>
+  <IressText variant\="display1"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+  <IressText variant\="display2"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+  <IressText variant\="display3"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+  <IressText variant\="display4"\>
+    Hello, we are a company that puts clients first.  </IressText\>
+</IressStack\>
+
+Copy
+
+[](#lead)Lead
+-------------
+
+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.
+
+Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
+
+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; }
+
+<IressText
+  element\="p"
+  variant\="lead"
+\>
+  Nobis odit nesciunt in, harum provident deleniti molestiae dolorum aliquid tempora optio accusamus dolore porro voluptatibus. Dolorum, repellat expedita.
+</IressText\>
+
+Copy
+
+[](#caption)Caption
+-------------------
+
+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.
+
+Example caption
+
+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; }
+
+<IressText element\="caption"\>
+  Example caption
+</IressText\>
+
+Copy
+
+[](#other-variants)Other variants
+---------------------------------
+
+IDS also includes bold, italic and small text variants.
+
+*   Bold text should be used to **draw attention** to part of a sentence, or to provide a visual label for readonly text.
+*   Italic text should be used to add _emphasis_ to content, or to add stress to part of a sentence.
+*   Small text is used for side comments or for text that's secondary to the main content.
+*   Muted text is used to de-emphasise content, such as when displaying informative text that is not critical to the user experience.
+
+Bold text
+
+Italic text
+
+Small text
+
+Muted text
+
+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"\>
+  <IressText variant\="bold"\>
+    Bold text  </IressText\>
+  <IressText variant\="italic"\>
+    Italic text  </IressText\>
+  <IressText variant\="small"\>
+    Small text  </IressText\>
+  <IressText mode\="muted"\>
+    Muted text  </IressText\>
+</IressStack\>
+
+Copy
+
+On this page
+
+*   [Body](#body)
+*   [Headings](#headings)
+*   [Display](#display)
+*   [Lead](#lead)
+*   [Caption](#caption)
+*   [Other variants](#other-variants)