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

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

@@ -0,0 +1,1468 @@
+Input
+=====
+
+Overview
+--------
+
+Inputs allow a user to input and interact with data. This component should be used as a child of the `IressField` component to ensure the correct placement of elements like label, error & hint text.
+
+[](./iframe.html?id=components-input--default)
+
+```
+
+<ForwardedInput
+  append\=""
+  placeholder\="Enter your name"
+  prepend\=""
+/>
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | 
+
+""
+
+ |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter your name |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | 
+
+""
+
+ |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | Set object |
+
+Examples
+--------
+
+### Types
+
+The input component's `type` can be set to one of the following value: `text` (default), `date`, `email`, `number`, `password`, `search`, `tel`, `url`, `time`, `color` and `file`.
+
+For more information about each type, please see the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types).
+
+[](./iframe.html?id=components-input--types)
+
+```
+
+<IressStack gutter\="md"\>
+  <ForwardedInput
+    placeholder\="Text input"
+    type\="text"
+  />
+  <ForwardedInput
+    placeholder\="Color input"
+    type\="color"
+  />
+  <ForwardedInput
+    placeholder\="Date input"
+    type\="date"
+  />
+  <ForwardedInput
+    placeholder\="Datetime-local input"
+    type\="datetime-local"
+  />
+  <ForwardedInput
+    placeholder\="Email input"
+    type\="email"
+  />
+  <ForwardedInput
+    placeholder\="File input"
+    type\="file"
+  />
+  <ForwardedInput
+    placeholder\="Month input"
+    type\="month"
+  />
+  <ForwardedInput
+    placeholder\="Number input"
+    type\="number"
+  />
+  <ForwardedInput
+    placeholder\="Password input"
+    type\="password"
+  />
+  <ForwardedInput
+    placeholder\="Search input"
+    type\="search"
+  />
+  <ForwardedInput
+    placeholder\="Tel input"
+    type\="tel"
+  />
+  <ForwardedInput
+    placeholder\="Time input"
+    type\="time"
+  />
+  <ForwardedInput
+    placeholder\="Url input"
+    type\="url"
+  />
+  <ForwardedInput
+    placeholder\="Week input"
+    type\="week"
+  />
+</IressStack\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| type | 
+
+\-
+
+ | \- | \- |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | Set object |
+
+Hidden inputs
+-------------
+
+If you need to use a hidden input in a form, you can use a native Input element with its `type` set to `hidden`. Remember to set the `name` attribute so it can be included in form submissions.
+
+### Input modes
+
+The `inputmode` attribute provides a hint to browsers for devices with onscreen keyboards (usually mobile devices) to help them decide which keyboard to display when a user has selected any input or textarea element.
+
+For more information about each mode (and their expected user experience), please see the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).
+
+[](./iframe.html?id=components-input--input-modes)
+
+```
+
+<IressStack gutter\="md"\>
+  <ForwardedInput
+    inputMode\="text"
+    placeholder\="Text mode, usually best used when type=&quot;text&quot; "
+  />
+  <ForwardedInput
+    inputMode\="tel"
+    placeholder\="Tel mode, usually best used when type=&quot;tel&quot; "
+  />
+  <ForwardedInput
+    inputMode\="url"
+    placeholder\="Url mode, usually best used when type=&quot;url&quot; "
+  />
+  <ForwardedInput
+    inputMode\="email"
+    placeholder\="Email mode, usually best used when type=&quot;email&quot; "
+  />
+  <ForwardedInput
+    inputMode\="numeric"
+    placeholder\="Numeric mode, usually best used when type=&quot;numeric&quot; "
+  />
+  <ForwardedInput
+    inputMode\="decimal"
+    placeholder\="Decimal mode, usually best used when type=&quot;decimal&quot; "
+  />
+  <ForwardedInput
+    inputMode\="search"
+    placeholder\="Search mode, usually best used when type=&quot;search&quot; "
+  />
+</IressStack\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| inputMode | 
+
+\-
+
+ | \- | \- |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | Set object |
+
+### Clearable
+
+By setting the `clearable` prop to `true` a clear button will appear when the user has entered a value into the input.
+
+Clearing will set the focus on the input and trigger the `onClear` handler. Use this handler to clear the input value if your input is controlled.
+
+[](./iframe.html?id=components-input--clearable)
+
+```
+
+<ForwardedInput
+  clearable
+  placeholder\="Search"
+  prepend\={<IressIcon name\="search" />}
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| placeholder | 
+
+string
+
+
+
+ | \- | Search |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | 
+
+RAW
+
+prepend :
+
+{
+
+*   $$typeof : Symbol(react.transitional.element)
+*   type :
+    
+    {...} 9 keys
+    
+*   key : null
+*   props :
+    
+    {...} 1 key
+    
+*   \_owner : null
+*   \_store :
+    
+    {...} 0 keys
+    
+
+}
+
+
+
+
+
+
+
+ |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | Set object |
+
+### Sizing
+
+Inputs can be resized to suit a specific number of characters. This sets an expectation of what data a user has to enter; for example using the `Sixteen` width for a credit card number.
+
+The width in this case refers to the actual input and ensures that it is wide enough for a set number of characters. If you add any appended or prepended content, the overall size of the `IressInput` will increase.
+
+Widths can also be set as a percentage, allowing the input to take up a proportion of the width of its container. In this case, the width of the actual input decreases if you add appended or prepended content.
+
+[](./iframe.html?id=components-input--sizing)
+
+```
+
+<IressStack gutter\="md"\>
+  <ForwardedInput
+    placeholder\="2"
+    width\="2"
+  />
+  <ForwardedInput
+    placeholder\="4"
+    width\="4"
+  />
+  <ForwardedInput
+    placeholder\="6"
+    width\="6"
+  />
+  <ForwardedInput
+    placeholder\="8"
+    width\="8"
+  />
+  <ForwardedInput
+    placeholder\="10"
+    width\="10"
+  />
+  <ForwardedInput
+    placeholder\="12"
+    width\="12"
+  />
+  <ForwardedInput
+    placeholder\="16"
+    width\="16"
+  />
+  <ForwardedInput
+    placeholder\="25perc"
+    width\="25perc"
+  />
+  <ForwardedInput
+    placeholder\="50perc"
+    width\="50perc"
+  />
+  <ForwardedInput
+    placeholder\="75perc"
+    width\="75perc"
+  />
+  <ForwardedInput
+    placeholder\="100perc"
+    width\="100perc"
+  />
+</IressStack\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | \- |
+
+### Textareas
+
+You can also use `IressInput` to render a `textarea` instead of an `input`. Simply set the rows prop to the number of lines of text you'd like to display. This will set the height of the `textarea`; if a user enters more lines of text than the number of rows, a scrollbar will be displayed.
+
+[](./iframe.html?id=components-input--text-areas)
+
+```
+
+<ForwardedInput rows\={5} />
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| rows | 
+
+number
+
+
+
+ | \- |  |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | Set object |
+
+### Slot props
+
+Content (typically icons) can be added to slots (`append` and `prepend`) within the `IressInput` component.
+
+*   **Prepend**: appears before the input
+*   **Append**: appears after the input
+
+By setting the watermark prop to true the add ons will render in a different style, which is set in the theme.
+
+[](./iframe.html?id=components-input--slots)
+
+```
+
+<IressStack gutter\="md"\>
+  <ForwardedInput
+    placeholder\="Prepend slot"
+    prepend\={<IressIcon name\="search" />}
+  />
+  <ForwardedInput
+    append\={<IressIcon name\="search" />}
+    placeholder\="Append slot"
+  />
+  <ForwardedInput
+    placeholder\="Watermark prepend slot"
+    prepend\={<IressIcon name\="search" />}
+    watermark
+  />
+  <ForwardedInput
+    append\={<IressIcon name\="search" />}
+    placeholder\="Watermark append slot"
+    watermark
+  />
+</IressStack\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | Set object |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | \- |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | Set object |
+
+### Readonly
+
+The `readOnly` prop can be set to prevent the user from changing the value of the input. This will change the input to a custom read-only style and the user will not be able to interact with the input.
+
+If you need more control over the read-only state (for example, rendering a stylised version of the value), you can use the [`IressReadonly` component](?path=/docs/components-readonly--docs).
+
+[](./iframe.html?id=components-input--readonly)
+
+Value
+
+```
+
+<ForwardedInput
+  append\=""
+  placeholder\="Enter your name"
+  prepend\=""
+  readOnly
+  value\="Value"
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | 
+
+""
+
+ |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter your name |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | 
+
+""
+
+ |
+| readOnly | 
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | 
+
+"Value"
+
+ |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | Set object |
+
+### Formatter
+
+`formatter` allows you to display the value in a different format when the input is not focused. A typical use case is to format a string with currency symbols and commas.
+
+This prop powers the `IressInputCurrency` component to allow friendly and consistent currency display in Iress products.
+
+**Notes:**
+
+*   When `formatter` is set, the `type` of the input is changed to `text` when not in focus. Keep this in mind when you are testing the component. If you have set the `type` to number and have set a `formatter`, the role of the input will be `textbox` when not in focus, but `spinbutton` when in focus.
+*   The value of the native input will be the formatted value, not the raw value. If you need the raw value, you can use the `onChange` prop to capture the raw value.
+
+The example below changes the value entered to uppercase when the input is not focused.
+
+[](./iframe.html?id=components-input--formatter)
+
+```
+
+<ForwardedInput
+  append\=""
+  formatter\={(value) \=> value ? value.toString().toUpperCase() : ""}
+  placeholder\="Enter a string and it will show in UPPERCASE when not focused, and show the raw value on focus"
+  prepend\=""
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content to append to the input field, usually a button or icon.
+
+ReactReactNode
+
+
+
+ | \- | 
+
+""
+
+ |
+| clearable | 
+
+If `true`, then user can clear the value of the input. Will be ignored if `rows` prop is in use.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| defaultValue | 
+
+The value of the input. Can be a string or a number. Use for uncontrolled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| formatter | 
+
+Bring your own formatter that will be used to format the value when the input is not focused, allowing you to display the value in a different format. e.g. User type in value="dsf 987kkk123" => result after formatter: $987,123 (string)
+
+(value?: T) => string | number
+
+ | \- | \- |
+| inline | 
+
+Make prepend/append element closer to the input content.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| loading | 
+
+The loading states of the input field. If provided a string, will use that text as the loading message.
+
+union
+
+
+
+ | \- | Set object |
+| onChange | 
+
+Emitted when the input value changes with the new changed value.
+
+(e: React.ChangeEvent<InputBaseElement>, value: T) => void
+
+ | \- | \- |
+| onClear | 
+
+Emitted when the input is manually cleared.
+
+(e: React.ChangeEvent<InputBaseElement>) => void
+
+ | \- | \- |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter a string and it will show in UPPERCASE when not focused, and show the raw value on focus |
+| prepend | 
+
+Content to prepended to the input field, usually an icon.
+
+ReactReactNode
+
+
+
+ | \- | 
+
+""
+
+ |
+| value | 
+
+The value of the input. Can be a string or a number. Use for controlled inputs.
+
+T
+
+
+
+ | \- | Set object |
+| watermark | 
+
+When set to `true` add ons will render with a different style. Will be ignored if `prepend` or `append` props are not being used.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| width | 
+
+The width of the input.
+
+union
+
+
+
+ | \- | Set object |
+
+### `onChange` and `onInput`
+
+As of version 5, the `onChange` and `onInput` events are now consistent with how React handles the events. This means that the `onChange` event will fire at the same time as `onInput`.