@iress-oss/ids-mcp-server 5.15.0 → 6.0.0-alpha.1

package/generated/docs/components-checkbox-docs.md

@@ -1,193 +0,0 @@
-[](#checkbox)Checkbox
-=====================
-
-Overview
---------
-
-Checkboxes are used to let a user select one or more options for a limited number of choices. Also, works as a child of `IressCheckboxGroup`
-
-A checkbox
-
-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; }
-
-<IressCheckbox\>
-  A checkbox
-</IressCheckbox\>
-
-Copy
-
-[](#usage)Usage
----------------
-
-### [](#checked)Checked
-
-For single checkboxes in controlled mode the `checked` prop sets the checked state.
-
-When used as part of an `IressCheckboxGroup`, the `checked` prop will be ignored. Instead, the `value` prop on the `IressCheckboxGroup` will determine the checked state of each checkbox. See the [checkbox group documentation](?path=/docs/components-checkboxgroup--docs) for more details.
-
-A checkbox which is checked and in controlled mode
-
-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; }
-
-<IressCheckbox checked\>
-  A checkbox which is checked and in controlled mode
-</IressCheckbox\>
-
-Copy
-
-### [](#default-checked)Default Checked
-
-For single checkboxes in uncontrolled mode the `defaultChecked` prop sets the default checked state.
-
-A checkbox which is initially checked
-
-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; }
-
-<IressCheckbox defaultChecked\>
-  A checkbox which is initially checked
-</IressCheckbox\>
-
-Copy
-
-### [](#indeterminate)Indeterminate
-
-The `indeterminate` prop sets the checkbox appearance to an indeterminate dash until it is clicked. It has no impact on the checkbox behavior beyond this purely visual indicator.
-
-A checkbox which is initially in an indeterminate state
-
-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; }
-
-<IressCheckbox indeterminate\>
-  A checkbox which is initially in an indeterminate state
-</IressCheckbox\>
-
-Copy
-
-### [](#hidden-label)Hidden Label
-
-It is very rare to want to render a checkbox without a visible label. However, one case where you might want to is within tables.
-
-When using a checkbox without a visible label, you must supply a label and apply the `hiddenLabel` property to still be accessible by screen readers.
-
-It is also important to not hide the table headers.
-
-List of investments
-| Select | Name | Date | Cost |
-| --- | --- | --- | --- |
-| 
-Toggle row
-
- | Artemis Fund Managers Limited | 2019-09-23 | 23898.12 |
-| 
-
-Toggle row
-
- | CASH.CASH | 2020-06-28 | 49751.43 |
-
-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; }
-
-<IressTable
-  caption\="List of investments"
-  columns\={\[
-    {
-      format: (value: boolean) \=> <IressCheckbox defaultChecked\={value} hiddenLabel\>Toggle row</IressCheckbox\>,
-      key: 'select',
-      label: 'Select',
-      sort: true
-    },
-    {
-      key: 'name',
-      label: 'Name'
-    },
-    {
-      key: 'date',
-      label: 'Date'
-    },
-    {
-      key: 'cost',
-      label: 'Cost'
-    }
-  \]}
-  rows\={\[
-    {
-      cost: 23898.12,
-      date: '2019-09-23',
-      name: 'Artemis Fund Managers Limited',
-      select: false
-    },
-    {
-      cost: 49751.43,
-      date: '2020-06-28',
-      name: 'CASH.CASH',
-      select: true
-    }
-  \]}
-/>
-
-Copy
-
-### [](#readonly)Readonly
-
-The `readOnly` prop changes how the checkbox is rendered. It will only render if the checkbox is checked (alongside a hidden input that contains the `value` if it was set), otherwise it will not be rendered.
-
-It is understandable that this may not be the desired behavior for all use cases. If you need a checkbox that is not editable, but still visible, simply do not set the `readonly` prop and set the `checked` prop instead.
-
-I agree to the terms and conditions
-
-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; }
-
-<IressStack\>
-  <IressCheckbox
-    defaultChecked
-    readOnly
-    value\="readonly"
-  \>
-    I agree to the terms and conditions  </IressCheckbox\>
-  <IressCheckbox
-    readOnly
-    value\="readonly"
-  \>
-    I agree to the terms and conditions  </IressCheckbox\>
-</IressStack\>
-
-Copy
-
-### [](#touch)Touch
-
-The `touch` prop adds the button-like border and padding to checkbox.
-
-Checkbox with touch styles
-
-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; }
-
-<IressCheckbox touch\>
-  Checkbox with touch styles
-</IressCheckbox\>
-
-Copy
-
-On this page
-
-*   [Overview](#overview)
-*   [Props](#props)
-*   [Usage](#usage)
-    *   [Checked](#checked)
-    *   [Default Checked](#default-checked)
-    *   [Indeterminate](#indeterminate)
-    *   [Hidden Label](#hidden-label)
-    *   [Readonly](#readonly)
-    *   [Touch](#touch)