@nolwenture/formik-jsonschema-form 0.1.3 → 0.2.0

package/README.md

@@ -1,46 +1,149 @@
-# Getting Started with Create React App
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+# formik-jsonschema-form
+
+## Installation
+
+With npm:
+
+```text
+npm install @nolwenture/formik-jsonschema-form
+```
+
+With yarn:
+
+```text
+yarn add @nolwenture/formik-jsonschema-form
+```
+
+## Usage
+
+### Basic usage
+
+Pass your schema to the `Form` component, which should be passed as a child to the `Formik` component, for example:
+
+```tsx
+import { Form } from "@nolwenture/formik-jsonschema-form";
+import { Formik } from "formik";
+
+const schema = {
+  title: "My form",
+  type: "object",
+  properties: {
+    firstName: { type: "string", title: "First name" },
+    lastName: { type: "string", title: "Last name" },
+  },
+};
+
+const uiSchema = {
+  "ui:description": "Form description",
+  firstName: { "ui:description": "Field description" },
+};
+
+export function MyFormComponent() {
+  return (
+    <Formik
+      initialValues={{ firstName: "", lastName: "" }}
+      onSubmit={handleSubmit}
+    >
+      <Form schema={schema} uiSchema={uiSchema}></Form>
+    </Formik>
+  );
+}
+```
+
+### Using custom components
+
+Form components (such as wrappers) can be overriden with custom ones
+
+Here is an example of overriding `FieldWrapper` (wrapper used on all fields):
+
+```tsx
+function CustomFieldWrapper({ children }) {
+  return (
+    <div
+      style={{
+        backgroundColor: "lightgrey",
+        boxShadow: "1px 1px 5px gray",
+        margin: "10px",
+        padding: "10px",
+      }}
+    >
+      {children}
+    </div>
+  );
+}
+
+...
+
+return (
+  <Formik initialValues={initialValues} onSubmit={handleOnSubmit}>
+    <Form
+      schema={schema}
+      uiSchema={uiSchema}
+      components={{
+        FieldWrapper: CustomFieldWrapper,
+      }}
+    ></Form>
+  </Formik>
+);
+```
+
+Custom fields can be used in addition to all the default fields:
+
+```tsx
+import { Form, FormRegistry } from "@nolwenture/formik-jsonschema-form";
+import { useContext } from "react";
+
+const schema = {
+  title: "My form",
+  type: "object",
+  properties: {
+    firstField: { title: "First field" },
+  },
+};
+
+function MyCustomFieldComponent(props) {
+  const {
+    templates: { FieldTemplate },
+  } = useContext(FormRegistry);
+
+  return (
+    <FieldTemplate {...props}>
+      <p>My awesome field!</p>
+    </FieldTemplate>
+  );
+}
+
+const fields = { myField: MyCustomFieldComponent };
+
+// Specify the fields that should use your custom field component in uiSchema
+const uiSchema = {
+  firstField = { "ui:field": "myField" },
+};
+
+...
+
+return (
+  <Formik initialValues={initialValues} onSubmit={handleOnSubmit}>
+    <Form schema={schema} uiSchema={uiSchema} fields={fields}></Form>
+  </Formik>
+);
+```
+
+## Props
+
+`Form` component props:
+
+```tsx
+<Form
+  // Required
+  schema={schema} // Form schema
+  // Optional
+  uiSchema={uiSchema} // Form UI schema
+  className={"className"} // Form class name
+  fields={fields} // Additional custom field components
+  templates={templates} // Additional custom field templates
+  components={components} // Override form components (e.g. wrappers) with custom ones
+  formContext={formContext} // Form context
+  useItemsAsAdditionalItems={true} // Allow "items" to be used as "additionalItems" in array fields that are missing "additionalItems", false by default
+/>
+```

package/dist/Form.js

