@iress-oss/ids-mcp-server 6.0.0-alpha.1-canary-20251204032753-fe18cab → 6.0.0-alpha.1-canary-20251204040305-3639454

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

@@ -0,0 +1,636 @@
+InputCurrency
+=============
+
+Overview
+--------
+
+InputCurrency allows a user to input and interact with currency number. It works just like `IressInput`, with new props `locale` and `currencyCode`. This component meets [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) standard
+
+* * *
+
+Updated
+
+**Recently updated**
+
+This component has been recently updated with new props. The props have been marked as beta. Please tell us if there are any issues.
+
+[](./iframe.html?id=components-inputcurrency--input-currency)
+
+AUD
+
+```
+
+<IressInputCurrency
+  currencyCode\="AUD"
+  defaultValue\={12345.678}
+  locale\="en-AU"
+  placeholder\="Enter amount and dispay currency currency separator on blur"
+/>
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| currencyCode | 
+
+Set the currency symbol and appended currency code, default is `AUD`.
+
+string
+
+
+
+ | \- | AUD |
+| defaultValue | 
+
+number
+
+
+
+ | \- |  |
+| formatOptions | 
+
+Pass additional number format options.
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | 
+
+"en-AU"
+
+ |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter amount and dispay currency currency separator on blur |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | Set boolean |
+
+Examples
+--------
+
+### Different Locale and CurrencyCode
+
+Display the GBP with `locale="en-GB"` and `currencyCode="GBP"` props (must pass both together)
+
+[](./iframe.html?id=components-inputcurrency--gbp)
+
+GBP
+
+```
+
+<IressInputCurrency
+  currencyCode\="GBP"
+  defaultValue\={12345.678}
+  locale\="en-GB"
+  placeholder\="Enter amount and dispay currency currency separator on blur"
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| currencyCode | 
+
+Set the currency symbol and appended currency code, default is `AUD`.
+
+string
+
+
+
+ | \- | GBP |
+| defaultValue | 
+
+number
+
+
+
+ | \- |  |
+| formatOptions | 
+
+Pass additional number format options.
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | 
+
+"en-GB"
+
+ |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter amount and dispay currency currency separator on blur |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | Set boolean |
+
+Display the JPY with `locale="ja-JPY"` and `currencyCode="JPY"` props (must pass both together)
+
+[](./iframe.html?id=components-inputcurrency--jpy)
+
+JPY
+
+```
+
+<IressInputCurrency
+  currencyCode\="JPY"
+  defaultValue\={12345678}
+  locale\="ja-JP"
+  placeholder\="Enter amount and dispay currency currency separator on blur"
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| currencyCode | 
+
+Set the currency symbol and appended currency code, default is `AUD`.
+
+string
+
+
+
+ | \- | JPY |
+| defaultValue | 
+
+number
+
+
+
+ | \- |  |
+| formatOptions | 
+
+Pass additional number format options.
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | 
+
+"ja-JP"
+
+ |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter amount and dispay currency currency separator on blur |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | Set boolean |
+
+### With Symbol
+
+Display the currency symbol with `withSymbol` props
+
+[](./iframe.html?id=components-inputcurrency--with-symbol)
+
+AUD
+
+```
+
+<IressInputCurrency
+  currencyCode\="AUD"
+  defaultValue\={12345.678}
+  locale\="en-AU"
+  placeholder\="Enter amount and dispay currency symbol on blur"
+  withSymbol
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| currencyCode | 
+
+Set the currency symbol and appended currency code, default is `AUD`.
+
+string
+
+
+
+ | \- | AUD |
+| defaultValue | 
+
+number
+
+
+
+ | \- |  |
+| formatOptions | 
+
+Pass additional number format options.
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | 
+
+"en-AU"
+
+ |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter amount and dispay currency symbol on blur |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+
+### More Format Options
+
+Pass more format options with `formatOptions` props. More format options in [here](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+
+[](./iframe.html?id=components-inputcurrency--format-options)
+
+AUD
+
+```
+
+<IressInputCurrency
+  currencyCode\="AUD"
+  defaultValue\={12345.678}
+  formatOptions\={{
+    maximumFractionDigits: 4,
+    minimumFractionDigits: 2
+  }}
+  locale\="en-AU"
+  placeholder\="Pass and play around with other native Intl.NumberFormat options to the code sandbox"
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| currencyCode | 
+
+Set the currency symbol and appended currency code, default is `AUD`.
+
+string
+
+
+
+ | \- | AUD |
+| defaultValue | 
+
+number
+
+
+
+ | \- |  |
+| formatOptions | 
+
+Pass additional number format options.
+
+Omit
+
+
+
+ | \- | 
+
+RAW
+
+formatOptions :
+
+{
+
+*   minimumFractionDigits : 2
+*   maximumFractionDigits : 4
+
+}
+
+
+
+
+
+
+
+ |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | 
+
+"en-AU"
+
+ |
+| placeholder | 
+
+string
+
+
+
+ | \- | Pass and play around with other native Intl.NumberFormat options to the code sandbox |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | Set boolean |
+
+### Read Only
+
+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 want to make the number align to right, please pass `alignRight` together.
+
+[](./iframe.html?id=components-inputcurrency--read-only)
+
+$12,345.68
+
+AUD
+
+```
+
+<IressInputCurrency
+  alignRight
+  currencyCode\="AUD"
+  defaultValue\={12345.678}
+  locale\="en-AU"
+  readOnly
+  withSymbol
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| currencyCode | 
+
+Set the currency symbol and appended currency code, default is `AUD`.
+
+string
+
+
+
+ | \- | AUD |
+| defaultValue | 
+
+number
+
+
+
+ | \- |  |
+| formatOptions | 
+
+Pass additional number format options.
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | 
+
+"en-AU"
+
+ |
+| readOnly | 
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+
+### Align Right
+
+Set the input content align to right with `alignRight` prop, which is more friendly for number input.
+
+[](./iframe.html?id=components-inputcurrency--align-right)
+
+AUD
+
+```
+
+<IressInputCurrency
+  alignRight
+  currencyCode\="AUD"
+  defaultValue\={12345.678}
+  locale\="en-AU"
+/>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| alignRight | 
+Set input content align to right.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| currencyCode | 
+
+Set the currency symbol and appended currency code, default is `AUD`.
+
+string
+
+
+
+ | \- | AUD |
+| defaultValue | 
+
+number
+
+
+
+ | \- |  |
+| formatOptions | 
+
+Pass additional number format options.
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | 
+
+"en-AU"
+
+ |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | Set boolean |