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

package/generated/docs/components_components-readonly-docs.md

@@ -0,0 +1,263 @@
+Readonly
+========
+
+Overview
+--------
+
+Readonly displays a value that cannot be edited by the user. It renders a hidden input field to ensure the value is submitted with the form.
+
+[](./iframe.html?id=components-readonly--default)
+
+AU
+
+```
+
+<IressReadonly
+  append\=""
+  prepend\=""
+  value\="AU"
+/>
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| append | 
+string
+
+
+
+ | \- |  |
+| children | 
+
+The formatted value. If not provided, the value will be displayed.
+
+ReactNode
+
+
+
+ | \- | \- |
+| inline | 
+
+boolean
+
+
+
+ | \- | Set boolean |
+| prepend | 
+
+string
+
+
+
+ | \- |  |
+| value | 
+
+string
+
+
+
+ | \- | AU |
+
+Examples
+--------
+
+### Rich Content
+
+You can pass in stylised content that represents the value by using the `children` prop. If no `children` is provided, it will display the `value` directly.
+
+[](./iframe.html?id=components-readonly--rich-content)
+
+Australia
+
+```
+
+<IressReadonly
+  append\=""
+  prepend\=""
+  value\="AU"
+\>
+  <IressInline
+    gutter\="sm"
+    verticalAlign\="middle"
+  \>
+    <IressIcon name\="flag" />
+    {' '}Australia
+  </IressInline\>
+</IressReadonly\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| append | 
+string
+
+
+
+ | \- |  |
+| children | 
+
+The formatted value. If not provided, the value will be displayed.
+
+ReactNode
+
+
+
+ | \- | \- |
+| inline | 
+
+boolean
+
+
+
+ | \- | Set boolean |
+| prepend | 
+
+string
+
+
+
+ | \- |  |
+| value | 
+
+string
+
+
+
+ | \- | AU |
+
+### Inline
+
+You can make the prepend/append element closer to the input content using the `inline` prop.
+
+[](./iframe.html?id=components-readonly--inline-style)
+
+Prepend
+
+Australia
+
+Append
+
+```
+
+<IressReadonly
+  append\={<IressText mode\="muted"\>Append</IressText\>}
+  inline
+  prepend\={<IressText mode\="muted"\>Prepend</IressText\>}
+  value\="AU"
+\>
+  <IressInline
+    gutter\="sm"
+    verticalAlign\="middle"
+  \>
+    <IressIcon name\="flag" />
+    {' '}Australia
+  </IressInline\>
+</IressReadonly\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| append | 
+object
+
+
+
+ | \- | 
+
+RAW
+
+append :
+
+{
+
+*   $$typeof : Symbol(react.transitional.element)
+*   type : ({ align, children, className, "data-testid": dataTestId, element: Tag = "div", mode, noGutter, variant, ...restProps }) => /\* @\_\_PURE\_\_ \*/ jsxDEV( Tag, { ...restProps, className: classNames(className, "iress-u-text", { \[\`iress--${variant}\`\]: Boolean(variant), \[\`iress--${mode}\`\]: Boolean(mode), \[\`${GlobalCSSClass.TextAlignBase}--${align}\`\]: Boolean(align), "iress--no-gutter": noGutter }), "data-testid": dataTestId, children }, void 0, false, { fileName: "/home/runner/work/design-system/design-system/packages/components/src/components/Text/Text.tsx", lineNumber: 22, columnNumber: 1 }, this )
+*   key : null
+*   props :
+    
+    {...} 2 keys
+    
+*   \_owner : null
+*   \_store :
+    
+    {...} 0 keys
+    
+
+}
+
+
+
+
+
+
+
+ |
+| children | 
+
+The formatted value. If not provided, the value will be displayed.
+
+ReactNode
+
+
+
+ | \- | \- |
+| inline | 
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| prepend | 
+
+object
+
+
+
+ | \- | 
+
+RAW
+
+prepend :
+
+{
+
+*   $$typeof : Symbol(react.transitional.element)
+*   type : ({ align, children, className, "data-testid": dataTestId, element: Tag = "div", mode, noGutter, variant, ...restProps }) => /\* @\_\_PURE\_\_ \*/ jsxDEV( Tag, { ...restProps, className: classNames(className, "iress-u-text", { \[\`iress--${variant}\`\]: Boolean(variant), \[\`iress--${mode}\`\]: Boolean(mode), \[\`${GlobalCSSClass.TextAlignBase}--${align}\`\]: Boolean(align), "iress--no-gutter": noGutter }), "data-testid": dataTestId, children }, void 0, false, { fileName: "/home/runner/work/design-system/design-system/packages/components/src/components/Text/Text.tsx", lineNumber: 22, columnNumber: 1 }, this )
+*   key : null
+*   props :
+    
+    {...} 2 keys
+    
+*   \_owner : null
+*   \_store :
+    
+    {...} 0 keys
+    
+
+}
+
+
+
+
+
+
+
+ |
+| value | 
+
+string
+
+
+
+ | \- | AU |