@iress-oss/ids-mcp-server 6.0.0-alpha.1-canary-20251204032753-fe18cab → 6.0.0-alpha.1-canary-20251204040305-3639454

package/generated/docs/introduction-docs.md

@@ -0,0 +1,37 @@
+Iress Design System (IDS)
+=========================
+
+These are the official packages for the Iress Design System (IDS). The Design System is a collection of reusable components, styles, and guidelines that help maintain consistency across Iress applications.
+
+React components
+----------------
+
+React components that implement the design system
+
+[@iress-oss/ids-components](/?path=/docs/components_introduction--docs)
+
+MCP Server
+----------
+
+Model Context Protocol (MCP) server providing AI assistants with contextual information about IDS components
+
+[@iress-oss/ids-mcp-server](/?path=/docs/components_resources-mcp-server--docs)
+
+Design Tokens
+-------------
+
+Design tokens for the Iress Design System, allowing it to be implemented in various frameworks and platforms
+
+[@iress-oss/ids-tokens](/?path=/docs/tokens_introduction--docs)
+
+* * *
+
+Reporting issues
+----------------
+
+If you find a bug in any of the Design System packages or would like an enhancement, please reach out to us using [Github issues](https://github.com/iress/design-system/issues).
+
+Github repository
+-----------------
+
+The IDS monorepo is hosted on GitHub: [iress/design-system](https://github.com/iress/design-system)

package/generated/docs/tokens_colour-docs.md

@@ -0,0 +1,479 @@
+Colour
+======
+
+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 default theme is 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.
+
+Primary
+-------
+
+The primary colour is your "brand" colour, and is used across all interactive elements such as buttons, links, inputs, etc. This colour can define the overall feel and can elicit emotion.
+
+### Fill
+
+colour.primary.fill #13213F
+
+Used for primary buttons and the active state of form controls such as checkboxes and radio buttons. Also used for the border of tags when they have a custom button.
+
+#### Allowed foregrounds
+
+*   colour.primary.onFill (#ECF2FF)
+    
+    14.2 AAA
+    
+
+### On Fill
+
+colour.primary.onFill #ECF2FF
+
+Used as the foreground colour on primary buttons and active form controls.
+
+#### Allowed foregrounds
+
+*   colour.primary.fill (#13213F)
+    
+    14.2 AAA
+    
+
+### Fill Hover
+
+colour.primary.fillHover #2B3752
+
+Used for the hover state of primary buttons as well as hovering over active form controls.
+
+#### Allowed foregrounds
+
+*   colour.primary.onFill (#ECF2FF)
+    
+    10.6 AAA
+    
+
+### Surface
+
+colour.primary.surface #D9E5FF
+
+Used as the background colour for secondary buttons and the focused state of menu and tab items. Also used as the background colour of active buttons.
+
+#### Allowed foregrounds
+
+*   colour.primary.text (#13213F)
+    
+    12.6 AAA
+    
+*   colour.neutral.80 (#393F46)
+    
+    8.4 AAA
+    
+
+### Text
+
+colour.primary.text #13213F
+
+Used for text on primary buttons, active form controls and focused tab and menu items. Also used for the link text colour and tertiary buttons.
+
+#### Allowed foregrounds
+
+*   colour.primary.surface (#D9E5FF)
+    
+    12.6 AAA
+    
+
+### Surface Hover
+
+colour.primary.surfaceHover #E1EAFF
+
+Used for the hover state of secondary buttons, form controls and hovering over focused menu and tab items. Also used when hovering over table rows.
+
+#### Allowed foregrounds
+
+*   colour.primary.text (#13213F)
+    
+    13.2 AAA
+    
+*   colour.neutral.80 (#393F46)
+    
+    8.8 AAA
+    
+
+* * *
+
+Neutral
+-------
+
+Neutral colours apply to most backgrounds, text, and shapes in our experiences. They do not typically have a meaning associated with them, though they can imply things like disabled states. **Note:** There are some colour contrasts that are AA Large and are used for placeholders. If WCAG compliance is necessary for your application, please avoid using placeholders to meet this requirement.
+
+### 10
+
+colour.neutral.10 #FFF
+
+Used as the default background colour for most components. For tooltips, it is used as the foreground colour for the tooltip content.
+
+#### Allowed foregrounds
+
+*   colour.neutral.80 (#393F46)
+    
+    10.6 AAA
+    
+*   colour.neutral.70 (#6D7278)
+    
+    4.9 AA
+    
+*   colour.neutral.60 (#878B92)
+    
+    3.4 AA Large
+    
+
+### 20
+
+colour.neutral.20 #F9F9F9
+
+Used as the alternating background colour for components such as tables. Used as the background colour behind panels and cards for highly interactive screens.
+
+#### Allowed foregrounds
+
+*   colour.neutral.80 (#393F46)
+    
+    10.1 AAA
+    
+*   colour.neutral.70 (#6D7278)
+    
+    4.6 AA
+    
+
+### 30
+
+colour.neutral.30 #E4E5E7
+
+Used as the border colour for dividers, and the default divider colour for components with in-built headers and footers such as cards.
+
+### 40
+
+colour.neutral.40 #D7D8DA
+
+Used for borders in subtle interactive components, such as checkboxes and radios with hidden controls and the progress bar.
+
+### 50
+
+colour.neutral.50 #AFB2B6
+
+Used as the background colour for interactive components such as the slider.
+
+### 60
+
+colour.neutral.60 #878B92
+
+Used for placeholder text in form controls and disabled states.
+
+#### Allowed foregrounds
+
+*   colour.neutral.10 (#FFF)
+    
+    3.4 AA Large
+    
+
+### 70
+
+colour.neutral.70 #6D7278
+
+Used for muted text such as hints and descriptions to allow for content hierarchy.
+
+#### Allowed foregrounds
+
+*   colour.neutral.10 (#FFF)
+    
+    4.9 AA
+    
+*   colour.neutral.20 (#F9F9F9)
+    
+    4.6 AA
+    
+
+### 80
+
+colour.neutral.80 #393F46
+
+Used as the default text colour for most components. For tooltips, it is used as the background colour.
+
+#### Allowed foregrounds
+
+*   colour.neutral.10 (#FFF)
+    
+    10.6 AAA
+    
+*   colour.neutral.20 (#F9F9F9)
+    
+    10.1 AAA
+    
+
+* * *
+
+Accent
+------
+
+The accent colour is a colour used to emphasise key parts of the UI. These act as "secondary" or "supporting" colours to you primary colour.
+
+### Brand
+
+colour.accent.brand #FF99A8
+
+The brand accent is useful for grabbing attention and to support your primary/brand colour. It should be used sparingly to draw attention to key elements.
+
+* * *
+
+System colours
+--------------
+
+Along with primary colours, it is helpful to have a selection of system colours to use in components such as pills, alerts and labels. System colours emphasis different semantic states. They are used to provide visual feedback and/or warnings to users as they use your interface.
+
+### Success (Positive)
+
+Communicates that an action has been successful and inform a user that the action is a positive action.
+
+### Fill
+
+colour.system.success.fill #02794D
+
+Used for the background colour of primary success buttons, as well as the border of alerts and badges. It is also used for the foreground colour of icons inside toasts and alerts.
+
+#### Allowed foregrounds
+
+*   colour.system.success.onFill (#EFFBF2)
+    
+    5.1 AA
+    
+
+### On Fill
+
+colour.system.success.onFill #EFFBF2
+
+Used for the foreground colour of primary success buttons and badges.
+
+#### Allowed foregrounds
+
+*   colour.system.success.fill (#02794D)
+    
+    5.1 AA
+    
+
+### Fill Hover
+
+colour.system.success.fillHover #01603D
+
+Used for the hover state of primary success buttons.
+
+#### Allowed foregrounds
+
+*   colour.system.success.onFill (#EFFBF2)
+    
+    7.2 AAA
+    
+
+### Surface
+
+colour.system.success.surface #E6F9EB
+
+Used for the background colour of success alerts and toasts, and the background of secondary success buttons.
+
+#### Allowed foregrounds
+
+*   colour.system.success.text (#015537)
+    
+    8.1 AAA
+    
+*   colour.neutral.80 (#393F46)
+    
+    9.7 AAA
+    
+
+### Text
+
+colour.system.success.text #015537
+
+Used for the text colour of success alerts and toasts, and success tertiary buttons.
+
+#### Allowed foregrounds
+
+*   colour.system.success.surface (#E6F9EB)
+    
+    8.1 AAA
+    
+
+### Surface Hover
+
+colour.system.success.surfaceHover #D5F6DE
+
+Used for the hover state of secondary success buttons.
+
+#### Allowed foregrounds
+
+*   colour.system.success.text (#015537)
+    
+    7.7 AAA
+    
+*   colour.neutral.80 (#393F46)
+    
+    9.2 AAA
+    
+
+* * *
+
+### Danger (Negative)
+
+Communicates something went wrong or prevents the user from moving forward with their task, as well as inform a potential action is destructive/negative.
+
+### Fill
+
+colour.system.danger.fill #C20A0A
+
+Used for the background colour of primary danger buttons, as well as the border of alerts and badges. It is also used for the foreground colour of icons inside toasts and alerts.
+
+#### Allowed foregrounds
+
+*   colour.system.danger.onFill (#FFF6F5)
+    
+    5.9 AA
+    
+
+### On Fill
+
+colour.system.danger.onFill #FFF6F5
+
+Used for the foreground colour of primary danger buttons and badges.
+
+#### Allowed foregrounds
+
+*   colour.system.danger.fill (#C20A0A)
+    
+    5.9 AA
+    
+
+### Fill Hover
+
+colour.system.danger.fillHover #A50606
+
+Used for the hover state of primary danger buttons.
+
+#### Allowed foregrounds
+
+*   colour.system.danger.onFill (#FFF6F5)
+    
+    7.5 AAA
+    
+
+### Surface
+
+colour.system.danger.surface #FEE8E7
+
+Used for the background colour of danger alerts and toasts, and the background of secondary danger buttons.
+
+#### Allowed foregrounds
+
+*   colour.system.danger.text (#970202)
+    
+    7.7 AAA
+    
+*   colour.neutral.80 (#393F46)
+    
+    9.1 AAA
+    
+
+### Text
+
+colour.system.danger.text #970202
+
+Used for the text colour of danger alerts and toasts, and danger tertiary buttons.
+
+#### Allowed foregrounds
+
+*   colour.system.danger.surface (#FEE8E7)
+    
+    7.7 AAA
+    
+
+### Surface Hover
+
+colour.system.danger.surfaceHover #FEDEDC
+
+Used for the hover state of secondary danger buttons.
+
+#### Allowed foregrounds
+
+*   colour.system.danger.text (#970202)
+    
+    7.2 AAA
+    
+*   colour.neutral.80 (#393F46)
+    
+    8.5 AAA
+    
+
+* * *
+
+### Warning
+
+Communicates attention required but does not prevent the user from moving forward with their task.
+
+### Fill
+
+colour.system.warning.fill #F6C84C
+
+Used for the border of warning alerts and the background of warning badges.
+
+#### Allowed foregrounds
+
+*   colour.system.warning.onFill (#1A1200)
+    
+    11.8 AAA
+    
+
+### On Fill
+
+colour.system.warning.onFill #1A1200
+
+Used for the foreground colour of warning badges.
+
+#### Allowed foregrounds
+
+*   colour.system.warning.fill (#F6C84C)
+    
+    11.8 AAA
+    
+
+### Surface
+
+colour.system.warning.surface #FEF4CD
+
+Used for the background colour of warning alerts.
+
+#### Allowed foregrounds
+
+*   colour.system.warning.text (#1A1200)
+    
+    16.8 AAA
+    
+*   colour.neutral.80 (#393F46)
+    
+    9.6 AAA
+    
+
+### Text
+
+colour.system.warning.text #1A1200
+
+Used for the text colour of warning alerts.
+
+#### Allowed foregrounds
+
+*   colour.system.warning.surface (#FEF4CD)
+    
+    16.8 AAA
+    
+
+* * *
+
+### Information
+
+* * *
+
+### Backdrop

package/generated/docs/tokens_elevation-docs.md

@@ -0,0 +1,39 @@
+Elevation
+=========
+
+Elevation is a design concept that adds depth and hierarchy to user interfaces by using shadows and layers. It helps users understand the relationship between different elements on the page, guiding their attention and interaction.
+
+Raised
+------
+
+Raised elevations sit slightly higher than default elevations. They are reserved for cards that can be moved, such as Jira issue cards and Trello cards. In special circumstances, they can be used for cards as a way to provide additional heirarchy or emphasis.
+
+elevation.raised
+
+Floating
+--------
+
+Floating is the highest elevation available. It is reserved for a UI that sits over another UI, such as modals, dialogs, dropdown menus, floating toolbars, and floating single-action buttons.
+
+elevation.floating
+
+Overflow
+--------
+
+Overflow is a shadow indicating content has scrolled outside a view. It can be used for vertical or horizontal scroll. An example of overflow shadows is the horizontal scroll in tables on a Confluence page.
+
+elevation.overflow
+
+Focus
+-----
+
+Focus is an outline indicating that an element is focused, usually via keyboard interaction. It is user when a user cannot interact with the page using a mouse/touch.
+
+elevation.focus
+
+Focus Compact
+-------------
+
+Focus compact is a variation of the focus elevation to indicate focus on elements that have restricted space making the default focus not aesthetically pleasing (for example, a search input in a dropdown like rich select). Avoid using where possible, as it makes the focus state less obvious.
+
+elevation.focusCompact

package/generated/docs/tokens_introduction-docs.md

@@ -0,0 +1,150 @@
+Tokens
+======
+
+Design tokens are an integral part of the design system. They help us create consistency across components by sharing common design decisions and simplify our theming ecosystem.
+
+What are tokens?
+----------------
+
+Tokens are a set of variables that define the design properties of a component. They are used to define the visual properties of a component, such as colours, typography, spacing, and more.
+
+Token list
+----------
+
+The table below shows all the new and old tokens in the design system. Use the filters to narrow down the list of tokens.
+
+Columns: 4 selected
+
+labelaliasdescriptionreadonly
+
+* * *
+
+typedefaultValuedeprecated
+
+None selected
+
+Show deprecated tokens
+
+Tokens (88)
+| Name
+ | Alias
+
+ | Description
+
+ | Themeable
+
+ |
+| --- | --- | --- | --- |
+| colour.primary.fill |  | Used for primary buttons and the active state of form controls such as checkboxes and radio buttons. Also used for the border of tags when they have a custom button. |  |
+| colour.primary.fillHover |  | Used for the hover state of primary buttons as well as hovering over active form controls. |  |
+| colour.primary.onFill |  | Used as the foreground colour on primary buttons and active form controls. |  |
+| colour.primary.surface |  | Used as the background colour for secondary buttons and the focused state of menu and tab items. Also used as the background colour of active buttons. |  |
+| colour.primary.surfaceHover |  | Used for the hover state of secondary buttons, form controls and hovering over focused menu and tab items. Also used when hovering over table rows. |  |
+| colour.primary.text |  | Used for text on primary buttons, active form controls and focused tab and menu items. Also used for the link text colour and tertiary buttons. |  |
+| colour.neutral.10 | page | Used as the default background colour for most components. For tooltips, it is used as the foreground colour for the tooltip content. |  |
+| colour.neutral.20 | alt | Used as the alternating background colour for components such as tables. Used as the background colour behind panels and cards for highly interactive screens. |  |
+| colour.neutral.30 |  | Used as the border colour for dividers, and the default divider colour for components with in-built headers and footers such as cards. |  |
+| colour.neutral.40 |  | Used for borders in subtle interactive components, such as checkboxes and radios with hidden controls and the progress bar. |  |
+| colour.neutral.50 |  | Used as the background colour for interactive components such as the slider. |  |
+| colour.neutral.60 |  | Used for placeholder text in form controls and disabled states. |  |
+| colour.neutral.70 | muted | Used for muted text such as hints and descriptions to allow for content hierarchy. |  |
+| colour.neutral.80 | text | Used as the default text colour for most components. For tooltips, it is used as the background colour. |  |
+| colour.accent.brand |  | The brand accent is useful for grabbing attention and to support your primary/brand colour. It should be used sparingly to draw attention to key elements. |  |
+| colour.system.success.fill |  | Used for the background colour of primary success buttons, as well as the border of alerts and badges. It is also used for the foreground colour of icons inside toasts and alerts. |  |
+| colour.system.success.fillHover |  | Used for the hover state of primary success buttons. |  |
+| colour.system.success.onFill |  | Used for the foreground colour of primary success buttons and badges. |  |
+| colour.system.success.surface |  | Used for the background colour of success alerts and toasts, and the background of secondary success buttons. |  |
+| colour.system.success.surfaceHover |  | Used for the hover state of secondary success buttons. |  |
+| colour.system.success.text |  | Used for the text colour of success alerts and toasts, and success tertiary buttons. |  |
+| colour.system.danger.fill |  | Used for the background colour of primary danger buttons, as well as the border of alerts and badges. It is also used for the foreground colour of icons inside toasts and alerts. |  |
+| colour.system.danger.fillHover |  | Used for the hover state of primary danger buttons. |  |
+| colour.system.danger.onFill |  | Used for the foreground colour of primary danger buttons and badges. |  |
+| colour.system.danger.surface |  | Used for the background colour of danger alerts and toasts, and the background of secondary danger buttons. |  |
+| colour.system.danger.surfaceHover |  | Used for the hover state of secondary danger buttons. |  |
+| colour.system.danger.text |  | Used for the text colour of danger alerts and toasts, and danger tertiary buttons. |  |
+| colour.system.warning.fill |  | Used for the border of warning alerts and the background of warning badges. |  |
+| colour.system.warning.onFill |  | Used for the foreground colour of warning badges. |  |
+| colour.system.warning.surface |  | Used for the background colour of warning alerts. |  |
+| colour.system.warning.text |  | Used for the text colour of warning alerts. |  |
+| colour.system.info.fill |  | Used for the border of info alerts and toasts and the background of info badges. |  |
+| colour.system.info.onFill |  | Used for the foreground colour of info badges. |  |
+| colour.system.info.surface |  | Used for the background colour of info alerts and toasts. |  |
+| colour.system.info.text |  | Used for the text colour of info alerts and toasts. |  |
+| colour.system.backdrop.fill |  | Used for the background colour of the backdrop. |  |
+| elevation.raised.shadow |  | Shadow for raised elevations |  |
+| elevation.raised.border |  | Border for raised elevations |  |
+| elevation.floating.shadow |  | Shadow for floating elevations |  |
+| elevation.floating.border |  | Border for floating elevations |  |
+| elevation.overflow.shadow |  | Shadow for overflow elevations |  |
+| elevation.overflow.border |  | Border for overflow elevations |  |
+| elevation.focus.shadow |  | Shadow for focus elevations |  |
+| elevation.focusCompact.shadow |  | Shadow for focus compact elevations |  |
+| elevation.focusCompact.borderColor |  | Border color for focus compact elevations |  |
+| radius.100 |  | The base unit for radius |  |
+| radius.000 | none | No radius |  |
+| radius.025 |  | 25% (0.25x) radius |  |
+| radius.050 |  | 50% (0.5x) radius |  |
+| radius.075 |  | 75% (0.75x) radius |  |
+| radius.system.badge |  | Applies to badges and tags (that have not been designated to be a circle). |  |
+| radius.system.button |  | Applies to buttons and other interactive elements such as the hover state of links. |  |
+| radius.system.form |  | Applies to form inputs and alerts. |  |
+| radius.system.layout |  | Applies to panels, modals and slideouts. |  |
+| spacing.100 | xs | The base unit for spacing |  |
+| spacing.150 |  | 150% (1.5x) spacing |  |
+| spacing.200 | sm | 200% (2x) spacing |  |
+| spacing.250 |  | 250% (2.5x) spacing |  |
+| spacing.300 |  | 300% (3x) spacing |  |
+| spacing.350 |  | 350% (3.5x) spacing |  |
+| spacing.400 | md | 400% (4x) spacing |  |
+| spacing.500 |  | 500% (5x) spacing |  |
+| spacing.600 | lg | 600% (6x) spacing |  |
+| spacing.700 |  | 700% (7x) spacing |  |
+| spacing.800 |  | 800% (8x) spacing |  |
+| spacing.900 |  | 900% (9x) spacing |  |
+| spacing.1000 |  | 1000% (10x) spacing |  |
+| spacing.1200 | xl | 1200% (12x) spacing |  |
+| spacing.000 | none | No spacing |  |
+| spacing.050 |  | 50% (0.5x) spacing |  |
+| typography.base.size |  | This is the base font size, and is used to calculate the font sizes of each token. |  |
+| typography.base.headingFont |  | This is the base font family for headings, used for heading tokens. |  |
+| typography.base.bodyFont |  | This is the base font family for body, used for body tokens. |  |
+| typography.heading.1 |  | Use for the main page title to establish a clear hierarchy. There is only one H1 per screen, emphasising the primary purpose or context of the page. |  |
+| 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. |  |
+| 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. |  |
+| 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. |  |
+| 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. |  |
+| typography.body.sm.regular |  | The default small text, most commonly used to display text in small components and compact tables and lists. |  |
+| typography.body.sm.strong |  | Strong text is used to highlight important information in a paragraph of text. |  |
+| typography.body.sm.em |  | Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes. |  |
+| typography.body.md.regular |  | The default medium text, most commonly used to display text across all products. |  |
+| typography.body.md.strong |  | Strong text is used to highlight important information in a paragraph of text. |  |
+| typography.body.md.em |  | Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes. |  |
+| typography.body.lg.regular |  | The default large text, most commonly used to display large text across all products. |  |
+| typography.body.lg.strong |  | Strong text is used to highlight important information in a paragraph of text. |  |
+| typography.body.lg.em |  | Emphasised text is used to highlight a term or definition in a paragraph of text. It is used sparingly, usually for legal purposes. |  |
+| typography.code |  | Used to display code snippets in the product, such as in the API documentation. |  |
+
+* * *
+
+For developers
+--------------
+
+If you are using the IDS components, the tokens have already been mapped out to their respective components. You can use the tokens in the component props to change the visual properties of the component.
+
+[
+
+Learn more about styling props
+
+](/?path=/docs/styling-props-reference--docs)
+
+import { IressText } from '@iress-oss/ids-components';
+<IressText color\="colour.primary.text"\>I am branded text</IressText\>;
+
+```
+
+If you are not using the IDS components, you can use the tokens directly by using the `cssVars` object from `@iress-oss/ids-tokens`.
+
+import { cssVars } from '@iress-oss/ids-tokens';
+<div style\={{ color: cssVars.colour.primary.text }}\>I am branded text</div\>;
+
+```