@iress-oss/ids-mcp-server 5.15.0 → 5.20.2

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

@@ -1,675 +0,0 @@
-[](#field)Field
-===============
-
-Overview
---------
-
-The field component is used to place label, hint and error information around form controls.
-
-First name
-
-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; }
-
-<IressField label\="First name"\>
-  <IressInput
-    id\="name"
-    name\="input1"
-    required
-    type\="text"
-  />
-</IressField\>
-
-Copy
-
-[](#examples)Examples
----------------------
-
-### [](#label)Label
-
-The `label` prop is required to describe the field.
-
-Find your address
-
-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; }
-
-<IressField label\={<span\><IressIcon name\="home" />{' '}Find your address</span\>}\>
-  <IressInput
-    id\="name"
-    name\="input1"
-    required
-    type\="text"
-  />
-</IressField\>
-
-Copy
-
-### [](#hint)Hint
-
-Extra information on the field can be provided using the `hint` prop. It can accept any React node, so you can add your own custom mark up (eg. external links) to the hint text.
-
-Email address
-
-For us to be able to contact you in the future
-
-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; }
-
-<IressField
-  hint\="For us to be able to contact you in the future"
-  label\="Email address"
-\>
-  <IressInput
-    id\="email"
-    name\="email"
-    required
-    type\="email"
-  />
-</IressField\>
-
-Copy
-
-### [](#error-message)Error message
-
-To display error messages associated with the field, you can use the `errorMessages` prop. This prop accepts an array of `ValidationMessageObj`, and will display each error message in a separate paragraph.
-
-**Note:** `IressField` requires validation to be handled by the consumer. If you want out-of-the-box validation, use [`IressFormField` alongside `IressForm` instead](./?path=/docs/components-form--docs#fields).
-
-Error message
-
-*   Error:
-    
-    This field is required
-    
-
-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; }
-
-<IressField
-  errorMessages\={\[
-    {
-      message: 'This field is required'
-    }
-  \]}
-  label\="Error message"
-\>
-  <IressInput    append={<IressButton data-testid\="show-password-icon" mode\="tertiary" prepend\={<IressIcon name\="fal fa-light fa-eye" screenreaderText\="Show" size\="sm" style\={{width: '18px'}}/>}/>}
-    id="name"    name="name"    required  />
-</IressField\>
-
-Copy
-
-### [](#custom-error)Custom error
-
-For more control over the formatting of the error, you can use the `error` prop. This prop accepts any React node, so you can add your own custom mark up (eg. icons) to the error message.
-
-**Note:** `IressField` requires validation to be handled by the consumer. If you want out-of-the-box validation, use [`IressFormField` alongside `IressForm` instead](./?path=/docs/components-form--docs#fields).
-
-Custom error
-
-Error:
-
-This is a custom error 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; }
-
-<IressField
-  error\={<IressValidationMessage\>This is a custom error message</IressValidationMessage\>}
-  label\="Custom error"
-\>
-  <IressInput
-    id\="name"
-    name\="name"
-    required
-  />
-</IressField\>
-
-Copy
-
-### [](#hidden-label)Hidden label
-
-There may be certain situations where you might want to (accessibly) hide the field label (in a search field for instance). This can be done by setting the `hiddenLabel` prop.
-
-This label is hidden
-
-This hint text is hidden
-
-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; }
-
-<IressField
-  hiddenLabel
-  hint\="This hint text is hidden"
-  label\="This label is hidden"
-\>
-  <IressInput
-    id\="name"
-    name\="input1"
-    required
-    type\="text"
-  />
-</IressField\>
-
-Copy
-
-This label is hidden
-
-This hint text is hidden
-
-Error:
-
-Even fields with hidden labels will show their 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; }
-
-<IressField
-  error\={<IressValidationMessage\>Even fields with hidden labels will show their validation message</IressValidationMessage\>}
-  hiddenLabel
-  hint\="This hint text is hidden"
-  label\="This label is hidden"
-\>
-  <IressInput
-    id\="name"
-    name\="input1"
-    required
-    type\="text"
-  />
-</IressField\>
-
-Copy
-
-### [](#required)Required
-
-Fields marked as `required` will have an asterisk prepended to the label.
-
-\*Required This field is required
-
-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; }
-
-<IressField
-  label\="This field is required"
-  required
-\>
-  <IressInput
-    id\="name"
-    name\="input1"
-    required
-    type\="text"
-  />
-</IressField\>
-
-Copy
-
-### [](#optional)Optional
-
-Fields marked as `optional` will have optional text appended to the label. This is used in cases where the majority of the fields are required, and you only want to highlight the optional fields and not overwhelm the user.
-
-You can set `optional` to a string to customise the optional text.
-
-This field is optional(optional)
-
-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; }
-
-<IressField
-  label\="This field is optional"
-  optional
-\>
-  <IressInput
-    id\="name"
-    name\="input1"
-    required
-    type\="text"
-  />
-</IressField\>
-
-Copy
-
-### [](#readonly-data)Readonly data
-
-Fields can be used to display read-only data. This is useful when you want to display data that the user can't change, but you still want to display it in a form-like layout.
-
-You can also pass `readOnly` prop to remove the asterisk symbol (\*) even when the field is `required`.
-
-First name
-
-This field is readonly
-
-Luke Skywalker
-
-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; }
-
-<IressField
-  hint\="This field is readonly"
-  label\="First name"
-  readOnly
-  required
-\>
-  <IressReadonly
-    id\="name"
-    name\="input1"
-    required
-    type\="text"
-    value\="Luke Skywalker"
-  />
-</IressField\>
-
-Copy
-
-[](#iressfieldgroup)`IressFieldGroup`
--------------------------------------
-
-The `IressFieldGroup` component is used to group multiple `Field` components together. This is useful when you have multiple fields that are related to each other, and you want to display them together.
-
-Under the hood it uses a `fieldset` and `legend` element to group the fields together, improving the semantics of your form if you use multiple inputs (eg. in the case of a checkbox group) and making it more accessible.
-
-Full name
-
-Title
-
-\*Required First name
-
-\*Required Last name
-
-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; }
-
-<IressFieldGroup label\="Full name"\>
-  <IressField
-    htmlFor\="title"
-    label\="Title"
-  \>
-    <IressInput
-      id\="title"
-      name\="title"
-      type\="text"
-      width\="2"
-    />
-  </IressField\>
-  <IressField
-    htmlFor\="firstName"
-    label\="First name"
-    required
-  \>
-    <IressInput
-      id\="firstName"
-      name\="firstName"
-      required
-      type\="text"
-    />
-  </IressField\>
-  <IressField
-    htmlFor\="lastName"
-    label\="Last name"
-    required
-  \>
-    <IressInput
-      id\="lastName"
-      name\="lastName"
-      required
-      type\="text"
-    />
-  </IressField\>
-</IressFieldGroup\>
-
-Copy
-
-### [](#inline)Inline
-
-Multiple fields can be displayed inline using the `inline` prop. On smaller screens, inline elements will wrap on to a new line if there's not enough space for everything on one line.
-
-Full name
-
-Title
-
-\*Required First name
-
-\*Required Last name
-
-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; }
-
-<IressFieldGroup
-  inline
-  label\="Full name"
-\>
-  <IressField
-    htmlFor\="title"
-    label\="Title"
-  \>
-    <IressInput
-      id\="title"
-      name\="title"
-      type\="text"
-      width\="2"
-    />
-  </IressField\>
-  <IressField
-    htmlFor\="firstName"
-    label\="First name"
-    required
-  \>
-    <IressInput
-      id\="firstName"
-      name\="firstName"
-      required
-      type\="text"
-    />
-  </IressField\>
-  <IressField
-    htmlFor\="lastName"
-    label\="Last name"
-    required
-  \>
-    <IressInput
-      id\="lastName"
-      name\="lastName"
-      required
-      type\="text"
-    />
-  </IressField\>
-</IressFieldGroup\>
-
-Copy
-
-Full name
-
-Emoji
-
-Title
-
-MrMrsMiss
-
-\*Required First name
-
-\*Required Last name
-
-Submit
-
-Settings goes here
-
-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; }
-
-<form\>
-  <IressFieldGroup
-    inline
-    label\="Full name"
-  \>
-    <IressField
-      htmlFor\="emoji"
-      label\="Emoji"
-    \>
-      <IressRichSelect
-        container\={document.body}
-        id\="emoji"
-        options\={\[
-          {
-            label: '🐶',
-            value: 'dog'
-          },
-          {
-            label: '🐱',
-            value: 'cat'
-          },
-          {
-            label: '🐭',
-            value: 'mouse'
-          }
-        \]}
-        width\="2"
-      />
-    </IressField\>
-    <IressField
-      htmlFor\="title"
-      label\="Title"
-    \>
-      <IressSelect
-        id\="title"
-        width\="2"
-      \>
-        <option value\="mr"\>
-          Mr        </option\>
-        <option value\="mrs"\>
-          Mrs        </option\>
-        <option value\="miss"\>
-          Miss        </option\>
-      </IressSelect\>
-    </IressField\>
-    <IressField
-      htmlFor\="firstName"
-      label\="First name"
-      required
-    \>
-      <IressInput
-        id\="firstName"
-        required
-      />
-    </IressField\>
-    <IressField
-      htmlFor\="lastName"
-      label\="Last name"
-      required
-    \>
-      <IressInput
-        id\="lastName"
-        required
-      />
-    </IressField\>
-    <IressButton type\="submit"\>
-      Submit    </IressButton\>
-    <IressPopover activator\={<IressButton\><IressIcon name\="cog" /></IressButton\>}\>
-      <IressPanel\>
-        Settings goes here      </IressPanel\>
-    </IressPopover\>
-  </IressFieldGroup\>
-</form\>
-
-Copy
-
-### [](#join)Join
-
-Elements can also be joined together using the `join` prop. Joined elements won't wrap on to a new line, so make sure you test your designs on small screens; depending on the use case, you may be better off with a standard inline layout (or two separate fields!).
-
-**Note:** The `join` prop works out of the box with IDS components. To enable your custom components to work with the `join` prop, you need to ensure the direct child of `IressFieldGroup` has the class `GlobalCSSClass.FormElement`. If the direct child is not the element with the border, add the class `GlobalCSSClass.FormElementInner` to the element with the border.
-
-Full name
-
-Title
-
-\*Required First name
-
-\*Required Last name
-
-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; }
-
-<IressFieldGroup
-  join
-  label\="Full name"
-\>
-  <IressField
-    htmlFor\="title"
-    label\="Title"
-  \>
-    <IressInput
-      id\="title"
-      name\="title"
-      type\="text"
-      width\="2"
-    />
-  </IressField\>
-  <IressField
-    htmlFor\="firstName"
-    label\="First name"
-    required
-  \>
-    <IressInput
-      id\="firstName"
-      name\="firstName"
-      required
-      type\="text"
-    />
-  </IressField\>
-  <IressField
-    htmlFor\="lastName"
-    label\="Last name"
-    required
-  \>
-    <IressInput
-      id\="lastName"
-      name\="lastName"
-      required
-      type\="text"
-    />
-  </IressField\>
-</IressFieldGroup\>
-
-Copy
-
-Full name
-
-Emoji
-
-Title
-
-MrMrsMiss
-
-\*Required First name
-
-\*Required Last name
-
-Submit
-
-Settings goes here
-
-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; }
-
-<form\>
-  <IressFieldGroup
-    inline
-    join
-    label\="Full name"
-  \>
-    <IressField
-      htmlFor\="emoji"
-      label\="Emoji"
-    \>
-      <IressRichSelect
-        container\={document.body}
-        id\="emoji"
-        options\={\[
-          {
-            label: '🐶',
-            value: 'dog'
-          },
-          {
-            label: '🐱',
-            value: 'cat'
-          },
-          {
-            label: '🐭',
-            value: 'mouse'
-          }
-        \]}
-        width\="2"
-      />
-    </IressField\>
-    <IressField
-      htmlFor\="title"
-      label\="Title"
-    \>
-      <IressSelect
-        id\="title"
-        width\="2"
-      \>
-        <option value\="mr"\>
-          Mr        </option\>
-        <option value\="mrs"\>
-          Mrs        </option\>
-        <option value\="miss"\>
-          Miss        </option\>
-      </IressSelect\>
-    </IressField\>
-    <IressField
-      htmlFor\="firstName"
-      label\="First name"
-      required
-    \>
-      <IressInput
-        id\="firstName"
-        required
-      />
-    </IressField\>
-    <IressField
-      htmlFor\="lastName"
-      label\="Last name"
-      required
-    \>
-      <IressInput
-        id\="lastName"
-        required
-      />
-    </IressField\>
-    <IressButton type\="submit"\>
-      Submit    </IressButton\>
-    <IressPopover activator\={<IressButton\><IressIcon name\="cog" /></IressButton\>}\>
-      <IressPanel\>
-        Settings goes here      </IressPanel\>
-    </IressPopover\>
-  </IressFieldGroup\>
-</form\>
-
-Copy
-
-[](#iressform-integration)`IressForm` integration
--------------------------------------------------
-
-As of version 5, `IressField` is a standalone component and does not handle validation.
-
-If you want out-of-the-box validation, use the `IressFormField` inside an `IressForm`. This will handle validation for you, and provide a consistent way to handle form state.
-
-[
-
-View forms documentation for fields
-
-](/?path=/docs/components-form--docs#fields)
-
-On this page
-
-*   [Overview](#overview)
-*   [Props](#props)
-*   [Examples](#examples)
-    *   [Label](#label)
-    *   [Hint](#hint)
-    *   [Error message](#error-message)
-    *   [Custom error](#custom-error)
-    *   [Hidden label](#hidden-label)
-    *   [Required](#required)
-    *   [Optional](#optional)
-    *   [Readonly data](#readonly-data)
-*   [IressFieldGroup](#iressfieldgroup)
-    *   [Inline](#inline)
-    *   [Join](#join)
-*   [IressForm integration](#iressform-integration)