@@ -23,6 +23,7 @@ export var FormRegistry = React.createContext({
     definitions: {},
     formContext: {},
     useItemsAsAdditionalItems: false,
+    hideUnmarkedAdditionalProperties: false,
 });
 export function Form(props) {
     warnFromUnsupportedKeys("Form", props, [
@@ -37,7 +38,7 @@ export function Form(props) {
         "formContext",
     ]);
     var isSubmitting = useFormikContext().isSubmitting;
-    var schema = props.schema, _a = props.uiSchema, uiSchema = _a === void 0 ? {} : _a, className = props.className, children = props.children, _b = props.fields, fields = _b === void 0 ? {} : _b, _c = props.templates, templates = _c === void 0 ? {} : _c, _d = props.components, components = _d === void 0 ? {} : _d, _e = props.formContext, formContext = _e === void 0 ? {} : _e, _f = props.useItemsAsAdditionalItems, useItemsAsAdditionalItems = _f === void 0 ? false : _f;
+    var schema = props.schema, _a = props.uiSchema, uiSchema = _a === void 0 ? {} : _a, className = props.className, children = props.children, _b = props.fields, fields = _b === void 0 ? {} : _b, _c = props.templates, templates = _c === void 0 ? {} : _c, _d = props.components, components = _d === void 0 ? {} : _d, _e = props.formContext, formContext = _e === void 0 ? {} : _e, _f = props.useItemsAsAdditionalItems, useItemsAsAdditionalItems = _f === void 0 ? false : _f, _g = props.hideUnmarkedAdditionalProperties, hideUnmarkedAdditionalProperties = _g === void 0 ? false : _g;
     var registry = {
         fields: __assign(__assign({}, defaultFields), fields),
         templates: __assign(__assign({}, defaultTemplates), templates),
@@ -45,8 +46,9 @@ export function Form(props) {
         definitions: {},
         formContext: formContext,
         useItemsAsAdditionalItems: useItemsAsAdditionalItems,
+        hideUnmarkedAdditionalProperties: hideUnmarkedAdditionalProperties,
     };
-    var _g = registry.components, FormEl = _g.Form, FormButton = _g.FormButton, FormButtonWrapper = _g.FormButtonWrapper;
+    var _h = registry.components, FormEl = _h.Form, FormButton = _h.FormButton, FormButtonWrapper = _h.FormButtonWrapper;
     var _SchemaField = registry.fields.SchemaField;
     return (_jsx(FormRegistry.Provider, __assign({ value: registry }, { children: _jsxs(FormEl, __assign({ className: className }, { children: [_jsx(_SchemaField, { name: "", schema: schema, uiSchema: uiSchema }), children ? (children) : (_jsx(FormButtonWrapper, { children: _jsx(FormButton, __assign({ type: "submit", disabled: isSubmitting }, { children: "Send" })) }))] })) })));
 }

package/dist/fields/ObjectField.js

@@ -26,7 +26,7 @@ import { useContext, useMemo } from "react";
 import { FormRegistry } from "../Form";
 import { ObjectFieldButtonPurpose } from "../types";
 export function ObjectField(props) {
-    var _a = useContext(FormRegistry), SchemaField = _a.fields.SchemaField, ObjectFieldTemplate = _a.templates.ObjectFieldTemplate, _b = _a.components, ObjectFieldItem = _b.ObjectFieldItem, ObjectFieldList = _b.ObjectFieldList, ObjectFieldItemButtons = _b.ObjectFieldItemButtons, ObjectFieldButton = _b.ObjectFieldButton;
+    var _a = useContext(FormRegistry), SchemaField = _a.fields.SchemaField, ObjectFieldTemplate = _a.templates.ObjectFieldTemplate, _b = _a.components, ObjectFieldItem = _b.ObjectFieldItem, ObjectFieldList = _b.ObjectFieldList, ObjectFieldItemButtons = _b.ObjectFieldItemButtons, ObjectFieldButton = _b.ObjectFieldButton, hideUnmarkedAdditionalProperties = _a.hideUnmarkedAdditionalProperties;
     var name = props.name, schema = props.schema, uiSchema = props.uiSchema;
     var _c = useField(name), value = _c[0].value, _ = _c[1], setValue = _c[2].setValue;
     var properties = schema.properties, additionalProperties = schema.additionalProperties;
@@ -40,13 +40,14 @@ export function ObjectField(props) {
     return (_jsxs(ObjectFieldTemplate, __assign({}, props, { children: [Object.entries(properties || {}).map(function (_a) {
                 var childName = _a[0], childSchema = _a[1];
                 return (_jsx(SchemaField, { name: name ? [name, childName].join(".") : childName, schema: typeof childSchema !== "boolean" ? childSchema : {}, uiSchema: uiSchema === null || uiSchema === void 0 ? void 0 : uiSchema[childName] }, childName));
-            }), Object.entries(additionalValues || {}).map(function (_a) {
-                var childName = _a[0], childSchema = _a[1];
-                return (_jsxs(ObjectFieldItem, { children: [_jsx(SchemaField, { name: name ? [name, childName].join(".") : childName, schema: typeof childSchema !== "boolean" ? childSchema : {}, uiSchema: uiSchema === null || uiSchema === void 0 ? void 0 : uiSchema[childName] }, childName), _jsx(ObjectFieldItemButtons, { children: _jsx(ObjectFieldButton, { purpose: ObjectFieldButtonPurpose.REMOVE, onClick: function () {
-                                    var _a = value, _b = childName, _removedProperty = _a[_b], newValue = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
-                                    setValue(newValue);
-                                } }) })] }));
-            }), additionalProperties && (_jsx(ObjectFieldButton, { purpose: ObjectFieldButtonPurpose.ADD, onClick: function () {
+            }), (!hideUnmarkedAdditionalProperties || additionalProperties) &&
+                Object.entries(additionalValues || {}).map(function (_a) {
+                    var childName = _a[0], childSchema = _a[1];
+                    return (_jsxs(ObjectFieldItem, { children: [_jsx(SchemaField, { name: name ? [name, childName].join(".") : childName, schema: typeof childSchema !== "boolean" ? childSchema : {}, uiSchema: uiSchema === null || uiSchema === void 0 ? void 0 : uiSchema[childName] }), _jsx(ObjectFieldItemButtons, { children: _jsx(ObjectFieldButton, { purpose: ObjectFieldButtonPurpose.REMOVE, onClick: function () {
+                                        var _a = value, _b = childName, _removedProperty = _a[_b], newValue = __rest(_a, [typeof _b === "symbol" ? _b : _b + ""]);
+                                        setValue(newValue);
+                                    } }) })] }, childName));
+                }), additionalProperties && (_jsx(ObjectFieldButton, { purpose: ObjectFieldButtonPurpose.ADD, onClick: function () {
                     var _a;
                     var key = prompt("Give key");
                     if (key) {

package/dist/templates/ObjectFieldTemplate.js

@@ -1,11 +1,27 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { useContext } from "react";
 import { FormRegistry } from "../Form";
-import { getDescription, getTitle } from "../utils";
+import { getDescription, getTitle, useExtractUiSchema } from "../utils";
 export function ObjectFieldTemplate(props) {
-    var _a = useContext(FormRegistry).components, FieldDescription = _a.FieldDescription, ObjectFieldTitle = _a.ObjectFieldTitle, ObjectFieldWrapper = _a.ObjectFieldWrapper;
-    var children = props.children;
+    var _a = useContext(FormRegistry).components, FieldDescription = _a.FieldDescription, ObjectFieldTitle = _a.ObjectFieldTitle, ObjectFieldWrapper = _a.ObjectFieldWrapper, FieldHelp = _a.FieldHelp;
+    var children = props.children, uiSchema = props.uiSchema;
     var title = getTitle(props);
     var description = getDescription(props);
-    return (_jsxs(ObjectFieldWrapper, { children: [title && _jsx(ObjectFieldTitle, { children: title }), description && _jsx(FieldDescription, { children: description }), children] }));
+    var _b = useExtractUiSchema(uiSchema), help = _b.help, 
+    //TODO: This is not right
+    _c = _b.props, 
+    //TODO: This is not right
+    _d = _c === void 0 ? {} : _c, wrapperProps = _d.wrapper, titleProps = _d.title, descriptionProps = _d.description, helpProps = _d.help;
+    return (_jsxs(ObjectFieldWrapper, __assign({}, wrapperProps, { children: [title && _jsx(ObjectFieldTitle, __assign({}, titleProps, { children: title })), description && _jsx(FieldDescription, __assign({}, descriptionProps, { children: description })), children, help && _jsx(FieldHelp, __assign({}, helpProps, { children: help }))] })));
 }

package/dist/types.d.ts

@@ -5,6 +5,8 @@ export type FormProps<T> = React.PropsWithChildren<{
     disabled?: boolean | undefined;
     /** If true, array field schemas missing 'additionalItems' will replace it with 'items'  */
     useItemsAsAdditionalItems?: boolean | undefined;
+    /** If true, properties in object fields' data that aren't in the schema will only be displayed if `additionalProperties` is enabled in the schema */
+    hideUnmarkedAdditionalProperties?: boolean;
     className?: string | undefined;
     /** Form schema */
     schema: Schema;
@@ -43,6 +45,7 @@ export type FormRegistryContextValue = {
     definitions: Record<string, any>;
     formContext: Record<string, any>;
     useItemsAsAdditionalItems: boolean;
+    hideUnmarkedAdditionalProperties: boolean;
 };
 export interface FieldProps extends Pick<React.HTMLAttributes<HTMLElement>, Exclude<keyof React.HTMLAttributes<HTMLElement>, "onBlur">> {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nolwenture/formik-jsonschema-form",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Formik form generation from json schema",
   "author": "Antti Vikman <antti.vikman@nolwenture.com>",
   "contributors": [