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

@@ -0,0 +1,123 @@
+Provider
+========
+
+Overview
+--------
+
+Provider is a component that sets up the Iress Design System for your application. It ensures that the design system is correctly configured and ready to use.
+
+[](./iframe.html?id=components-provider--provider)
+
+Show modalShow slideoutShow toast
+
+```
+
+import {
+  IressButton,
+  IressInline,
+  IressModal,
+  IressPanel,
+  IressProvider,
+  IressSlideout,
+  IressText,
+  useModal,
+  useSlideout,
+  useToaster,
+} from '@iress-oss/ids-components';
+const Page \= () \=> {
+  const { showModal } \= useModal();
+  const { showSlideout } \= useSlideout();
+  const toaster \= useToaster();
+  return (
+    <IressPanel
+      bg\="alt"
+      style\={{
+        height: '300px',
+      }}
+    \>
+      <IressInline gap\="md"\>
+        <IressButton onClick\={() \=> showModal('test-modal')}\>
+          Show modal        </IressButton\>
+        <IressModal id\="test-modal"\>
+          <IressText\>Some modal content</IressText\>
+        </IressModal\>
+        <IressButton onClick\={() \=> showSlideout('test-slideout')}\>
+          Show slideout        </IressButton\>
+        <IressSlideout id\="test-slideout"\>
+          <IressText\>Some slideout content</IressText\>
+        </IressSlideout\>
+        <IressButton
+          onClick\={() \=> toaster.success({ content: 'A toast message' })}
+        \>
+          Show toast        </IressButton\>
+      </IressInline\>
+    </IressPanel\>
+  );
+};
+export const AppWithProvider \= () \=> (
+  <IressProvider\>
+    <Page />
+  </IressProvider\>
+);
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children | 
+The contents of your application, and/or the components which will be calling slideouts, modals and toasts.
+
+ReactNode
+
+
+
+ | \- | \- |
+| container | 
+
+The container element to render the slideout into. By default, the slideout will render at the end of the document body.
+
+FloatingUIContainer
+
+
+
+ | \- | \- |
+| noDefaultFont | 
+
+If you don't want to load the default Iress font from the CDN, set this to true.
+
+boolean
+
+
+
+ | \- | \- |
+| noIcons | 
+
+If you don't want to load the Iress Icon CSS from the CDN, set this to true.
+
+boolean
+
+
+
+ | \- | \- |
+
+Usage
+-----
+
+The design system provider automates some set-up tasks for you, including:
+
+*   Adding the icon fonts and CSS variables to the document head
+*   Consistent container handling for providers, if you need the modals, slideouts and toasts rendered in a specific area (common with micro frontends)
+
+In most cases, you should wrap the entire application with the `IressProvider` component. This will ensure that the design system is set up correctly and consistently across the application.
+
+import { IressProvider } from '@iress-oss/ids-components';
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <IressProvider\>
+    <App />
+  </IressProvider\>,
+);
+
+```

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

