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

package/generated/docs/components-tooltip-docs.md

@@ -1,311 +0,0 @@
-[](#tooltip)Tooltip
-===================
-
-Overview
---------
-
-A component that shows concise, informative text about an element when focussed upon, hovered over or on a long touch.
-
-Hover me
-
-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; }
-
-<IressTooltip tooltipText\="Hello! This is a really long tooltip to try and see if it goes behind the scrollbar"\>
-  <IressButton\>
-    Hover me  </IressButton\>
-</IressTooltip\>
-
-Copy
-
-[](#usage)Usage
----------------
-
-The content that will be displayed in the tooltip is passed using the `tooltipText` prop.
-
-This content can only be plain text; there is no parsing of any markup or styling. This is by design as we do not allow complex structures in a tooltip as they are meant to be concise, informative pieces of text.
-
-Text content will wrap on to a new line if it exceeds the tooltip's maximum width. You can also manually format your content into multiple lines by passing an array of strings into the `tooltipText` prop.
-
-Single line
-
-Multi line
-
-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; }
-
-<div
-  style\={{
-    paddingTop: '30px'
-  }}
-\>
-  <IressInline gutter\="md"\>
-    <IressTooltip tooltipText\="Single line Hello! This is a really long tooltip to try and see if it goes behind the scrollbar"\>
-      <IressButton\>
-        Single line      </IressButton\>
-    </IressTooltip\>
-    <IressTooltip
-      tooltipText\={\[
-        'This tooltip',
-        'has multiple lines'
-      \]}
-    \>
-      <IressButton\>
-        Multi line      </IressButton\>
-    </IressTooltip\>
-  </IressInline\>
-</div\>
-
-Copy
-
-[](#behaviour)Behaviour
------------------------
-
-The behaviour of tooltips varies according to how they're shown:
-
-*   When a pointer is moved over the activator the tooltip will be shown, and will remain visible for a short period of time after the pointer has moved away (500ms is the default time)
-*   If the activator receives keyboard focus the tooltip will be visible. The tooltip will hide immediately after the focus moves away from the activator.
-*   If the user long presses on the activator (on a touch device). The tooltip will remain visible until the user taps somewhere else on the screen
-
-If the user activates a tooltip via a pointing device and then moves the pointer over the tooltip, it will remain on screen until the pointer is moved away. This is for accessibility purposes where a user may be using magnifying software for example.
-
-[](#accessibility)Accessibility
--------------------------------
-
-The WCAG guidelines for content that is displayed on hover or focus can be found here: [WCAG 2.1 - 1.4.13 (AA)](https://www.w3.org/TR/WCAG21/#content-on-hover-or-focus).
-
-Other things to keep in mind:
-
-*   For best accessibility, you should only use tooltips on focusable items (eg. `IressButton` and `IressMenuItem`), allowing them to be seen when navigating to the tooltip activator by keyboard
-
-**Notes:**
-
-*   If the text you wish to display is more than a handful of words then consider using an IressModal with an information button.
-*   Tooltips must not be used for help text as they are not immediately visible to the user. We suggest adding hint text to assist the user when filling out forms.
-*   Also think about placement using the align prop. The tooltip should not obscure any critical screen content. Another reason to keep them short.
-
-[](#examples)Examples
----------------------
-
-### [](#align)Align
-
-The tooltip can be aligned in one of 12 positions relative to the activator element.
-
-The tooltip's position will change dynamically based on the amount of space available in its container window, so that it doesn't overflow the edge. For example, if the tooltip is about to scroll off the top of the screen, it will change its position to bottom. Likewise with left and right scrolling.
-
-Top Start
-
-Top
-
-Top End
-
-Left Start
-
-Left
-
-Left End
-
-Right Start
-
-Right
-
-Right End
-
-Bottom Start
-
-Bottom
-
-Bottom End
-
-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; }
-
-<div
-  style\={{
-    padding: '80px 150px'
-  }}
-\>
-  <IressStack gutter\="md"\>
-    <IressInline
-      gutter\="sm"
-      horizontalAlign\="center"
-    \>
-      <IressTooltip
-        align\="top-start"
-        tooltipText\="Hello!"
-      \>
-        <IressButton\>
-          Top Start        </IressButton\>
-      </IressTooltip\>
-      <IressTooltip
-        align\="top"
-        tooltipText\="Hello!"
-      \>
-        <IressButton\>
-          Top        </IressButton\>
-      </IressTooltip\>
-      <IressTooltip
-        align\="top-end"
-        tooltipText\="Hello!"
-      \>
-        <IressButton\>
-          Top End        </IressButton\>
-      </IressTooltip\>
-    </IressInline\>
-    <IressInline horizontalAlign\="between"\>
-      <IressStack gutter\="sm"\>
-        <IressInline horizontalAlign\="left"\>
-          <IressTooltip
-            align\="left-start"
-            tooltipText\="Hello!"
-          \>
-            <IressButton\>
-              Left Start            </IressButton\>
-          </IressTooltip\>
-        </IressInline\>
-        <IressInline horizontalAlign\="left"\>
-          <IressTooltip
-            align\="left"
-            tooltipText\="Hello!"
-          \>
-            <IressButton\>
-              Left            </IressButton\>
-          </IressTooltip\>
-        </IressInline\>
-        <IressInline horizontalAlign\="left"\>
-          <IressTooltip
-            align\="left-end"
-            tooltipText\="Hello!"
-          \>
-            <IressButton\>
-              Left End            </IressButton\>
-          </IressTooltip\>
-        </IressInline\>
-      </IressStack\>
-      <IressStack gutter\="sm"\>
-        <IressInline horizontalAlign\="right"\>
-          <IressTooltip
-            align\="right-start"
-            tooltipText\="Hello!"
-          \>
-            <IressButton\>
-              Right Start            </IressButton\>
-          </IressTooltip\>
-        </IressInline\>
-        <IressInline horizontalAlign\="right"\>
-          <IressTooltip
-            align\="right"
-            tooltipText\="Hello!"
-          \>
-            <IressButton\>
-              Right            </IressButton\>
-          </IressTooltip\>
-        </IressInline\>
-        <IressInline horizontalAlign\="right"\>
-          <IressTooltip
-            align\="right-end"
-            tooltipText\="Hello!"
-          \>
-            <IressButton\>
-              Right End            </IressButton\>
-          </IressTooltip\>
-        </IressInline\>
-      </IressStack\>
-    </IressInline\>
-    <IressInline
-      gutter\="sm"
-      horizontalAlign\="center"
-    \>
-      <IressTooltip
-        align\="bottom-start"
-        tooltipText\="Hello!"
-      \>
-        <IressButton\>
-          Bottom Start        </IressButton\>
-      </IressTooltip\>
-      <IressTooltip
-        align\="bottom"
-        tooltipText\="Hello!"
-      \>
-        <IressButton\>
-          Bottom        </IressButton\>
-      </IressTooltip\>
-      <IressTooltip
-        align\="bottom-end"
-        tooltipText\="Hello!"
-      \>
-        <IressButton\>
-          Bottom End        </IressButton\>
-      </IressTooltip\>
-    </IressInline\>
-  </IressStack\>
-</div\>
-
-Copy
-
-### [](#delay)Delay
-
-The `delay` prop requires a number that is the number of milliseconds that pass after the activator has received a `mouseEnter` event and the display of the tooltip.
-
-0ms (no delay)
-
-500ms (default)
-
-2000ms
-
-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; }
-
-<div
-  style\={{
-    paddingTop: '30px'
-  }}
-\>
-  <IressInline
-    gutter\="sm"
-    horizontalAlign\="center"
-  \>
-    <IressTooltip
-      delay\={0}
-      tooltipText\="Hello!"
-    \>
-      <IressButton\>
-        0ms (no delay)      </IressButton\>
-    </IressTooltip\>
-    <IressTooltip tooltipText\="Hello!"\>
-      <IressButton\>
-        500ms (default)      </IressButton\>
-    </IressTooltip\>
-    <IressTooltip
-      delay\={2000}
-      tooltipText\="Hello!"
-    \>
-      <IressButton\>
-        2000ms      </IressButton\>
-    </IressTooltip\>
-  </IressInline\>
-</div\>
-
-Copy
-
-### [](#the-title-attribute)The title attribute
-
-The component will not make any provision for existing title HTML attributes. If one exists, it will be activated along with the tooltip, potentially overlaying it making it difficult to ascertain the information being imparted. The title could also contain different content to the tooltip increasing the chance of confusing the end user.
-
-We suggest removing the title attribute on elements that will use tooltip.
-
-On this page
-
-*   [Overview](#overview)
-*   [Props](#props)
-*   [Usage](#usage)
-*   [Behaviour](#behaviour)
-*   [Accessibility](#accessibility)
-*   [Examples](#examples)
-    *   [Align](#align)
-    *   [Delay](#delay)
-    *   [The title attribute](#the-title-attribute)

package/generated/docs/components-validationmessage-docs.md

@@ -1,241 +0,0 @@
-[](#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.
-
-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
----------------------
-
-### [](#status)Status
-
-Validation status is controled by the status prop. It defaults to `error`.
-
-Error:
-
-Something is wrong.
-
-Info:
-
-Something you should know.
-
-Success:
-
-Something went right.
-
-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"\>
-    Something is wrong.  </IressValidationMessage\>
-  <IressValidationMessage status\="info"\>
-    Something you should know.  </IressValidationMessage\>
-  <IressValidationMessage status\="success"\>
-    Something went right.  </IressValidationMessage\>
-  <IressValidationMessage status\="warning"\>
-    Something could go wrong.  </IressValidationMessage\>
-</IressStack\>
-
-Copy
-
-### [](#prefix)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`.
-
-Prefix:
-
-Something is wrong.
-
-Prefix:
-
-Something you should know.
-
-Prefix:
-
-Something went right.
-
-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
-    prefix\="Prefix: "
-    status\="danger"
-    visiblePrefix
-  \>
-    Something is wrong.  </IressValidationMessage\>
-  <IressValidationMessage
-    prefix\="Prefix: "
-    status\="info"
-    visiblePrefix
-  \>
-    Something you should know.  </IressValidationMessage\>
-  <IressValidationMessage
-    prefix\="Prefix: "
-    status\="success"
-    visiblePrefix
-  \>
-    Something went right.  </IressValidationMessage\>
-  <IressValidationMessage
-    prefix\="Prefix: "
-    status\="warning"
-    visiblePrefix
-  \>
-    Something could go wrong.  </IressValidationMessage\>
-</IressStack\>
-
-Copy
-
-[](#iressvalidationlink)`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.
-
-[
-
-Error:
-
-Something is wrong.
-
-](#input)[
-
-Info:
-
-Something you should know.
-
-](#input)[
-
-Success:
-
-Something went right.
-
-](#input)[
-
-Warning:
-
-Something could go wrong.
-
-](#input)
-
-* * *
-
-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\>
-    <IressValidationLink
-      linkToTarget\="input"
-      status\="danger"
-    \>
-      Something is wrong.    </IressValidationLink\>
-    <IressValidationLink
-      linkToTarget\="input"
-      status\="info"
-    \>
-      Something you should know.    </IressValidationLink\>
-    <IressValidationLink
-      linkToTarget\="input"
-      status\="success"
-    \>
-      Something went right.    </IressValidationLink\>
-    <IressValidationLink
-      linkToTarget\="input"
-      status\="warning"
-    \>
-      Something could go wrong.    </IressValidationLink\>
-  </IressStack\>
-  <IressDivider />
-  <IressInput id\="input" />
-</IressStack\>
-
-Copy
-
-[](#iressvalidationsummary)`IressValidationSummary`
----------------------------------------------------
-
-Messages can be passed programmatically as a `ValidationMessageObj[]` using the `messages` prop of the `IressValidationSummary` component.
-
-*   Info:
-    
-    Something you should know.
-    
-*   Error:
-    
-    Something is wrong.
-    
-*   Warning:
-    
-    Something could go wrong.
-    
-*   Success:
-    
-    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)

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

@@ -1,27 +0,0 @@
-[](#contact-us)Contact us
-=========================
-
-[](#help-desk)Help desk
------------------------
-
-Use the [FEE Help Desk](https://iress-wealth.atlassian.net/servicedesk/customer/portal/5) for any support enquiries, including:
-
-*   [Reporting a bug](https://iress-wealth.atlassian.net/servicedesk/customer/portal/5/group/5/create/9)
-*   [Requesting a new feature](https://iress-wealth.atlassian.net/servicedesk/customer/portal/5/group/5/create/10)
-*   [Asking a question](https://iress-wealth.atlassian.net/servicedesk/customer/portal/5/group/5/create/11)
-
-[](#atlas)Atlas
----------------
-
-Follow us on [Atlas](https://team.atlassian.com/tag/14d19917-b7fe-4088-954e-76e5f443179a) for the latest updates on Front-End Enablement projects, including IDS.
-
-[](#team)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.
-
-On this page
-
-*   [Help desk](#help-desk)
-*   [Atlas](#atlas)
-*   [Team](#team)