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

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

@@ -0,0 +1,432 @@
+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
+
+[](./iframe.html?id=components-inputcurrency--input-currency)
+
+AUD
+
+```
+
+<IressInputCurrency
+  currencyCode\="AUD"
+  defaultValue\={12345.678}
+  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 more format options, examples in here: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Intl/NumberFormat/NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | Set object |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter amount and dispay currency currency separator on blur |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | Set boolean |
+
+Examples
+--------
+
+### Different Currency Code
+
+Display GBP currency using the `currencyCode="GBP"` prop.
+
+[](./iframe.html?id=components-inputcurrency--currency-code)
+
+GBP
+
+```
+
+<IressInputCurrency
+  currencyCode\="GBP"
+  defaultValue\={12345.678}
+  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 more format options, examples in here: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Intl/NumberFormat/NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | Set object |
+| placeholder | 
+
+string
+
+
+
+ | \- | Enter amount and dispay currency currency separator on blur |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | Set boolean |
+
+### 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
+  }}
+  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 more format options, examples in here: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Intl/NumberFormat/NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+
+Omit
+
+
+
+ | \- | 
+
+RAW
+
+formatOptions :
+
+{
+
+*   minimumFractionDigits : 2
+*   maximumFractionDigits : 4
+
+}
+
+
+
+
+
+
+
+ |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | Set object |
+| 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)
+
+A$12,345.68
+
+AUD
+
+```
+
+<IressInputCurrency
+  alignRight
+  currencyCode\="AUD"
+  defaultValue\={12345.678}
+  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 more format options, examples in here: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Intl/NumberFormat/NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | Set object |
+| 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}
+/>
+
+```
+
+#### 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 more format options, examples in here: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Intl/NumberFormat/NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | Set object |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
+
+ | \- | Set boolean |

package/generated/docs/{components-inputcurrency-recipes-docs.md → components_components-inputcurrency-recipes-docs.md}

@@ -1,11 +1,13 @@
-[](#recipes)Recipes
-===================
+Recipes
+=======
 
-[](#using-iressinputcurrency-in-table)Using IressInputCurrency in table
------------------------------------------------------------------------
+Using IressInputCurrency in table
+---------------------------------
 
 It is not recommended to use the `readOnly` prop for `IressInputCurrency` inside tables, as it was designed for forms. This example shows how to use currency in the table, by using the `format` prop of when defining a column inside `IressTable`. Additionally, when all rows have the same currency, it is recommended to add the currency code on the column `label` and remove the `currencyCode` on all rows.
 
+[](./iframe.html?id=components-inputcurrency-recipes--currency-in-table)
+
 My investments
 | Investment Name | Investment Date | Total % | Investment Amount (AUD) |
 | --- | --- | --- | --- |
@@ -14,9 +16,7 @@ My investments
 | AU Stocks | 05/02/2019 | 26.2% | 9,342.16 |
 | UK Stocks | 28/06/2020 | 49% | 49,751.40 |
 
-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; }
+```
 
 export const CurrencyInTable \= () \=> {
   return (
@@ -80,18 +80,67 @@ export const CurrencyInTable \= () \=> {
   );
 };
 
-Copy
+```
+
+#### 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
+
+
+
+ | \- | Set string |
+| formatOptions | 
+
+Pass more format options, examples in here: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Intl/NumberFormat/NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | Set object |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
+
 
-[](#onchange-with-valid-value)OnChange with valid value
--------------------------------------------------------
+ | \- | Set boolean |
+
+OnChange with valid value
+-------------------------
 
 Only able to input valid value when use `IressInputCurrency`. In this example, only number and 2 decimal places are allowed.
 
-AUD
+[](./iframe.html?id=components-inputcurrency-recipes--valid-value-on-chage)
 
-Hide code
+AUD
 
-\[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; }
+```
 
 export const ValidValueOnChage \= () \=> {
   const \[value, setValue\] \= useState('');
@@ -108,9 +157,53 @@ export const ValidValueOnChage \= () \=> {
   );
 };
 
-Copy
+```
+
+#### 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
+
+
+
+ | \- | Set string |
+| formatOptions | 
+
+Pass more format options, examples in here: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Intl/NumberFormat/NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat)
+
+Omit
+
+
+
+ | \- | Set object |
+| locale | 
+
+Set the region of the currency, default is `en-AU`.
+
+Intl.LocalesArgument
+
+
+
+ | \- | Set object |
+| withSymbol | 
+
+Set the currency symbol.
+
+boolean
+
 
-On this page
 
-*   [Using IressInputCurrency in table](#using-iressinputcurrency-in-table)
-*   [OnChange with valid value](#onchange-with-valid-value)
+ | \- | Set boolean |