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

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

@@ -0,0 +1,241 @@
+[](#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

@@ -0,0 +1,27 @@
+[](#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)