@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-recipes-docs.md

@@ -0,0 +1,208 @@
+Recipes
+=======
+
+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) |
+| --- | --- | --- | --- |
+| US Stocks | 23/09/2019 | 24.8% | $23,898.00 |
+| US Bonds | 05/02/2019 | 26.2% | $26,382.46 |
+| AU Stocks | 05/02/2019 | 26.2% | $9,342.16 |
+| UK Stocks | 28/06/2020 | 49% | $49,751.40 |
+
+```
+
+export const CurrencyInTable \= () \=> {
+  return (
+    <IressTable
+      caption\="My investments"
+      columns\={\[
+        {
+          key: 'investmentName',
+          label: 'Investment Name',
+          format: 'string',
+          width: '30%',
+        },
+        {
+          key: 'investmentDate',
+          label: 'Investment Date',
+          format: 'date',
+          width: '30%',
+        },
+        {
+          key: 'totalPercentage',
+          label: 'Total %',
+          format: 'percent',
+          width: '15%',
+        },
+        {
+          key: 'amount',
+          label: 'Investment Amount (AUD)',
+          format: 'currency',
+          currencyCode: '',
+          width: '25%',
+        },
+      \]}
+      rows\={\[
+        {
+          investmentName: 'US Stocks',
+          investmentDate: '2019-09-23',
+          totalPercentage: 24.8,
+          amount: 23898,
+        },
+        {
+          investmentName: 'US Bonds',
+          investmentDate: '2019-02-05',
+          totalPercentage: 26.2,
+          amount: 26382.456,
+        },
+        {
+          investmentName: 'AU Stocks',
+          investmentDate: '2019-02-05',
+          totalPercentage: 26.2,
+          amount: 9342.1569,
+        },
+        {
+          investmentName: 'UK Stocks',
+          investmentDate: '2020-06-28',
+          totalPercentage: 49,
+          amount: 49751.4,
+        },
+      \]}
+    />
+  );
+};
+
+```
+
+#### 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 additional number format options.
+
+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 |
+
+OnChange with valid value
+-------------------------
+
+Only able to input valid value when use `IressInputCurrency`. In this example, only number and 2 decimal places are allowed.
+
+[](./iframe.html?id=components-inputcurrency-recipes--valid-value-on-chage)
+
+AUD
+
+```
+
+export const ValidValueOnChage \= () \=> {
+  const \[value, setValue\] \= useState('');
+  return (
+    <IressInputCurrency
+      value\={value}
+      onChange\={(\_e, value) \=> {
+        if (typeof value \=== 'string' && /^-?\\d\*(\\.\\d{0,2})?$/.test(value)) {
+          console.log('Valid value:', value);
+          setValue(value);
+        }
+      }}
+    />
+  );
+};
+
+```
+
+#### 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 additional number format options.
+
+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_components-introduction-docs.md

