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

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

@@ -14,7 +14,7 @@ Use the `IressForm` component when you want to request, validate and process dat
 
 Sign up
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="md"\>
@@ -58,14 +58,14 @@ Below are the custom props you can access when using `IressForm`, which includes
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
 
 
 
- | \- | Choose option...nonesimplesupportedControlsreadOnly |
+ | \- | childrenChoose option...nonesimplesupportedControlsreadOnly |
 | form | 
 
 React hook form instance from `useForm`, use if you need more control over the internal state.
@@ -228,7 +228,7 @@ None selected
 
 Sign up
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="md"\>
@@ -409,14 +409,14 @@ Sign up
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
 
 
 
- | \- | Choose option...nonesimplesupportedControlsreadOnly |
+ | \- | childrenChoose option...nonesimplesupportedControlsreadOnly |
 | form | 
 
 React hook form instance from `useForm`, use if you need more control over the internal state.
@@ -499,7 +499,7 @@ A boolean which, if `true`, indicates that the input must have a value before th
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -558,7 +558,7 @@ Enter a maximum length of 5 characters
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -620,7 +620,7 @@ Enter a minimum length of 7 characters
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -681,7 +681,7 @@ Select a maximum of 2
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -742,7 +742,7 @@ Select a minimum of 20
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -803,7 +803,7 @@ Enter a valid email address
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -857,7 +857,7 @@ Enter a date after today
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -867,7 +867,7 @@ Validate
       name\="IressInputDate-default"
       render\={(controlledProps) \=> <IressInput {...controlledProps} />}
       rules\={{
-        minDate: new Date('2025-12-04T07:07:37.519Z')
+        minDate: new Date('2026-01-06T04:07:40.949Z')
       }}
     />
     <IressFormField
@@ -878,7 +878,7 @@ Validate
       rules\={{
         minDate: {
           message: 'Please enter a date after today!',
-          value: new Date('2025-12-04T07:07:37.519Z')
+          value: new Date('2026-01-06T04:07:40.949Z')
         }
       }}
     />
@@ -1061,7 +1061,7 @@ Enter a date before today
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -1071,7 +1071,7 @@ Validate
       name\="IressInputDate-default"
       render\={(controlledProps) \=> <IressInput {...controlledProps} />}
       rules\={{
-        maxDate: new Date('2025-12-04T07:07:37.519Z')
+        maxDate: new Date('2026-01-06T04:07:40.949Z')
       }}
     />
     <IressFormField
@@ -1082,7 +1082,7 @@ Validate
       rules\={{
         maxDate: {
           message: 'Please enter a date before today!',
-          value: new Date('2025-12-04T07:07:37.519Z')
+          value: new Date('2026-01-06T04:07:40.949Z')
         }
       }}
     />
@@ -1265,7 +1265,7 @@ Enter an email address
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -1476,7 +1476,7 @@ Writing
 
 Validate
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm\>
   <IressStack gutter\="lg"\>
@@ -1687,7 +1687,7 @@ When the form passes validation (if not disabled), the `onSubmit` event is emitt
 
 Sign up
 
