@rjsf/primereact 6.0.0-beta.20 → 6.0.0-beta.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/primereact",
-  "version": "6.0.0-beta.20",
+  "version": "6.0.0-beta.22",
   "description": "PrimeReact theme, fields and widgets for react-jsonschema-form",
   "main": "dist/index.js",
   "module": "lib/index.js",
@@ -61,17 +61,17 @@
     "node": ">=20"
   },
   "peerDependencies": {
-    "@rjsf/core": "^6.0.0-beta.20",
-    "@rjsf/utils": "^6.0.0-beta.20",
+    "@rjsf/core": "^6.0.0-beta.22",
+    "@rjsf/utils": "^6.0.0-beta.22",
     "primeicons": ">=6.0.0",
     "primereact": ">=8.0.0",
     "react": ">=18"
   },
   "devDependencies": {
-    "@rjsf/core": "^6.0.0-beta.20",
-    "@rjsf/snapshot-tests": "^6.0.0-beta.20",
-    "@rjsf/utils": "^6.0.0-beta.20",
-    "@rjsf/validator-ajv8": "^6.0.0-beta.20",
+    "@rjsf/core": "^6.0.0-beta.22",
+    "@rjsf/snapshot-tests": "^6.0.0-beta.22",
+    "@rjsf/utils": "^6.0.0-beta.22",
+    "@rjsf/validator-ajv8": "^6.0.0-beta.22",
     "@rollup/plugin-replace": "^6.0.2",
     "eslint": "^8.57.1",
     "primeflex": "^4.0.0",

package/src/ArrayFieldItemTemplate/ArrayFieldItemTemplate.tsx

@@ -1,5 +1,5 @@
 import {
-  ArrayFieldItemTemplateType,
+  ArrayFieldItemTemplateProps,
   FormContextType,
   getTemplate,
   getUiOptions,
@@ -9,13 +9,13 @@ import {
 
 /** The `ArrayFieldItemTemplate` component is the template used to render an items of an array.
  *
- * @param props - The `ArrayFieldItemTemplateType` props for the component
+ * @param props - The `ArrayFieldItemTemplateProps` props for the component
  */
 export default function ArrayFieldItemTemplate<
   T = any,
   S extends StrictRJSFSchema = RJSFSchema,
   F extends FormContextType = any,
->(props: ArrayFieldItemTemplateType<T, S, F>) {
+>(props: ArrayFieldItemTemplateProps<T, S, F>) {
   const { children, buttonsProps, hasToolbar, uiSchema, registry } = props;
   const uiOptions = getUiOptions<T, S, F>(uiSchema);
   const ArrayFieldItemButtonsTemplate = getTemplate<'ArrayFieldItemButtonsTemplate', T, S, F>(

package/src/ArrayFieldTemplate/ArrayFieldTemplate.tsx

@@ -3,11 +3,9 @@ import {
   getUiOptions,
   isFixedItems,
   ArrayFieldTemplateProps,
-  ArrayFieldItemTemplateType,
   FormContextType,
   RJSFSchema,
   StrictRJSFSchema,
-  UI_OPTIONS_KEY,
   buttonId,
 } from '@rjsf/utils';
 import { Fieldset } from 'primereact/fieldset';
@@ -15,7 +13,7 @@ import AddButton from '../AddButton';
 
 /** The `ArrayFieldTemplate` component is the template used to render all items in an array.
  *
- * @param props - The `ArrayFieldItemTemplateType` props for the component
+ * @param props - The `ArrayFieldTemplateProps` props for the component
  */
 export default function ArrayFieldTemplate<
   T = any,
@@ -29,6 +27,7 @@ export default function ArrayFieldTemplate<
     className,
     disabled,
     items,
+    optionalDataControl,
     onAddClick,
     readonly,
     schema,
@@ -44,16 +43,12 @@ export default function ArrayFieldTemplate<
     registry,
     uiOptions,
   );
-  const ArrayFieldItemTemplate = getTemplate<'ArrayFieldItemTemplate', T, S, F>(
-    'ArrayFieldItemTemplate',
-    registry,
-    uiOptions,
-  );
   const ArrayFieldTitleTemplate = getTemplate<'ArrayFieldTitleTemplate', T, S, F>(
     'ArrayFieldTitleTemplate',
     registry,
     uiOptions,
   );
+  const showOptionalDataControlInTitle = !readonly && !disabled;
 
   return (
     <>
@@ -64,6 +59,7 @@ export default function ArrayFieldTemplate<
         uiSchema={uiSchema}
         required={required}
         registry={registry}
+        optionalDataControl={showOptionalDataControlInTitle ? optionalDataControl : undefined}
       />
       <Fieldset
         {...rest}
@@ -79,16 +75,8 @@ export default function ArrayFieldTemplate<
         />
         <div key={`array-item-list-${fieldPathId.$id}`}>
           <div>
-            {items &&
-              items.map(({ key, uiSchema: itemUiSchema = {}, ...props }: ArrayFieldItemTemplateType<T, S, F>) => {
-                const mergedUiSchema = {
-                  ...itemUiSchema,
-                  [UI_OPTIONS_KEY]: {
-                    ...itemUiSchema[UI_OPTIONS_KEY],
-                  },
-                };
-                return <ArrayFieldItemTemplate key={key} {...props} uiSchema={mergedUiSchema} />;
-              })}
+            {!showOptionalDataControlInTitle ? optionalDataControl : undefined}
+            {items}
           </div>
           {canAdd && (
             <div

package/src/ArrayFieldTitleTemplate/ArrayFieldTitleTemplate.tsx

@@ -15,11 +15,20 @@ export default function ArrayFieldTitleTemplate<
   T = any,
   S extends StrictRJSFSchema = RJSFSchema,
   F extends FormContextType = any,
->({ title, uiSchema, required, fieldPathId }: ArrayFieldTitleProps<T, S, F>) {
+>({ title, uiSchema, required, fieldPathId, optionalDataControl }: ArrayFieldTitleProps<T, S, F>) {
   const uiOptions = getUiOptions<T, S, F>(uiSchema);
-  return (
+  let heading = (
     <h5 id={titleId(fieldPathId)} style={{ margin: 0, fontSize: '1.5rem', marginBottom: '0.2rem' }}>
       {uiOptions.title || title} {required ? '*' : ''}
     </h5>
   );
+  if (optionalDataControl) {
+    heading = (
+      <div style={{ display: 'flex' }}>
+        <div style={{ flexGrow: 1 }}>{heading}</div>
+        <div>{optionalDataControl}</div>
+      </div>
+    );
+  }
+  return heading;
 }

package/src/BaseInputTemplate/BaseInputTemplate.tsx

@@ -19,6 +19,7 @@ export default function BaseInputTemplate<
 >(props: BaseInputTemplateProps<T, S, F>) {
   const {
     id,
+    htmlName,
     placeholder,
     value,
     required,
@@ -52,7 +53,7 @@ export default function BaseInputTemplate<
   return (
     <InputText
       id={id}
-      name={id}
+      name={htmlName || id}
       placeholder={placeholder}
       {...primeProps}
       {...inputProps}

package/src/CheckboxWidget/CheckboxWidget.tsx

@@ -25,6 +25,7 @@ export default function CheckboxWidget<
 >(props: WidgetProps<T, S, F>) {
   const {
     id,
+    htmlName,
     value,
     disabled,
     readonly,
@@ -68,7 +69,7 @@ export default function CheckboxWidget<
       <div style={{ display: 'flex', flexDirection: 'row', gap: '0.5rem', alignItems: 'center' }}>
         <Checkbox
           inputId={id}
-          name={id}
+          name={htmlName || id}
           {...primeProps}
           disabled={disabled || readonly}
           autoFocus={autofocus}

package/src/CheckboxesWidget/CheckboxesWidget.tsx

@@ -27,6 +27,7 @@ export default function CheckboxesWidget<
 >(props: WidgetProps<T, S, F>) {
   const {
     id,
+    htmlName,
     disabled,
     options,
     value,
@@ -85,7 +86,7 @@ export default function CheckboxesWidget<
             <div key={index} style={{ display: 'flex', flexDirection: 'row', gap: '0.5rem', alignItems: 'center' }}>
               <Checkbox
                 inputId={optionId(id, index)}
-                name={id}
+                name={htmlName || id}
                 {...primeProps}
                 value={option.value}
                 checked={checked}

package/src/IconButton/IconButton.tsx

@@ -1,17 +1,21 @@
-import { Button } from 'primereact/button';
+import { Button, ButtonProps } from 'primereact/button';
 import { FormContextType, IconButtonProps, RJSFSchema, StrictRJSFSchema, TranslatableString } from '@rjsf/utils';
 
-function IconButton<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
-  props: IconButtonProps<T, S, F>,
+export type PrimeIconButtonProps<
+  T = any,
+  S extends StrictRJSFSchema = RJSFSchema,
+  F extends FormContextType = any,
+> = IconButtonProps<T, S, F> & Omit<ButtonProps, 'onClick'>;
+
+export default function IconButton<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
+  props: PrimeIconButtonProps<T, S, F>,
 ) {
   const { icon, iconType, uiSchema, registry, ...otherProps } = props;
   return <Button icon={`pi pi-${icon}`} rounded text severity='secondary' {...otherProps} />;
 }
 
-export default IconButton;
-
 export function CopyButton<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
-  props: IconButtonProps<T, S, F>,
+  props: PrimeIconButtonProps<T, S, F>,
 ) {
   const {
     registry: { translateString },
@@ -20,7 +24,7 @@ export function CopyButton<T = any, S extends StrictRJSFSchema = RJSFSchema, F e
 }
 
 export function MoveDownButton<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
-  props: IconButtonProps<T, S, F>,
+  props: PrimeIconButtonProps<T, S, F>,
 ) {
   const {
     registry: { translateString },
@@ -29,7 +33,7 @@ export function MoveDownButton<T = any, S extends StrictRJSFSchema = RJSFSchema,
 }
 
 export function MoveUpButton<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
-  props: IconButtonProps<T, S, F>,
+  props: PrimeIconButtonProps<T, S, F>,
 ) {
   const {
     registry: { translateString },
@@ -38,7 +42,7 @@ export function MoveUpButton<T = any, S extends StrictRJSFSchema = RJSFSchema, F
 }
 
 export function RemoveButton<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
-  props: IconButtonProps<T, S, F>,
+  props: PrimeIconButtonProps<T, S, F>,
 ) {
   const {
     registry: { translateString },

package/src/ObjectFieldTemplate/ObjectFieldTemplate.tsx

@@ -24,7 +24,8 @@ export default function ObjectFieldTemplate<
 >(props: ObjectFieldTemplateProps<T, S, F>) {
   const {
     description,
-    onAddClick,
+    optionalDataControl,
+    onAddProperty,
     title,
     properties,
     disabled,
@@ -43,6 +44,7 @@ export default function ObjectFieldTemplate<
     registry,
     uiOptions,
   );
+  const showOptionalDataControlInTitle = !readonly && !disabled;
   // Button templates are not overridden in the uiSchema
   const {
     ButtonTemplates: { AddButton },
@@ -57,6 +59,7 @@ export default function ObjectFieldTemplate<
           schema={schema}
           uiSchema={uiSchema}
           registry={registry}
+          optionalDataControl={showOptionalDataControlInTitle ? optionalDataControl : undefined}
         />
       )}
       {description && (
@@ -70,6 +73,7 @@ export default function ObjectFieldTemplate<
           />
         </div>
       )}
+      {!showOptionalDataControlInTitle ? optionalDataControl : undefined}
       {properties.map((prop) => prop.content)}
       {canExpand<T, S, F>(schema, uiSchema, formData) && (
         <div style={{ marginTop: '1rem', textAlign: 'right' }}>
@@ -77,7 +81,7 @@ export default function ObjectFieldTemplate<
             id={buttonId(fieldPathId, 'add')}
             className='rjsf-object-property-expand'
             icon='pi pi-plus'
-            onClick={onAddClick(schema)}
+            onClick={onAddProperty}
             disabled={disabled || readonly}
             registry={registry}
           />

package/src/OptionalDataControlsTemplate/OptionalDataControlsTemplate.tsx

@@ -0,0 +1,44 @@
+import { FormContextType, OptionalDataControlsTemplateProps, RJSFSchema, StrictRJSFSchema } from '@rjsf/utils';
+
+import IconButton, { RemoveButton } from '../IconButton';
+
+/** The OptionalDataControlsTemplate renders one of three different states. If
+ * there is an `onAddClick()` function, it renders the "Add" button. If there is
+ * an `onRemoveClick()` function, it renders the "Remove" button. Otherwise it
+ * renders the "No data found" section. All of them use the `label` as either
+ * the `title` of buttons or simply outputting it.
+ *
+ * @param props - The `OptionalDataControlsTemplateProps` for the template
+ */
+export default function OptionalDataControlsTemplate<
+  T = any,
+  S extends StrictRJSFSchema = RJSFSchema,
+  F extends FormContextType = any,
+>(props: OptionalDataControlsTemplateProps<T, S, F>) {
+  const { id, registry, label, onAddClick, onRemoveClick } = props;
+  if (onAddClick) {
+    return (
+      <IconButton
+        id={id}
+        registry={registry}
+        className='rjsf-add-optional-data'
+        onClick={onAddClick}
+        title={label}
+        icon='pi pi-plus'
+        style={{ height: '1.5rem', width: '1.5rem' }} // Shrink the button
+      />
+    );
+  } else if (onRemoveClick) {
+    return (
+      <RemoveButton
+        id={id}
+        registry={registry}
+        className='rjsf-remove-optional-data'
+        onClick={onRemoveClick}
+        title={label}
+        style={{ height: '1.5rem', width: '1.5rem' }} // Shrink the button
+      />
+    );
+  }
+  return <em id={id}>{label}</em>;
+}

package/src/OptionalDataControlsTemplate/index.ts

@@ -0,0 +1,2 @@
+export { default } from './OptionalDataControlsTemplate';
+export * from './OptionalDataControlsTemplate';

package/src/RadioWidget/RadioWidget.tsx

@@ -18,7 +18,7 @@ import { RadioButton, RadioButtonChangeEvent } from 'primereact/radiobutton';
 export default function RadioWidget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
   props: WidgetProps<T, S, F>,
 ) {
-  const { id, value, disabled, readonly, onChange, onBlur, onFocus, options } = props;
+  const { id, htmlName, value, disabled, readonly, onChange, onBlur, onFocus, options } = props;
   const primeProps = (options.prime || {}) as object;
   const { enumOptions, enumDisabled, emptyValue } = options;
 
@@ -39,7 +39,7 @@ export default function RadioWidget<T = any, S extends StrictRJSFSchema = RJSFSc
             <div key={index} style={{ display: 'flex', alignItems: 'center' }}>
               <RadioButton
                 inputId={optionId(id, index)}
-                name={id}
+                name={htmlName || id}
                 {...primeProps}
                 onFocus={_onFocus}
                 onBlur={_onBlur}

package/src/SelectWidget/SelectWidget.tsx

@@ -27,6 +27,7 @@ export default function SelectWidget<T = any, S extends StrictRJSFSchema = RJSFS
 function SingleSelectWidget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>({
   schema,
   id,
+  htmlName,
   name, // remove this from dropdownProps
   options,
   label,
@@ -46,7 +47,6 @@ function SingleSelectWidget<T = any, S extends StrictRJSFSchema = RJSFSchema, F
   registry,
   uiSchema,
   hideError,
-  formContext,
   ...dropdownProps
 }: WidgetProps<T, S, F>) {
   const { enumOptions, enumDisabled, emptyValue: optEmptyVal } = options;
@@ -68,7 +68,7 @@ function SingleSelectWidget<T = any, S extends StrictRJSFSchema = RJSFSchema, F
   return (
     <Dropdown
       id={id}
-      name={id}
+      name={htmlName || id}
       {...primeProps}
       value={!isEmpty && typeof selectedIndexes !== 'undefined' ? selectedIndexes : emptyValue}
       options={(enumOptions ?? []).map(({ value, label }, i: number) => ({
@@ -90,6 +90,7 @@ function SingleSelectWidget<T = any, S extends StrictRJSFSchema = RJSFSchema, F
 
 function MultiSelectWidget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>({
   id,
+  htmlName,
   options,
   disabled,
   placeholder,
@@ -117,7 +118,7 @@ function MultiSelectWidget<T = any, S extends StrictRJSFSchema = RJSFSchema, F e
   return (
     <MultiSelect
       id={id}
-      name={id}
+      name={htmlName || id}
       {...primeProps}
       value={!isEmpty && typeof selectedIndexes !== 'undefined' ? selectedIndexes : emptyValue}
       options={(enumOptions ?? []).map(({ value, label }, i: number) => ({

package/src/Templates/Templates.ts

@@ -12,6 +12,7 @@ import FieldHelpTemplate from '../FieldHelpTemplate';
 import FieldTemplate from '../FieldTemplate';
 import MultiSchemaFieldTemplate from '../MultiSchemaFieldTemplate';
 import ObjectFieldTemplate from '../ObjectFieldTemplate';
+import OptionalDataControlsTemplate from '../OptionalDataControlsTemplate';
 import SubmitButton from '../SubmitButton';
 import TitleField from '../TitleField';
 import WrapIfAdditionalTemplate from '../WrapIfAdditionalTemplate';
@@ -43,6 +44,7 @@ export function generateTemplates<
     FieldTemplate,
     MultiSchemaFieldTemplate,
     ObjectFieldTemplate,
+    OptionalDataControlsTemplate,
     TitleFieldTemplate: TitleField,
     WrapIfAdditionalTemplate,
     GridTemplate,

package/src/TextareaWidget/TextareaWidget.tsx

@@ -11,7 +11,7 @@ export default function TextareaWidget<
   S extends StrictRJSFSchema = RJSFSchema,
   F extends FormContextType = any,
 >(props: WidgetProps<T, S, F>) {
-  const { id, value, required, disabled, readonly, autofocus, onChange, onBlur, onFocus, options } = props;
+  const { id, htmlName, value, required, disabled, readonly, autofocus, onChange, onBlur, onFocus, options } = props;
   const primeProps = (options.prime || {}) as object;
 
   let rows = 5;
@@ -27,6 +27,7 @@ export default function TextareaWidget<
   return (
     <InputTextarea
       id={id}
+      name={htmlName || id}
       {...primeProps}
       value={value || ''}
       required={required}

package/src/TitleField/TitleField.tsx

@@ -10,13 +10,25 @@ export default function TitleField<T = any, S extends StrictRJSFSchema = RJSFSch
   title,
   uiSchema,
   required,
+  optionalDataControl,
 }: TitleFieldProps<T, S, F>) {
   const uiOptions = getUiOptions<T, S, F>(uiSchema);
+  let heading = (
+    <h5 style={{ margin: 0, fontSize: id === titleId('root') ? '1.5rem' : '1.2rem' }}>
+      {uiOptions.title || title} {required ? '*' : ''}
+    </h5>
+  );
+  if (optionalDataControl) {
+    heading = (
+      <div style={{ display: 'flex' }}>
+        <div style={{ flexGrow: 1 }}>{heading}</div>
+        <div style={{ marginLeft: '-5px' }}>{optionalDataControl}</div>
+      </div>
+    );
+  }
   return (
     <div id={id}>
-      <h5 style={{ margin: 0, fontSize: id === titleId('root') ? '1.5rem' : '1.2rem' }}>
-        {uiOptions.title || title} {required ? '*' : ''}
-      </h5>
+      {heading}
       <Divider pt={{ root: { style: { marginTop: '0.5rem' } } }} />
     </div>
   );

package/src/WrapIfAdditionalTemplate/WrapIfAdditionalTemplate.tsx

@@ -1,4 +1,3 @@
-import { FocusEvent } from 'react';
 import {
   ADDITIONAL_PROPERTY_FLAG,
   buttonId,
@@ -26,8 +25,8 @@ export default function WrapIfAdditionalTemplate<
   disabled,
   id,
   label,
-  onDropPropertyClick,
-  onKeyChange,
+  onRemoveProperty,
+  onKeyRenameBlur,
   readonly,
   required,
   schema,
@@ -46,8 +45,6 @@ export default function WrapIfAdditionalTemplate<
     );
   }
 
-  const handleBlur = ({ target }: FocusEvent<HTMLInputElement>) => onKeyChange(target.value);
-
   return (
     <div
       className={classNames}
@@ -63,7 +60,7 @@ export default function WrapIfAdditionalTemplate<
           name={`${id}-key`}
           defaultValue={label}
           disabled={disabled || readonly}
-          onBlur={!readonly ? handleBlur : undefined}
+          onBlur={!readonly ? onKeyRenameBlur : undefined}
           required={required}
           style={{ width: '100%' }}
         />
@@ -74,7 +71,7 @@ export default function WrapIfAdditionalTemplate<
           id={buttonId(id, 'remove')}
           className='rjsf-object-property-remove'
           disabled={disabled || readonly}
-          onClick={onDropPropertyClick(label)}
+          onClick={onRemoveProperty}
           registry={registry}
         />
       </div>