@iress-oss/ids-mcp-server 0.0.1-dev.3 → 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. package/LICENSE +193 -0
  2. package/README.md +159 -29
  3. package/build/componentHandlers.js +205 -0
  4. package/{dist → build}/config.js +5 -5
  5. package/build/index.js +51 -0
  6. package/{dist → build}/iressHandlers.js +46 -52
  7. package/{dist → build}/resourceHandlers.js +22 -23
  8. package/{dist → build}/searchHandlers.js +92 -107
  9. package/{dist → build}/toolHandler.js +13 -13
  10. package/build/tools.js +165 -0
  11. package/{dist → build}/utils.js +15 -11
  12. package/docs/api-reference.md +0 -0
  13. package/docs/best-practices.md +0 -0
  14. package/docs/configuration.md +0 -0
  15. package/docs/examples.md +0 -0
  16. package/docs/guidelines.md +269 -0
  17. package/{generated/docs → docs/ids}/components-autocomplete-docs.md +6 -6
  18. package/{generated/docs → docs/ids}/components-autocomplete-recipes-docs.md +51 -17
  19. package/{generated/docs → docs/ids}/components-card-recipes-docs.md +1 -1
  20. package/{generated/docs → docs/ids}/components-checkbox-docs.md +19 -6
  21. package/{generated/docs → docs/ids}/components-checkboxgroup-docs.md +18 -18
  22. package/{generated/docs → docs/ids}/components-checkboxgroup-recipes-docs.md +9 -9
  23. package/{generated/docs → docs/ids}/components-col-docs.md +1 -1
  24. package/{generated/docs → docs/ids}/components-combobox-docs.md +6 -6
  25. package/{generated/docs → docs/ids}/components-container-docs.md +42 -8
  26. package/{generated/docs → docs/ids}/components-filter-docs.md +65 -12
  27. package/{generated/docs → docs/ids}/components-form-docs.md +335 -341
  28. package/{generated/docs → docs/ids}/components-form-recipes-docs.md +1 -198
  29. package/{generated/docs → docs/ids}/components-hide-docs.md +70 -16
  30. package/{generated/docs → docs/ids}/components-icon-docs.md +4 -4
  31. package/{generated/docs → docs/ids}/components-input-recipes-docs.md +2 -2
  32. package/{generated/docs → docs/ids}/components-inputcurrency-recipes-docs.md +40 -6
  33. package/{generated/docs → docs/ids}/components-modal-docs.md +113 -3
  34. package/docs/ids/components-popover-docs.md +4 -0
  35. package/{generated/docs → docs/ids}/components-radiogroup-docs.md +21 -21
  36. package/{generated/docs → docs/ids}/components-richselect-docs.md +111 -149
  37. package/{generated/docs → docs/ids}/components-row-docs.md +4 -4
  38. package/{generated/docs → docs/ids}/components-skeleton-docs.md +3 -3
  39. package/{generated/docs → docs/ids}/components-skeleton-recipes-docs.md +1 -1
  40. package/{generated/docs → docs/ids}/components-skiplink-docs.md +1 -1
  41. package/{generated/docs → docs/ids}/components-slideout-docs.md +113 -3
  42. package/{generated/docs → docs/ids}/components-table-ag-grid-docs.md +137 -109
  43. package/{generated/docs → docs/ids}/components-table-docs.md +597 -92
  44. package/{generated/docs → docs/ids}/components-tabset-docs.md +2 -2
  45. package/{generated/docs → docs/ids}/components-tag-docs.md +1 -1
  46. package/{generated/docs → docs/ids}/components-toaster-docs.md +5 -5
  47. package/{generated/docs → docs/ids}/foundations-colours-docs.md +1 -1
  48. package/{generated/docs → docs/ids}/foundations-typography-docs.md +2 -7
  49. package/{generated/docs → docs/ids}/get-started-develop-docs.md +3 -3
  50. package/{generated/docs → docs/ids}/introduction-docs.md +4 -4
  51. package/{generated/docs → docs/ids}/patterns-loading-docs.md +2 -332
  52. package/docs/ids/resources-migration-guides-from-v4-to-v5-docs.md +639 -0
  53. package/docs/ids/themes-available-themes-docs.md +74 -0
  54. package/docs/ids/themes-tokens-docs.md +4580 -0
  55. package/docs/ids/versions-docs.md +27 -0
  56. package/docs/tutorials/basic-integration.md +0 -0
  57. package/package.json +15 -44
  58. package/LICENSE.txt +0 -201
  59. package/dist/componentHandlers.js +0 -241
  60. package/dist/componentHandlers.test.js +0 -380
  61. package/dist/index.js +0 -53
  62. package/dist/iressHandlers.test.js +0 -316
  63. package/dist/resourceHandlers.test.js +0 -352
  64. package/dist/searchHandlers.test.js +0 -524
  65. package/dist/toolHandler.test.js +0 -369
  66. package/dist/tools.js +0 -165
  67. package/dist/utils.test.js +0 -286
  68. package/generated/docs/components-popover-docs.md +0 -464
  69. package/generated/docs/foundations-accessibility-docs.md +0 -62
  70. package/generated/docs/foundations-consistency-docs.md +0 -52
  71. package/generated/docs/foundations-content-docs.md +0 -23
  72. package/generated/docs/foundations-introduction-docs.md +0 -17
  73. package/generated/docs/foundations-principles-docs.md +0 -70
  74. package/generated/docs/foundations-user-experience-docs.md +0 -63
  75. package/generated/docs/foundations-visual-design-docs.md +0 -46
  76. package/generated/docs/guidelines.md +0 -812
  77. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  78. package/generated/docs/themes-available-themes-docs.md +0 -66
  79. package/generated/docs/themes-tokens-docs.md +0 -1200
  80. package/generated/docs/versions-docs.md +0 -17
  81. /package/{dist → build}/types.js +0 -0
  82. /package/{generated/docs → docs/ids}/components-alert-docs.md +0 -0
  83. /package/{generated/docs → docs/ids}/components-badge-docs.md +0 -0
  84. /package/{generated/docs → docs/ids}/components-button-docs.md +0 -0
  85. /package/{generated/docs → docs/ids}/components-button-recipes-docs.md +0 -0
  86. /package/{generated/docs → docs/ids}/components-buttongroup-docs.md +0 -0
  87. /package/{generated/docs → docs/ids}/components-card-docs.md +0 -0
  88. /package/{generated/docs → docs/ids}/components-divider-docs.md +0 -0
  89. /package/{generated/docs → docs/ids}/components-expander-docs.md +0 -0
  90. /package/{generated/docs → docs/ids}/components-field-docs.md +0 -0
  91. /package/{generated/docs → docs/ids}/components-inline-docs.md +0 -0
  92. /package/{generated/docs → docs/ids}/components-input-docs.md +0 -0
  93. /package/{generated/docs → docs/ids}/components-inputcurrency-docs.md +0 -0
  94. /package/{generated/docs → docs/ids}/components-label-docs.md +0 -0
  95. /package/{generated/docs → docs/ids}/components-menu-docs.md +0 -0
  96. /package/{generated/docs → docs/ids}/components-menu-menuitem-docs.md +0 -0
  97. /package/{generated/docs → docs/ids}/components-navbar-docs.md +0 -0
  98. /package/{generated/docs → docs/ids}/components-navbar-recipes-docs.md +0 -0
  99. /package/{generated/docs → docs/ids}/components-panel-docs.md +0 -0
  100. /package/{generated/docs → docs/ids}/components-placeholder-docs.md +0 -0
  101. /package/{generated/docs → docs/ids}/components-popover-recipes-docs.md +0 -0
  102. /package/{generated/docs → docs/ids}/components-progress-docs.md +0 -0
  103. /package/{generated/docs → docs/ids}/components-radio-docs.md +0 -0
  104. /package/{generated/docs → docs/ids}/components-readonly-docs.md +0 -0
  105. /package/{generated/docs → docs/ids}/components-select-docs.md +0 -0
  106. /package/{generated/docs → docs/ids}/components-slider-docs.md +0 -0
  107. /package/{generated/docs → docs/ids}/components-spinner-docs.md +0 -0
  108. /package/{generated/docs → docs/ids}/components-stack-docs.md +0 -0
  109. /package/{generated/docs → docs/ids}/components-tabset-tab-docs.md +0 -0
  110. /package/{generated/docs → docs/ids}/components-text-docs.md +0 -0
  111. /package/{generated/docs → docs/ids}/components-toaster-toast-docs.md +0 -0
  112. /package/{generated/docs → docs/ids}/components-toggle-docs.md +0 -0
  113. /package/{generated/docs → docs/ids}/components-tooltip-docs.md +0 -0
  114. /package/{generated/docs → docs/ids}/components-validationmessage-docs.md +0 -0
  115. /package/{generated/docs → docs/ids}/contact-us-docs.md +0 -0
  116. /package/{generated/docs → docs/ids}/extensions-editor-docs.md +0 -0
  117. /package/{generated/docs → docs/ids}/extensions-editor-recipes-docs.md +0 -0
  118. /package/{generated/docs → docs/ids}/frequently-asked-questions-docs.md +0 -0
  119. /package/{generated/docs → docs/ids}/get-started-using-storybook-docs.md +0 -0
  120. /package/{generated/docs → docs/ids}/resources-changelog-docs.md +0 -0
  121. /package/{generated/docs → docs/ids}/resources-code-katas-docs.md +0 -0
  122. /package/{generated/docs → docs/ids}/themes-introduction-docs.md +0 -0