@@ -0,0 +1,448 @@
+Components
+==========
+
+Components are the building blocks of the Iress Design System. They are reusable, self-contained pieces of UI that can be used to create complex interfaces.
+
+Search components
+
+Filter by tags
+
+Reset filter
+
+* * *
+
+accessibilityactionalignmentcategorizationcollapsiblecontainercontentcurrencydatadata-displaydata-entrydialogdisplaydropdownempty-statefeedbackfilteringformgraphicgridgrouphelpindicatorinteractivelabellayoutlinkloadingmedianavigationnotificationoverlaypanelplaceholderrangeresponsivesearchselectionseparatorspacingstatusstructured-dataswitchsymboltexttoasttypographyutilityvalidationvisualwrapper
+
+None selected
+
+[
+
+Alert
+-----
+
+
+
+](/?path=/docs/components-alert--docs)
+
+[
+
+Autocomplete
+------------
+
+
+
+](/?path=/docs/components-autocomplete--docs)
+
+[
+
+Badge
+-----
+
+
+
+](/?path=/docs/components-badge--docs)
+
+[
+
+Button
+------
+
+
+
+](/?path=/docs/components-button--docs)
+
+[
+
+ButtonGroup
+-----------
+
+
+
+](/?path=/docs/components-buttongroup--docs)
+
+[
+
+Card
+----
+
+
+
+](/?path=/docs/components-card--docs)
+
+[
+
+Checkbox
+--------
+
+
+
+](/?path=/docs/components-checkbox--docs)
+
+[
+
+CheckboxGroup
+-------------
+
+
+
+](/?path=/docs/components-checkboxgroup--docs)
+
+[
+
+Col
+---
+
+
+
+](/?path=/docs/components-col--docs)
+
+[
+
+Container
+---------
+
+
+
+](/?path=/docs/components-container--docs)
+
+[
+
+Divider
+-------
+
+
+
+](/?path=/docs/components-divider--docs)
+
+[
+
+Expander
+--------
+
+
+
+](/?path=/docs/components-expander--docs)
+
+[
+
+Field
+-----
+
+
+
+](/?path=/docs/components-field--docs)
+
+[
+
+Filter
+------
+
+
+
+](/?path=/docs/components-filter--docs)
+
+[
+
+Hide
+----
+
+
+
+](/?path=/docs/components-hide--docs)
+
+[
+
+Icon
+----
+
+
+
+](/?path=/docs/components-icon--docs)
+
+[
+
+Image
+-----
+
+
+
+](/?path=/docs/components-image--docs)
+
+[
+
+Inline
+------
+
+
+
+](/?path=/docs/components-inline--docs)
+
+[
+
+Input
+-----
+
+
+
+](/?path=/docs/components-input--docs)
+
+[
+
+InputCurrency
+-------------
+
+
+
+](/?path=/docs/components-inputcurrency--docs)
+
+[
+
+Label
+-----
+
+
+
+](/?path=/docs/components-label--docs)
+
+[
+
+Link
+----
+
+
+
+](/?path=/docs/components-link--docs)
+
+[
+
+Menu
+----
+
+
+
+](/?path=/docs/components-menu--docs)
+
+[
+
+Modal
+-----
+
+
+
+](/?path=/docs/components-modal--docs)
+
+[
+
+Panel
+-----
+
+
+
+](/?path=/docs/components-panel--docs)
+
+[
+
+Placeholder
+-----------
+
+
+
+](/?path=/docs/components-placeholder--docs)
+
+[
+
+Popover
+-------
+
+
+
+](/?path=/docs/components-popover--docs)
+
+[
+
+Progress
+--------
+
+
+
+](/?path=/docs/components-progress--docs)
+
+[
+
+Radio
+-----
+
+
+
+](/?path=/docs/components-radio--docs)
+
+[
+
+RadioGroup
+----------
+
+
+
+](/?path=/docs/components-radiogroup--docs)
+
+[
+
+Readonly
+--------
+
+
+
+](/?path=/docs/components-readonly--docs)
+
+[
+
+RichSelect
+----------
+
+
+
+](/?path=/docs/components-richselect--docs)
+
+[
+
+Row
+---
+
+
+
+](/?path=/docs/components-row--docs)
+
+[
+
+Select
+------
+
+
+
+](/?path=/docs/components-select--docs)
+
+[
+
+Skeleton
+--------
+
+
+
+](/?path=/docs/components-skeleton--docs)
+
+[
+
+SkipLink
+--------
+
+
+
+](/?path=/docs/components-skiplink--docs)
+
+[
+
+Slideout
+--------
+
+
+
+](/?path=/docs/components-slideout--docs)
+
+[
+
+Slider
+------
+
+
+
+](/?path=/docs/components-slider--docs)
+
+[
+
+Spinner
+-------
+
+
+
+](/?path=/docs/components-spinner--docs)
+
+[
+
+Stack
+-----
+
+
+
+](/?path=/docs/components-stack--docs)
+
+[
+
+Table
+-----
+
+
+
+](/?path=/docs/components-table--docs)
+
+[
+
+TabSet
+------
+
+
+
+](/?path=/docs/components-tabset--docs)
+
+[
+
+Tag
+---
+
+
+
+](/?path=/docs/components-tag--docs)
+
+[
+
+Text
+----
+
+
+
+](/?path=/docs/components-text--docs)
+
+[
+
+Toaster
+-------
+
+
+
+](/?path=/docs/components-toaster--docs)
+
+[
+
+Toggle
+------
+
+
+
+](/?path=/docs/components-toggle--docs)
+
+[
+
+Tooltip
+-------
+
+
+
+](/?path=/docs/components-tooltip--docs)
+
+[
+
+ValidationMessage
+-----------------
+
+
+
+](/?path=/docs/components-validationmessage--docs)