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

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/{docs/ids → generated/docs}/foundations-colours-docs.md

@@ -3,7 +3,7 @@
 
 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. We can't guarantee this when consumer branding is applied, so colour combinations should be checked to ensure conformance.
+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
 ---------------------------

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/{docs/ids → generated/docs}/foundations-typography-docs.md

@@ -1,7 +1,7 @@
 [](#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.
+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.
 
@@ -38,7 +38,7 @@ 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, with level 1 headings being the largest.
+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.
 ================================================
@@ -154,6 +154,7 @@ 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
 
@@ -161,6 +162,8 @@ 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; }
@@ -172,6 +175,8 @@ Hide code
     Italic text  </IressText\>
   <IressText variant\="small"\>
     Small text  </IressText\>
+  <IressText mode\="muted"\>
+    Muted text  </IressText\>
 </IressStack\>
 
 Copy

package/generated/docs/foundations-user-experience-docs.md

@@ -0,0 +1,63 @@
+[](#user-experience)User experience
+===================================
+
+We use heuristic guidelines to assess the usability and user-centred design quality of all Iress products.
+
+[](#system-feedback)System Feedback
+-----------------------------------
+
+*   Always show users where they are, what just happened, and what’s possible next.
+*   Provide immediate visual and textual feedback for all actions and states.
+*   Ensure feedback is clear, contextual, and proportionate to the importance of the action.
+
+[](#language-and-mental-models)Language and Mental Models
+---------------------------------------------------------
+
+*   Use user-centred language and avoid technical jargon.
+*   Follow cultural and industry conventions for colour, iconography, terminology, and layout.
+*   Align interaction patterns with real-world analogues wherever feasible.
+
+[](#control-and-forgiveness)Control and Forgiveness
+---------------------------------------------------
+
+*   Make actions reversible and provide undo where errors may occur.
+*   Let users easily backtrack, edit inputs, or abandon flows.
+*   Provide escape hatches from any process without penalty.
+
+[](#standards-and-consistency)Standards and Consistency
+-------------------------------------------------------
+
+*   Use consistent layout, labelling, iconography, and grammar.
+*   Reinforce expectations by placing similar elements in predictable positions.
+*   Apply colour, spacing, and visual patterns consistently across all screens.
+
+[](#error-prevention-and-recovery)Error Prevention and Recovery
+---------------------------------------------------------------
+
+*   Prevent errors by anticipating misuse and validating early.
+*   Phrase error messages with clarity, empathy, and constructive suggestions.
+*   Where errors occur, explain why and how they can be resolved.
+
+[](#recognition-over-recall)Recognition Over Recall
+---------------------------------------------------
+
+*   Display necessary information at the point of decision.
+*   Use visual grouping, spacing, and affordance to reveal hierarchy.
+*   Prioritise visual clarity over novelty.
+
+[](#simplicity-and-minimalism)Simplicity and Minimalism
+-------------------------------------------------------
+
+*   Remove unnecessary detail—every word, element, or feature should earn its place.
+*   Design for clarity of purpose with visually distinct, semantically meaningful UI components.
+*   Use whitespace, clean alignment, and simplified flows to reduce cognitive load.
+
+On this page
+
+*   [System Feedback](#system-feedback)
+*   [Language and Mental Models](#language-and-mental-models)
+*   [Control and Forgiveness](#control-and-forgiveness)
+*   [Standards and Consistency](#standards-and-consistency)
+*   [Error Prevention and Recovery](#error-prevention-and-recovery)
+*   [Recognition Over Recall](#recognition-over-recall)
+*   [Simplicity and Minimalism](#simplicity-and-minimalism)

package/generated/docs/foundations-visual-design-docs.md

@@ -0,0 +1,46 @@
+[](#visual-design-standards)Visual Design Standards
+===================================================
+
+[](#typography)Typography
+-------------------------
+
+*   Use systematic font sizing with heading scales (H1-H6)
+*   Implement consistent line heights and font weights
+*   Provide text colour hierarchies (primary, muted, success, warning, danger)
+*   Support responsive typography scaling
+
+[](#colour-system)Colour System
+-------------------------------
+
+*   Maintain semantic colour meanings:
+    *   **Primary**: Main call-to-action colour with high contrast
+    *   **Success**: Positive outcomes and confirmations
+    *   **Warning**: Caution and important notices
+    *   **Danger**: Errors and destructive actions
+    *   **Info**: Neutral information and guidance
+    *   **Positive/Negative**: Financial context (buy/sell actions)
+*   Ensure all colour combinations meet accessibility contrast requirements
+*   Provide consistent hover and active state colours
+
+[](#spacing-and-layout)Spacing and Layout
+-----------------------------------------
+
+*   Use systematic spacing scale (xs, sm, md, lg, xl)
+*   Apply consistent gutter systems for layout components
+*   Implement responsive breakpoints for adaptive layouts
+*   Maintain proper margin and padding relationships
+
+[](#interactive-states)Interactive States
+-----------------------------------------
+
+*   Provide clear hover, focus, active, and disabled states
+*   Use consistent transition timing and easing
+*   Implement proper focus indicators for keyboard navigation
+*   Show loading states for asynchronous operations
+
+On this page
+
+*   [Typography](#typography)
+*   [Colour System](#colour-system)
+*   [Spacing and Layout](#spacing-and-layout)
+*   [Interactive States](#interactive-states)

package/{docs/ids → generated/docs}/get-started-develop-docs.md

@@ -12,9 +12,9 @@ Set up your environment to use the latest version of the Iress Design System (ID
 [](#set-up-the-component-library)Set up the component library
 -------------------------------------------------------------
 
-1.  Install using: `yarn add @iress/ids-components`
-2.  Import the styles: `import '@iress/ids-components/dist/style.css'`
-3.  Import the components: `import { IressButton, IressText } from '@iress/ids-components'`
+1.  Install using: `yarn add @iress-oss/ids-components`
+2.  Import the styles: `import '@iress-oss/ids-components/dist/style.css'`
+3.  Import the components: `import { IressButton, IressText } from '@iress-oss/ids-components'`
 4.  Use the components: `<IressButton>Click me</IressButton>`
 
 [](#set-up-the-theme)Set up the theme