@@ -68,7 +68,231 @@ Mode
68
68
 
69
69
  DiffOldNew
70
70
 
71
- <table class="css-1n5o7vh-diff-container"><tbody><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text">import { IressForm, IressField, IressInput, IressCheckboxGroup, IressCheckbox } from '@iress/components';</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text">import { IressForm, IressFormField, IressInput, IressCheckboxGroup, IressCheckbox } from '@iress-oss/ids-components';</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-10regm7-empty-line"><pre></pre></td><td class="css-vl0irh-content css-10regm7-empty-line"><pre class="css-o1u8iu-content-text"></pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-10regm7-empty-line"><pre></pre></td><td class="css-vl0irh-content css-10regm7-empty-line"><pre class="css-o1u8iu-content-text"></pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text">export const App = () =&gt; {</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text">const ConditionalFields = () =&gt; {</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> // We need to create our own state to manage the visibility of the fields, </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> // Instead of creating our own state, we can now use the form state via the useWatch hook, </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> // which means we have two sources of truth potentially making our code harder to maintain</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> // meaning we still have a single source of truth</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> const [show, setShow] = useState(['name']);</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> const show = IressForm.useWatch({ name: 'show'});</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-10regm7-empty-line"><pre></pre></td><td class="css-vl0irh-content css-10regm7-empty-line"><pre class="css-o1u8iu-content-text"></pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> return (</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressForm&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressField label="Show fields"&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;IressFormField </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressCheckboxGroup value={show} onChange={(newValues) =&gt; setShow(newValues)}&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> label="Show fields" </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> name="show"</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> render={(controlledProps) =&gt; (</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;IressCheckboxGroup {...controlledProps}&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> &lt;IressCheckbox value="name"&gt;Name&lt;/IressCheckbox&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> &lt;IressCheckbox value="email"&gt;Email&lt;/IressCheckbox&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> &lt;/IressCheckboxGroup&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;/IressField&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> )}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> {show.includes('name') &amp;&amp; (</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressField label="Name"&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> {show?.includes('name') &amp;&amp; (</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressInput name="name" /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;IressFormField </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;/IressField&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> label="Name" </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> )}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> name="name"</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> {show.includes('email') &amp;&amp; (</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> render={(controlledProps) =&gt; &lt;IressInput {...controlledProps} /&gt;}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressField label="Email"&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressInput name="email" type="email" /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> )}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;/IressField&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> {show?.includes('email') &amp;&amp; (</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> )}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;IressFormField </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;/IressForm&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> label="Email" </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> name="email"</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> render={(controlledProps) =&gt; &lt;IressInput {...controlledProps} type="email" /&gt;}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> )}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;/&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> );</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text">};</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-10regm7-empty-line css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-10regm7-empty-line css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"></pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text">export const App = () =&gt; (</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;IressForm defaultValues={{ show: ['name'] }}&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;ConditionalFields /&gt; </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;/IressForm&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text">);</pre></td></tr></tbody></table>
71
+ \-
72
+
73
+ import { IressForm, IressField, IressInput, IressCheckboxGroup, IressCheckbox } from '@iress/components';
74
+
75
+ +
76
+
77
+ import { IressForm, IressFormField, IressInput, IressCheckboxGroup, IressCheckbox } from '@iress/ids-components';
78
+
79
+ \-
80
+
81
+ export const App = () => {
82
+
83
+ +
84
+
85
+ const ConditionalFields = () => {
86
+
87
+ \-
88
+
89
+ // We need to create our own state to manage the visibility of the fields,
90
+
91
+ +
92
+
93
+ // Instead of creating our own state, we can now use the form state via the useWatch hook,
94
+
95
+ \-
96
+
97
+ // which means we have two sources of truth potentially making our code harder to maintain
98
+
99
+ +
100
+
101
+ // meaning we still have a single source of truth
102
+
103
+ \-
104
+
105
+ const \[show, setShow\] = useState(\['name'\]);
106
+
107
+ +
108
+
109
+ const show = IressForm.useWatch({ name: 'show'});
110
+
111
+ return (
112
+
113
+ \-
114
+
115
+ <IressForm>
116
+
117
+ +
118
+
119
+ <>
120
+
121
+ \-
122
+
123
+ <IressField label="Show fields">
124
+
125
+ +
126
+
127
+ <IressFormField
128
+
129
+ \-
130
+
131
+ <IressCheckboxGroup value={show} onChange={(newValues) => setShow(newValues)}>
132
+
133
+ +
134
+
135
+ label="Show fields"
136
+
137
+ +
138
+
139
+ name="show"
140
+
141
+ +
142
+
143
+ render={(controlledProps) => (
144
+
145
+ +
146
+
147
+ <IressCheckboxGroup {...controlledProps}>
148
+
149
+ <IressCheckbox value="name">Name</IressCheckbox>
150
+
151
+ <IressCheckbox value="email">Email</IressCheckbox>
152
+
153
+ </IressCheckboxGroup>
154
+
155
+ \-
156
+
157
+ </IressField>
158
+
159
+ +
160
+
161
+ )}
162
+
163
+ \-
164
+
165
+ {show.includes('name') && (
166
+
167
+ +
168
+
169
+ />
170
+
171
+ \-
172
+
173
+ <IressField label="Name">
174
+
175
+ +
176
+
177
+ {show?.includes('name') && (
178
+
179
+ \-
180
+
181
+ <IressInput name="name" />
182
+
183
+ +
184
+
185
+ <IressFormField
186
+
187
+ \-
188
+
189
+ </IressField>
190
+
191
+ +
192
+
193
+ label="Name"
194
+
195
+ \-
196
+
197
+ )}
198
+
199
+ +
200
+
201
+ name="name"
202
+
203
+ \-
204
+
205
+ {show.includes('email') && (
206
+
207
+ +
208
+
209
+ render={(controlledProps) => <IressInput {...controlledProps} />}
210
+
211
+ \-
212
+
213
+ <IressField label="Email">
214
+
215
+ +
216
+
217
+ />
218
+
219
+ \-
220
+
221
+ <IressInput name="email" type="email" />
222
+
223
+ +
224
+
225
+ )}
226
+
227
+ \-
228
+
229
+ </IressField>
230
+
231
+ +
232
+
233
+ {show?.includes('email') && (
234
+
235
+ \-
236
+
237
+ )}
238
+
239
+ +
240
+
241
+ <IressFormField
242
+
243
+ \-
244
+
245
+ </IressForm>
246
+
247
+ +
248
+
249
+ label="Email"
250
+
251
+ +
252
+
253
+ name="email"
254
+
255
+ +
256
+
257
+ render={(controlledProps) => <IressInput {...controlledProps} type="email" />}
258
+
259
+ +
260
+
261
+ />
262
+
263
+ +
264
+
265
+ )}
266
+
267
+ +
268
+
269
+ </>
270
+
271
+ );
272
+
273
+ };
274
+
275
+ +
276
+
277
+ +
278
+
279
+ export const App = () => (
280
+
281
+ +
282
+
283
+ <IressForm defaultValues={{ show: \['name'\] }}>
284
+
285
+ +
286
+
287
+ <ConditionalFields />
288
+
289
+ +
290
+
291
+ </IressForm>
292
+
293
+ +
294
+
295
+ );
72
296
 
73
297
  ### [](#validation)Validation
74
298
 
@@ -86,7 +310,105 @@ Mode
86
310
 
87
311
  DiffOldNew
88
312
 
89
- <table class="css-1n5o7vh-diff-container"><tbody><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text">import { IressForm, IressField, IressInput, IressButton } from '@iress/components';</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text">import { IressForm, IressFormField, IressInput, IressButton } from '@iress-oss/ids-components';</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-10regm7-empty-line"><pre></pre></td><td class="css-vl0irh-content css-10regm7-empty-line"><pre class="css-o1u8iu-content-text"></pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text">export const App = () =&gt; (</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressForm valueMissing="{{fieldName}} needs to be filled in!"&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;IressForm&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressField label="Name"&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;IressFormField </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressInput name="name" required /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> label="Name"</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;/IressField&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> name="name"</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressField label="Email"&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> render={(controlledProps) =&gt; &lt;IressInput {...controlledProps} /&gt;}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;IressInput name="email" maxLength={10} /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> rules={{ required: 'Name needs to be filled in!' }}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-rq9a2a-diff-removed"><pre>-</pre></td><td class="css-vl0irh-content css-rq9a2a-diff-removed"><pre class="css-o1u8iu-content-text"> &lt;/IressField&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> &lt;IressFormField </pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> label="Email"</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> name="email"</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> render={(controlledProps) =&gt; &lt;IressInput {...controlledProps} type="email" maxLength={10} /&gt;}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> rules={{ maxLength: 10 }}</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker css-cnnxkz-diff-added"><pre>+</pre></td><td class="css-vl0irh-content css-cnnxkz-diff-added"><pre class="css-o1u8iu-content-text"> /&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> &lt;IressButton type="submit" mode="primary"&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> Sign up</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> &lt;/IressButton&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text"> &lt;/IressForm&gt;</pre></td></tr><tr class="css-1n7ec1i-line"><td class="css-17vezug-marker"><pre></pre></td><td class="css-vl0irh-content"><pre class="css-o1u8iu-content-text">);</pre></td></tr></tbody></table>
313
+ \-
314
+
315
+ import { IressForm, IressField, IressInput, IressButton } from '@iress/components';
316
+
317
+ +
318
+
319
+ import { IressForm, IressFormField, IressInput, IressButton } from '@iress/ids-components';
320
+
321
+ export const App = () => (
322
+
323
+ \-
324
+
325
+ <IressForm valueMissing="{{fieldName}} needs to be filled in!">
326
+
327
+ +
328
+
329
+ <IressForm>
330
+
331
+ \-
332
+
333
+ <IressField label="Name">
334
+
335
+ +
336
+
337
+ <IressFormField
338
+
339
+ \-
340
+
341
+ <IressInput name="name" required />
342
+
343
+ +
344
+
345
+ label="Name"
346
+
347
+ \-
348
+
349
+ </IressField>
350
+
351
+ +
352
+
353
+ name="name"
354
+
355
+ \-
356
+
357
+ <IressField label="Email">
358
+
359
+ +
360
+
361
+ render={(controlledProps) => <IressInput {...controlledProps} />}
362
+
363
+ \-
364
+
365
+ <IressInput name="email" maxLength={10} />
366
+
367
+ +
368
+
369
+ rules={{ required: 'Name needs to be filled in!' }}
370
+
371
+ \-
372
+
373
+ </IressField>
374
+
375
+ +
376
+
377
+ />
378
+
379
+ +
380
+
381
+ <IressFormField
382
+
383
+ +
384
+
385
+ label="Email"
386
+
387
+ +
388
+
389
+ name="email"
390
+
391
+ +
392
+
393
+ render={(controlledProps) => <IressInput {...controlledProps} type="email" maxLength={10} />}
394
+
395
+ +
396
+
397
+ rules={{ maxLength: 10 }}
398
+
399
+ +
400
+
401
+ />
402
+
403
+ <IressButton type="submit" mode="primary">
404
+
405
+ Sign up
406
+
407
+ </IressButton>
408
+
409
+ </IressForm>
410
+
411
+ );
90
412
 
91
413
  ### [](#syncing-state)Syncing state
92
414
 
@@ -747,7 +1069,7 @@ Hide code
747
1069
  name\="IressInputDate-default"
748
1070
  render\={(controlledProps) \=> <IressInput {...controlledProps} />}
749
1071
  rules\={{
750
- minDate: new Date('2025-06-25T00:02:00.683Z')
1072
+ minDate: new Date('2025-05-15T02:18:51.404Z')
751
1073
  }}
752
1074
  />
753
1075
  <IressFormField
@@ -758,7 +1080,7 @@ Hide code
758
1080
  rules\={{
759
1081
  minDate: {
760
1082
  message: 'Please enter a date after today!',
761
- value: new Date('2025-06-25T00:02:00.683Z')
1083
+ value: new Date('2025-05-15T02:18:51.404Z')
762
1084
  }
763
1085
  }}
764
1086
  />
@@ -800,7 +1122,7 @@ Hide code
800
1122
  name\="IressInputDate-default"
801
1123
  render\={(controlledProps) \=> <IressInput {...controlledProps} />}
802
1124
  rules\={{
803
- maxDate: new Date('2025-06-25T00:02:00.683Z')
1125
+ maxDate: new Date('2025-05-15T02:18:51.404Z')
804
1126
  }}
805
1127
  />
806
1128
  <IressFormField
@@ -811,7 +1133,7 @@ Hide code
811
1133
  rules\={{
812
1134
  maxDate: {
813
1135
  message: 'Please enter a date before today!',
814
- value: new Date('2025-06-25T00:02:00.683Z')
1136
+ value: new Date('2025-05-15T02:18:51.404Z')
815
1137
  }
816
1138
  }}
817
1139
  />
@@ -974,7 +1296,7 @@ import {
974
1296
  IressInput,
975
1297
  IressStack,
976
1298
  IressButton,
977
- } from '@iress-oss/ids-components';
1299
+ } from '@iress/ids-components';
978
1300
  import { useState } from 'react';
979
1301
  interface FieldValues {
980
1302
  name?: string;
@@ -1227,7 +1549,7 @@ import {
1227
1549
  IressFormField,
1228
1550
  IressInput,
1229
1551
  IressButton,
1230
- } from '@iress-oss/ids-components';
1552
+ } from '@iress/ids-components';
1231
1553
  import { useState } from 'react';
1232
1554
  import { FieldErrors } from 'react-hook-form';
1233
1555
  interface FieldValues {
@@ -1475,7 +1797,7 @@ import {
1475
1797
  IressStack,
1476
1798
  IressToasterProvider,
1477
1799
  useToaster,
1478
- } from '@iress-oss/ids-components';
1800
+ } from '@iress/ids-components';
1479
1801
  import { useRef } from 'react';
1480
1802
  interface FieldValues {
1481
1803
  name?: string;
@@ -1577,7 +1899,7 @@ import {
1577
1899
  IressStack,
1578
1900
  IressFormField,
1579
1901
  IressInput,
1580
- } from '@iress-oss/ids-components';
1902
+ } from '@iress/ids-components';
1581
1903
  import { useRef } from 'react';
1582
1904
  interface FieldValues {
1583
1905
  name?: string;
@@ -1625,333 +1947,6 @@ export const FormReset \= () \=> {
1625
1947
 
1626
1948
  Copy
1627
1949
 
1628
- ### [](#custom-form-field-components)Custom form field components
1629
-
1630
- You can integrate custom components within `IressFormField` to create enhanced form experiences.
1631
-
1632
- This demo showcases how to embed a custom `TranscriptTextBox` component into `IressFormField` while leveraging its built-in validation rules, error handling, and state management without additional implementation.
1633
-
1634
- **Reminder:** When building custom form components, avoid managing error message state internally. This helps maintain the IressForm as the single source of truth and ensures consistent, predictable UI behavior.
1635
-
1636
- Key features demonstrated:
1637
-
1638
- * **Universal Integration Pattern**: Shows how any custom component can be embedded in IressFormField
1639
- * **Built-in Validation**: Leverages IressFormField's validation rules with custom validation logic
1640
- * **Multiple Error Messages**: Displays simultaneous validation errors (e.g., wrong file type AND too large)
1641
- * **Drag & Drop**: Files can be dragged and dropped directly onto the textarea
1642
- * **File Upload Button**: Traditional file selection via button click
1643
- * **Visual Feedback**: UI changes during drag operations with border and background updates
1644
- * **Form State Management**: Automatically integrates with form context using controlled props
1645
- * **File Management**: Display uploaded files with remove functionality using `IressPanel`
1646
-
1647
- Custom FormField Components
1648
- ===========================
1649
-
1650
- This demo showcases how to embed any custom component (TranscriptTextBox) into IressFormField while leveraging its form validation, error handling, and state management without additional implementation. When building custom form components, avoid managing error message state internally. This helps maintain the IressForm as the single source of truth and ensures consistent, predictable UI behavior.
1651
-
1652
- \*Required Transcript
1653
-
1654
- Upload or copy and paste transcript here
1655
-
1656
- Upload
1657
-
1658
- Submit
1659
-
1660
- Hide code
1661
-
1662
- \[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; }
1663
-
1664
- import React, { useState } from 'react';
1665
-
1666
- interface TranscriptFormValues {
1667
- transcript: TranscriptData | string;
1668
- }
1669
- interface TranscriptData {
1670
- content: string;
1671
- size?: number;
1672
- type: 'file' | 'text';
1673
- extension?: string;
1674
- fileName?: string;
1675
- rejectedReasons?: REJECTION\_REASONS\[\];
1676
- }
1677
- interface TranscriptTextBoxProps {
1678
- value: TranscriptData | string;
1679
- onChange: (data: TranscriptData) \=> void;
1680
- placeholder?: string;
1681
- rows?: number;
1682
- style?: React.CSSProperties;
1683
- allowedExtensions?: string\[\];
1684
- maxSizeInMB?: number;
1685
- }
1686
- interface SubmittedValuesDisplayProps {
1687
- submittedValues: TranscriptFormValues | null;
1688
- title?: string;
1689
- }
1690
- enum REJECTION\_REASONS {
1691
- TYPE \= 'type',
1692
- SIZE \= 'size',
1693
- }
1694
- const validateFile \=
1695
- (allowedExtensions: string\[\], maxSizeInMB: number) \=>
1696
- (data: TranscriptData | string) \=> {
1697
- if (
1698
- !!data &&
1699
- typeof data \=== 'object' &&
1700
- data.type \=== 'file' &&
1701
- Array.isArray(data.rejectedReasons) &&
1702
- data.rejectedReasons.length \> 0
1703
- ) {
1704
- const errors: string\[\] \= \[\];
1705
- if (data.rejectedReasons.includes(REJECTION\_REASONS.TYPE)) {
1706
- errors.push(\`Only .${allowedExtensions.join(', ')} accepted\`);
1707
- }
1708
- if (data.rejectedReasons.includes(REJECTION\_REASONS.SIZE)) {
1709
- errors.push(\`File size must be less than ${maxSizeInMB}MB\`);
1710
- }
1711
- if (errors.length \> 0) {
1712
- return errors.join('. ');
1713
- }
1714
- }
1715
- return true;
1716
- };
1717
- const TranscriptTextBox \= ({
1718
- value,
1719
- onChange,
1720
- placeholder \= 'Copy and paste transcripts OR drag and drop / upload recordings, transcripts or documents here (.txt format).',
1721
- rows \= 10,
1722
- style,
1723
- allowedExtensions \= \['txt'\],
1724
- maxSizeInMB \= 10,
1725
- }: TranscriptTextBoxProps) \=> {
1726
- // Extract content and file info from value
1727
- const currentData \=
1728
- typeof value \=== 'string'
1729
- ? { content: value, type: 'text' as const }
1730
- : value;
1731
- const currentFile \=
1732
- currentData?.type \=== 'file' &&
1733
- (!currentData.rejectedReasons || currentData.rejectedReasons.length \=== 0)
1734
- ? {
1735
- name: currentData.fileName ?? 'Unknown file',
1736
- size: currentData.size,
1737
- }
1738
- : null;
1739
- const createTranscriptData \= (
1740
- content: string,
1741
- type: 'file' | 'text',
1742
- additionalData?: Partial<TranscriptData\>,
1743
- ): TranscriptData \=> ({
1744
- content,
1745
- type,
1746
- ...additionalData,
1747
- });
1748
- const handleFileRead \= (file: File) \=> {
1749
- const reader \= new FileReader();
1750
- reader.onload \= (e) \=> {
1751
- const content \= e.target?.result as string;
1752
- onChange(
1753
- createTranscriptData(content, 'file', {
1754
- size: file.size,
1755
- extension: file.name.split('.').pop()?.toLowerCase(),
1756
- fileName: file.name,
1757
- }),
1758
- );
1759
- };
1760
- reader.onerror \= () \=> {
1761
- // Let parent handle errors through validation
1762
- onChange(
1763
- createTranscriptData('', 'file', {
1764
- fileName: file.name,
1765
- }),
1766
- );
1767
- };
1768
- reader.readAsText(file);
1769
- };
1770
- const handleTextChange \= (
1771
- e: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement\>,
1772
- textContent: string,
1773
- ) \=> {
1774
- onChange(createTranscriptData(textContent, 'text'));
1775
- };
1776
- const onFileSelected \= (files: File\[\]) \=> {
1777
- if (files.length \=== 0) return;
1778
- const file \= files\[0\];
1779
- handleFileRead(file);
1780
- };
1781
- const { getRootProps, getInputProps, open, isDragActive } \= useDropzone({
1782
- multiple: false,
1783
- noClick: true,
1784
- maxSize: maxSizeInMB \* 1024 \* 1024,
1785
- accept: allowedExtensions.reduce(
1786
- (acc, ext) \=> {
1787
- const mimeType \=
1788
- ext \=== 'txt' ? 'text/plain' : 'application/octet-stream';
1789
- acc\[mimeType\] \= acc\[mimeType\] || \[\];
1790
- acc\[mimeType\].push(\`.${ext}\`);
1791
- return acc;
1792
- },
1793
- {} as Record<string, string\[\]\>,
1794
- ),
1795
- onDrop: (acceptedFiles, rejectedFiles) \=> {
1796
- if (acceptedFiles.length \> 0) {
1797
- onFileSelected(acceptedFiles);
1798
- return;
1799
- }
1800
- if (rejectedFiles.length \> 0) {
1801
- const rejectedFile \= rejectedFiles\[0\];
1802
- const { file, errors } \= rejectedFile;
1803
- // Map error codes to rejection reasons
1804
- const errorCodeMap \= {
1805
- 'file-invalid-type': REJECTION\_REASONS.TYPE,
1806
- 'file-too-large': REJECTION\_REASONS.SIZE,
1807
- } as const;
1808
- const rejectedReasons \= errors .map((error) \=> errorCodeMap\[error.code as keyof typeof errorCodeMap\])
1809
- .filter((reason): reason is REJECTION\_REASONS \=> Boolean(reason));
1810
- onChange(
1811
- createTranscriptData('', 'file', {
1812
- fileName: file.name,
1813
- rejectedReasons,
1814
- }),
1815
- );
1816
- }
1817
- },
1818
- });
1819
- const handleUploadClick \= () \=> {
1820
- open();
1821
- };
1822
- const removeFile \= () \=> {
1823
- onChange(createTranscriptData('', 'text'));
1824
- };
1825
- return (
1826
- <IressStack gutter\="sm"\>
1827
- <div {...getRootProps()} style\={{ position: 'relative' }}\>
1828
- <input {...getInputProps()} />
1829
- <IressInput
1830
- value\={currentData?.content || ''}
1831
- onChange\={handleTextChange}
1832
- rows\={rows}
1833
- placeholder\={isDragActive ? 'Drop your file here...' : placeholder}
1834
- style\={{
1835
- boxSizing: 'border-box',
1836
- border: isDragActive ? '1px dashed #007acc' : undefined,
1837
- backgroundColor: isDragActive ? '#f0f8ff' : undefined,
1838
- ...style,
1839
- }}
1840
- />
1841
- </div\>
1842
- {currentFile && (
1843
- <IressPanel\>
1844
- <IressInline horizontalAlign\="between" verticalAlign\="middle"\>
1845
- <IressText\>📄 {currentFile.name}</IressText\>
1846
- <IressButton mode\="secondary" onClick\={removeFile}\>
1847
- Remove </IressButton\>
1848
- </IressInline\>
1849
- </IressPanel\>
1850
- )}
1851
- <IressButton
1852
- mode\="secondary"
1853
- onClick\={handleUploadClick}
1854
- prepend\={<IressIcon name\="upload" />}
1855
- \>
1856
- Upload </IressButton\>
1857
- </IressStack\>
1858
- );
1859
- };
1860
- const SubmittedValuesDisplay: React.FC<SubmittedValuesDisplayProps\> \= ({
1861
- submittedValues,
1862
- title \= 'Submitted Values:',
1863
- }) \=> {
1864
- if (!submittedValues) {
1865
- return null;
1866
- }
1867
- return (
1868
- <IressPanel\>
1869
- <IressStack gutter\="sm"\>
1870
- <IressText variant\="bold"\>{title}</IressText\>
1871
- <IressText\>
1872
- <strong\>Type:</strong\>
1873
- {typeof submittedValues.transcript \=== 'string'
1874
- ? 'text'
1875
- : submittedValues.transcript.type}
1876
- </IressText\>
1877
- <IressText\>
1878
- <strong\>Content:</strong\>
1879
- {typeof submittedValues.transcript \=== 'string'
1880
- ? submittedValues.transcript
1881
- : submittedValues.transcript.content}
1882
- </IressText\>
1883
- {typeof submittedValues.transcript \=== 'object' &&
1884
- submittedValues.transcript.fileName && (
1885
- <IressText\>
1886
- <strong\>File Name:</strong\> {submittedValues.transcript.fileName}
1887
- </IressText\>
1888
- )}
1889
- {typeof submittedValues.transcript \=== 'object' &&
1890
- submittedValues.transcript.size && (
1891
- <IressText\>
1892
- <strong\>File Size:</strong\>
1893
- {(submittedValues.transcript.size / 1024).toFixed(2)} KB </IressText\>
1894
- )}
1895
- </IressStack\>
1896
- </IressPanel\>
1897
- );
1898
- };
1899
- const Heading \= () \=> {
1900
- return (
1901
- <\>
1902
- <IressText element\="h1"\>Custom FormField Components</IressText\>
1903
- <IressText element\="p"\>
1904
- This demo showcases how to embed any custom component (TranscriptTextBox) into IressFormField while leveraging its form validation, error handling, and state management without additional implementation. When building custom form components, avoid managing error message state internally. This helps maintain the IressForm as the single source of truth and ensures consistent, predictable UI behavior. </IressText\>
1905
- </\>
1906
- );
1907
- };
1908
- export const CustomFormFieldComponents \= (
1909
- args: IressFormProps<TranscriptFormValues\>,
1910
- ) \=> {
1911
- const \[submittedValues, setSubmittedValues\] \=
1912
- useState<TranscriptFormValues | null\>(null);
1913
- const allowedExtensions \= \['txt'\];
1914
- const maxSizeInMB \= 0.1;
1915
- const handleSubmit \= (data: TranscriptFormValues) \=> {
1916
- setSubmittedValues(data);
1917
- console.log('Form submitted:', data);
1918
- };
1919
- return (
1920
- <\>
1921
- <Heading />
1922
- <IressForm<TranscriptFormValues> {...args}
1923
- mode="onChange" hiddenErrorSummary onSubmit={handleSubmit}
1924
- defaultValues={{ transcript: { content: '', type: 'text' } }}
1925
- > <IressStack gutter\="md"\>
1926
- <IressFormField
1927
- label\="Transcript"
1928
- name\="transcript"
1929
- hint\="Upload or copy and paste transcript here"
1930
- render\={(controlledProps) \=> (
1931
- <TranscriptTextBox
1932
- {...controlledProps}
1933
- allowedExtensions\={allowedExtensions}
1934
- maxSizeInMB\={maxSizeInMB}
1935
- />
1936
- )}
1937
- rules\={{
1938
- required: 'Transcript is required',
1939
- validate: {
1940
- file: validateFile(allowedExtensions, maxSizeInMB),
1941
- },
1942
- }}
1943
- />
1944
- <IressButton type\="submit" mode\="primary"\>
1945
- Submit </IressButton\>
1946
- <SubmittedValuesDisplay submittedValues\={submittedValues} />
1947
- </IressStack\>
1948
- </IressForm\>
1949
- </\>
1950
- );
1951
- };
1952
-
1953
- Copy
1954
-
1955
1950
  ### [](#forms-in-expanders-lazy-loading)Forms in expanders (lazy loading)
1956
1951
 
1957
1952
  If you are using forms in expanders, or in other scenarios when the loading of the form may be delayed, it is recommended to only load the form when it is required. This will improve performance of your application, and make it more predictable. It may also fix act warnings in tests if you are seeing some appearing due to conditionally loaded `IressForm` elements.
@@ -1971,7 +1966,7 @@ import {
1971
1966
  IressFormProps,
1972
1967
  IressInput,
1973
1968
  IressStack,
1974
- } from '@iress-oss/ids-components';
1969
+ } from '@iress/ids-components';
1975
1970
  import { useState } from 'react';
1976
1971
  interface FieldValues {
1977
1972
  name?: string;
@@ -2063,7 +2058,7 @@ import {
2063
2058
  IressInput,
2064
2059
  IressStack,
2065
2060
  IressText,
2066
- } from '@iress-oss/ids-components';
2061
+ } from '@iress/ids-components';
2067
2062
  interface FieldValues {
2068
2063
  show?: string\[\];
2069
2064
  name?: string;
@@ -2406,7 +2401,7 @@ If you are using React Hook Forms in your application, please ensure it is the s
2406
2401
 
2407
2402
  The version we are using in IDS is:
2408
2403
 
2409
- yarn add react-hook-form@7.53.1
2404
+ yarn add react-hook-form@7.55.0
2410
2405
 
2411
2406
  On this page
2412
2407
 
@@ -2430,7 +2425,6 @@ On this page
2430
2425
  * [values](#values)
2431
2426
  * [Disable validation](#disable-validation)
2432
2427
  * [Resetting the form](#resetting-the-form)
2433
- * [Custom form field components](#custom-form-field-components)
2434
2428
  * [Forms in expanders (lazy loading)](#forms-in-expanders-lazy-loading)
2435
2429
  * [Conditional fields (useWatch)](#conditional-fields-usewatch)
2436
2430
  * [IressHookForm](#iresshookform)