-```
+Hide codedrawOpen in CodeSandbox
 
 import {
   IressTable,
@@ -1698,7 +1698,7 @@ import {
   IressInput,
   IressStack,
   IressButton,
-} from '@iress-oss/ids-components';
+} from '@/main';
 import { useState } from 'react';
 interface FieldValues {
   name?: string;
@@ -1759,7 +1759,7 @@ export const FormSubmission \= () \=> {
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
@@ -1804,7 +1804,7 @@ Luke Skywalker
 
 Sign up
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <IressStack gutter\="md"\>
   <IressText element\="h2"\>
@@ -1850,14 +1850,14 @@ Sign up
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
 
 
 
- | \- | Choose option...nonesimplesupportedControlsreadOnly |
+ | \- | childrenChoose option...nonesimplesupportedControlsreadOnly |
 | form | 
 
 React hook form instance from `useForm`, use if you need more control over the internal state.
@@ -1900,7 +1900,7 @@ Try hitting submit to see the validation summary
 
 Sign up
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <IressStack gutter\="md"\>
   <IressText element\="h2"\>
@@ -1945,14 +1945,14 @@ Sign up
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
 
 
 
- | \- | Choose option...nonesimplesupportedControlsreadOnly |
+ | \- | childrenChoose option...nonesimplesupportedControlsreadOnly |
 | errorSummaryHeading | 
 
 string
@@ -1990,7 +1990,7 @@ Try hitting submit to see the errors only on the fields
 
 Sign up
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <IressStack gutter\="md"\>
   <IressText element\="h2"\>
@@ -2035,14 +2035,14 @@ Sign up
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
 
 
 
- | \- | Choose option...nonesimplesupportedControlsreadOnly |
+ | \- | childrenChoose option...nonesimplesupportedControlsreadOnly |
 | form | 
 
 React hook form instance from `useForm`, use if you need more control over the internal state.
@@ -2079,7 +2079,7 @@ One use case for this prop is to create your own error summary.
 
 Sign up
 
-```
+Hide codedrawOpen in CodeSandbox
 
 import {
   IressTable,
@@ -2090,7 +2090,7 @@ import {
   IressFormField,
   IressInput,
   IressButton,
-} from '@iress-oss/ids-components';
+} from '@/main';
 import { useState } from 'react';
 import { type FieldErrors } from 'react-hook-form';
 interface FieldValues {
@@ -2161,7 +2161,7 @@ export const CustomErrorHandlingForm \= () \=> {
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
@@ -2208,7 +2208,7 @@ You can set the `defaultValues` prop to pre-fill the form values.
 
 Sign up
 
-```
+Hide codedrawOpen in CodeSandbox
 
 <ForwardedForm
   defaultValues\={{
@@ -2254,14 +2254,14 @@ Sign up
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
 
 
 
- | \- | Choose option...nonesimplesupportedControlsreadOnly |
+ | \- | childrenChoose option...nonesimplesupportedControlsreadOnly |
 | form | 
 
 React hook form instance from `useForm`, use if you need more control over the internal state.
@@ -2300,8 +2300,21 @@ Sign up
 
 Last updateClear
 
-```
+Hide codedrawOpen in CodeSandbox
 
+import {
+  type IressFormProps,
+  IressForm,
+  IressModal,
+  IressDivider,
+  IressButton,
+  IressTable,
+  IressInline,
+  IressStack,
+  IressFormField,
+  IressInput,
+} from '@/main';
+import { useState } from 'react';
 interface FieldValues {
   name?: string;
   email?: string;
@@ -2383,14 +2396,14 @@ export const ControlledForm \= (args: IressFormProps<FieldValues\>) \=> {
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
 
 
 
- | \- | Choose option...nonesimplesupportedControlsreadOnly |
+ | \- | childrenChoose option...nonesimplesupportedControlsreadOnly |
 | form | 
 
 React hook form instance from `useForm`, use if you need more control over the internal state.
@@ -2432,7 +2445,7 @@ Sign up
 
 Save as draft
 
-```
+Hide codedrawOpen in CodeSandbox
 
 import {
   type FormRef,
@@ -2445,7 +2458,7 @@ import {
   IressStack,
   IressToasterProvider,
   useToaster,
-} from '@iress-oss/ids-components';
+} from '@/main';
 import { useRef } from 'react';
 interface FieldValues {
   name?: string;
@@ -2525,7 +2538,7 @@ export const DisableValidationForm \= () \=> (
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
@@ -2576,7 +2589,7 @@ Sign up
 
 Reset
 
-```
+Hide codedrawOpen in CodeSandbox
 
 import {
   type IressFormProps,
@@ -2587,7 +2600,7 @@ import {
   IressStack,
   IressFormField,
   IressInput,
-} from '@iress-oss/ids-components';
+} from '@/main';
 import { useRef } from 'react';
 interface FieldValues {
   name?: string;
@@ -2642,7 +2655,7 @@ export const FormReset \= () \=> {
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
@@ -2699,10 +2712,22 @@ Upload
 
 Submit
 
-```
+Hide codedrawOpen in CodeSandbox
 
+import {
+  IressButton,
+  IressForm,
+  type IressFormProps,
+  IressInput,
+  IressFormField,
+  IressStack,
+  IressIcon,
+  IressText,
+  IressPanel,
+  IressInline,
+} from '@/main';
 import React, { useState } from 'react';
-
+import { useDropzone } from 'react-dropzone';
 interface TranscriptFormValues {
   transcript: TranscriptData | string;
 }
@@ -2999,7 +3024,7 @@ export const CustomFormFieldComponents \= (
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
@@ -3032,7 +3057,7 @@ Sender
 
 Recipient
 
-```
+Hide codedrawOpen in CodeSandbox
 
 import {
   IressExpander,
@@ -3041,7 +3066,7 @@ import {
   type IressFormProps,
   IressInput,
   IressStack,
-} from '@iress-oss/ids-components';
+} from '@/main';
 import { useState } from 'react';
 interface FieldValues {
   name?: string;
@@ -3105,7 +3130,7 @@ export const FormExpanders \= () \=> {
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
@@ -3150,7 +3175,7 @@ Email
 
 Submit
 
-```
+Hide codedrawOpen in CodeSandbox
 
 import {
   IressButton,
@@ -3163,7 +3188,7 @@ import {
   IressInput,
   IressStack,
   IressText,
-} from '@iress-oss/ids-components';
+} from '@/main';
 interface FieldValues {
   show?: string\[\];
   name?: string;
@@ -3238,14 +3263,14 @@ export const UseWatchForm \= () \=> (
 | alert | 
 \-
 
- | \- | Choose option...nonebasicAlert |
+ | \- | alertChoose option...nonebasicAlert |
 | children | 
 
 object
 
 
 
- | \- | Choose option...nonesimplesupportedControlsreadOnly |
+ | \- | childrenChoose option...nonesimplesupportedControlsreadOnly |
 | form | 
 
 React hook form instance from `useForm`, use if you need more control over the internal state.
@@ -3281,14 +3306,24 @@ Some use cases:
 
 Submit
 
-```
+Hide codedrawOpen in CodeSandbox
 
+import {
+  IressButton,
+  IressFormField,
+  IressHookForm,
+  IressInput,
+  IressPanel,
+  IressStack,
+} from '@/main';
+import { useForm } from 'react-hook-form';
 interface FieldValues {
   firstName: string;
   lastName: string;
 }
 export const HookFormExample \= () \=> {
   const form \= useForm<FieldValues\>();
+  // eslint-disable-next-line react-hooks/incompatible-library -- Known limitation: react-hook-form's watch() API cannot be memoized by React Compiler
   const firstName \= form.watch('firstName');
   const lastName \= form.watch('lastName');
   return (
@@ -3358,7 +3393,7 @@ Level of error summary heading for semantics.
 
 HeadingLevel
 
-<table class="css-3nr4py"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use errorSummaryHeading instead.</td></tr></tbody></table>
+<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use errorSummaryHeading instead.</td></tr></tbody></table>
 
  | \- | Set object |
 | errorSummaryHeadingText | 
@@ -3367,7 +3402,7 @@ Text to be displayed in the title of the error summary.
 
 string
 
-<table class="css-3nr4py"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use errorSummaryHeading instead.</td></tr></tbody></table>
+<table class="css-ymgjf7"><tbody><tr><td colspan="2"><strong>Deprecated</strong>: Use errorSummaryHeading instead.</td></tr></tbody></table>
 
  | \- | Set string |
 | form\* |