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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/primereact",
-  "version": "6.0.0-beta.20",
+  "version": "6.0.0-beta.21",
   "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.21",
+    "@rjsf/utils": "^6.0.0-beta.21",
     "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.21",
+    "@rjsf/snapshot-tests": "^6.0.0-beta.21",
+    "@rjsf/utils": "^6.0.0-beta.21",
+    "@rjsf/validator-ajv8": "^6.0.0-beta.21",
     "@rollup/plugin-replace": "^6.0.2",
     "eslint": "^8.57.1",
     "primeflex": "^4.0.0",

package/src/ArrayFieldTemplate/ArrayFieldTemplate.tsx

@@ -29,6 +29,7 @@ export default function ArrayFieldTemplate<
     className,
     disabled,
     items,
+    optionalDataControl,
     onAddClick,
     readonly,
     schema,
@@ -54,6 +55,7 @@ export default function ArrayFieldTemplate<
     registry,
     uiOptions,
   );
+  const showOptionalDataControlInTitle = !readonly && !disabled;
 
   return (
     <>
@@ -64,6 +66,7 @@ export default function ArrayFieldTemplate<
         uiSchema={uiSchema}
         required={required}
         registry={registry}
+        optionalDataControl={showOptionalDataControlInTitle ? optionalDataControl : undefined}
       />
       <Fieldset
         {...rest}
@@ -79,16 +82,16 @@ 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.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} />;
+            })}
           </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/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,6 +24,7 @@ export default function ObjectFieldTemplate<
 >(props: ObjectFieldTemplateProps<T, S, F>) {
   const {
     description,
+    optionalDataControl,
     onAddClick,
     title,
     properties,
@@ -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' }}>

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/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/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>
   );