@@ -0,0 +1,499 @@
+Radio
+=====
+
+Overview
+--------
+
+A radio is a single option presented with a radio button. It is used to select a single option from multiple options. It is typically used in an `IressRadioGroup`.
+
+* * *
+
+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-radio--default)
+
+Radio button
+
+```
+
+<IressRadio\>
+  Radio button
+</IressRadio\>
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| checked | 
+Sets the checked state of the radio. If it is within a radio group, it will be overridden by the radio group's value and whether it matches this radio's value.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| children | 
+
+Label of the radio
+
+ReactNode
+
+
+
+ | \- | 
+
+"Radio button"
+
+ |
+| hiddenControl | 
+
+Sets whether the control is hidden. If it is within a radio group, it will be overridden with the radio group's hiddenControl setting.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| name | 
+
+Sets the name attribute on the radio input. If it is within a radio group, it will be overridden with the radio group's name.
+
+string
+
+
+
+ | \- | Set string |
+| onChange | 
+
+Handles the onChange event of the radio input. If you pass in a non-string value, you can access it using the second parameter of the function.
+
+(e: ChangeEvent<HTMLInputElement>, value?: T) => void
+
+ | \- | \- |
+| required | 
+
+If `true`, the radio is a required field and will be validated as such. If it is within a radio group, it will be overridden with the radio group's required state.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| touch | 
+
+Add the button-like border and padding to radio when `touch` is true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| value | 
+
+The value which is submitted with the form data when this radio button is checked. To set this radio as checked by default, use the `checked` property.
+
+T
+
+
+
+ | \- | Set object |
+
+Examples
+--------
+
+### Checked
+
+You can set the radio to `checked` by default. This is useful when you want to pre-select an option.
+
+**Note:** If you are using an `IressRadioGroup`, you should use the `value` prop on the `IressRadioGroup` to set the checked state of its `<IressRadio />` children, as the `checked` prop will be ignored.
+
+[](./iframe.html?id=components-radio--checked)
+
+Checked radio button
+
+```
+
+<IressRadio checked\>
+  Checked radio button
+</IressRadio\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| checked | 
+Sets the checked state of the radio. If it is within a radio group, it will be overridden by the radio group's value and whether it matches this radio's value.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| children | 
+
+Label of the radio
+
+ReactNode
+
+
+
+ | \- | 
+
+"Checked radio button"
+
+ |
+| hiddenControl | 
+
+Sets whether the control is hidden. If it is within a radio group, it will be overridden with the radio group's hiddenControl setting.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| name | 
+
+Sets the name attribute on the radio input. If it is within a radio group, it will be overridden with the radio group's name.
+
+string
+
+
+
+ | \- | Set string |
+| onChange | 
+
+Handles the onChange event of the radio input. If you pass in a non-string value, you can access it using the second parameter of the function.
+
+(e: ChangeEvent<HTMLInputElement>, value?: T) => void
+
+ | \- | \- |
+| required | 
+
+If `true`, the radio is a required field and will be validated as such. If it is within a radio group, it will be overridden with the radio group's required state.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| touch | 
+
+Add the button-like border and padding to radio when `touch` is true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| value | 
+
+The value which is submitted with the form data when this radio button is checked. To set this radio as checked by default, use the `checked` property.
+
+T
+
+
+
+ | \- | Set object |
+
+### Hidden control
+
+You can hide the radio button and use a custom UI to display the content. Even though the radio button is hidden, it still acts like a radio.
+
+[](./iframe.html?id=components-radio--hidden-control)
+
+Hidden radio button
+
+```
+
+<IressRadio hiddenControl\>
+  <IressPanel bg\="transparent"\>
+    Hidden radio button  </IressPanel\>
+</IressRadio\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| checked | 
+Sets the checked state of the radio. If it is within a radio group, it will be overridden by the radio group's value and whether it matches this radio's value.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| children | 
+
+Label of the radio
+
+ReactNode
+
+
+
+ | \- | \- |
+| hiddenControl | 
+
+Sets whether the control is hidden. If it is within a radio group, it will be overridden with the radio group's hiddenControl setting.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| name | 
+
+Sets the name attribute on the radio input. If it is within a radio group, it will be overridden with the radio group's name.
+
+string
+
+
+
+ | \- | Set string |
+| onChange | 
+
+Handles the onChange event of the radio input. If you pass in a non-string value, you can access it using the second parameter of the function.
+
+(e: ChangeEvent<HTMLInputElement>, value?: T) => void
+
+ | \- | \- |
+| required | 
+
+If `true`, the radio is a required field and will be validated as such. If it is within a radio group, it will be overridden with the radio group's required state.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| touch | 
+
+Add the button-like border and padding to radio when `touch` is true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| value | 
+
+The value which is submitted with the form data when this radio button is checked. To set this radio as checked by default, use the `checked` property.
+
+T
+
+
+
+ | \- | Set object |
+
+### Read only
+
+The `readOnly` prop changes how the radio is rendered. It will only render if the radio is checked (alongside a hidden input that contains the `value` if it was set), otherwise it not be rendered.
+
+It is understandable that this may not be the desired behavior for all use cases. If you need a radio that is not editable, but still visible, simply do not set the `readOnly` prop and set the `checked` prop instead.
+
+[](./iframe.html?id=components-radio--read-only)
+
+Radio button
+
+```
+
+<IressStack gap\="sm"\>
+  <IressRadio
+    defaultChecked
+    readOnly
+  \>
+    Radio button  </IressRadio\>
+  <IressRadio readOnly\>
+    Radio button  </IressRadio\>
+</IressStack\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| checked | 
+Sets the checked state of the radio. If it is within a radio group, it will be overridden by the radio group's value and whether it matches this radio's value.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| children | 
+
+Label of the radio
+
+ReactNode
+
+
+
+ | \- | 
+
+"Radio button"
+
+ |
+| hiddenControl | 
+
+Sets whether the control is hidden. If it is within a radio group, it will be overridden with the radio group's hiddenControl setting.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| name | 
+
+Sets the name attribute on the radio input. If it is within a radio group, it will be overridden with the radio group's name.
+
+string
+
+
+
+ | \- | Set string |
+| onChange | 
+
+Handles the onChange event of the radio input. If you pass in a non-string value, you can access it using the second parameter of the function.
+
+(e: ChangeEvent<HTMLInputElement>, value?: T) => void
+
+ | \- | \- |
+| readOnly | 
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| required | 
+
+If `true`, the radio is a required field and will be validated as such. If it is within a radio group, it will be overridden with the radio group's required state.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| touch | 
+
+Add the button-like border and padding to radio when `touch` is true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| value | 
+
+The value which is submitted with the form data when this radio button is checked. To set this radio as checked by default, use the `checked` property.
+
+T
+
+
+
+ | \- | Set object |
+
+### Touch
+
+The `touch` prop adds the button-like border and padding to radio.
+
+[](./iframe.html?id=components-radio--touch)
+
+Radio button
+
+```
+
+<IressRadio touch\>
+  Radio button
+</IressRadio\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| checked | 
+Sets the checked state of the radio. If it is within a radio group, it will be overridden by the radio group's value and whether it matches this radio's value.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| children | 
+
+Label of the radio
+
+ReactNode
+
+
+
+ | \- | 
+
+"Radio button"
+
+ |
+| hiddenControl | 
+
+Sets whether the control is hidden. If it is within a radio group, it will be overridden with the radio group's hiddenControl setting.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| name | 
+
+Sets the name attribute on the radio input. If it is within a radio group, it will be overridden with the radio group's name.
+
+string
+
+
+
+ | \- | Set string |
+| onChange | 
+
+Handles the onChange event of the radio input. If you pass in a non-string value, you can access it using the second parameter of the function.
+
+(e: ChangeEvent<HTMLInputElement>, value?: T) => void
+
+ | \- | \- |
+| required | 
+
+If `true`, the radio is a required field and will be validated as such. If it is within a radio group, it will be overridden with the radio group's required state.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| touch | 
+
+Add the button-like border and padding to radio when `touch` is true.
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| value | 
+
+The value which is submitted with the form data when this radio button is checked. To set this radio as checked by default, use the `checked` property.
+
+T
+
+
+
+ | \- | Set object |