react-formule 1.1.1 → 1.2.0

package/README.md

@@ -67,7 +67,7 @@ Formule includes a variety of predefined field types, grouped in three categorie
 
 You can freely remove some of these predefined fields and add your own custom fields and widgets following the JSON Schema specifications. More details below.
 
-All of these items contain different settings that you can tinker with, separated into **Schema Settings** (_generally_ affecting how the field _works_) and **UI Schema Settings** (_generally_ affecting how the field _looks_ like).
+All of these items contain different settings that you can tinker with, separated into **Schema Settings** (_generally_ affecting how the field _works_) and **UI Schema Settings** (_generally_ affecting how the field _looks like_).
 
 ## :horse_racing: Setting it up
 
@@ -101,12 +101,29 @@ const useEffect(() => initFormuleSchema(), []);
 
 ### Customizing and adding new field types
 
+Override (if existing) or create your own field types (rjsf type definitions) similarly to how it's done in `fieldTypes.jsx`, passing them as `customFieldTypes`. Implement your own custom fields and widgets (react components) by passing them as `customFields` and/or `customWidgets` (see `forms/fields/` and `forms/widgets/` for examples). If you also want to use a different published version of a field or widget, pass the component in `customPublishedFields` or `customPublishedWidgets`.
+
 ```jsx
+const customFieldTypes = {
+  advanced: {
+    myfield: {
+      title: ...
+      ...
+    }
+  }
+}
+
+const customFields: {
+  myfield: MyField  // react component
+}
+
 <FormuleContext
-  theme={{token: {colorPrimary: "blue"}}}
-  customFieldTypes={...}
-  customFields={...}
-  customWidgets={...}>
+  theme={{token: {colorPrimary: "blue"}}} // antd theme
+  customFieldTypes={customFieldTypes}
+  customFields={customFields}
+  customWidgets={...}
+  customPublishedFields={...}
+  customPublishedWidgets={...}>
 // ...
 </FormuleContext>
 ```
@@ -115,7 +132,7 @@ If you use Formule to edit existing JSON schemas that include extra fields (e.g.
 
 ```jsx
 const transformSchema = (schema) => {
-  // Remove properties...
+  // Remove properties here...
   return transformedSchema;
 };
 

package/dist/admin/formComponents/ObjectFieldTemplate.d.ts

@@ -1,6 +1,6 @@
 import { default as PropTypes } from 'prop-types';
 export default ObjectFieldTemplate;
-declare function ObjectFieldTemplate({ properties, uiSchema, formContext, idSchema }: {
+declare function ObjectFieldTemplate({ properties, uiSchema, formContext, idSchema, }: {
     properties: any;
     uiSchema: any;
     formContext: any;

package/dist/admin/utils/index.d.ts

@@ -5,7 +5,6 @@ export namespace SIZE_OPTIONS {
     let large: number;
     let xlarge: number;
 }
-export function slugify(text: any): any;
 export function initSchemaStructure(name?: string, description?: string): {
     schema: {
         title: string;

package/dist/exposed.d.ts

@@ -8,12 +8,14 @@ type FormuleContextProps = {
     customFieldTypes?: object;
     customFields?: object;
     customWidgets?: object;
+    customPublishedFields?: object;
+    customPublishedWidgets?: object;
     theme?: ThemeConfig;
     separator?: string;
     synchronizeState?: (state: SchemaWizardState) => void;
     transformSchema?: (schema: object) => object;
 };
-export declare const FormuleContext: ({ children, customFieldTypes, customFields, customWidgets, theme, separator, synchronizeState, transformSchema, }: FormuleContextProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FormuleContext: ({ children, customFieldTypes, customFields, customWidgets, customPublishedFields, customPublishedWidgets, theme, separator, synchronizeState, transformSchema, }: FormuleContextProps) => import("react/jsx-runtime").JSX.Element;
 export declare const initFormuleSchema: (data?: RJSFSchema, name?: string, description?: string) => void;
 export declare const getFormuleState: () => {
     current: {

package/dist/forms/fields/internal/TitleField.d.ts

@@ -1,7 +1,7 @@
 import { default as PropTypes } from 'prop-types';
 export default TitleField;
 declare function TitleField({ formContext, id, fieldId, prefixCls, required, title, uiEmail, uiImport, uiLatex, enableEmail, enableImport, enableLatex, readonly, titleIsMarkdown, isObject, hideAnchors, }: {
-    formContext: any;
+    formContext?: {} | undefined;
     id: any;
     fieldId: any;
     prefixCls: any;
@@ -30,8 +30,4 @@ declare namespace TitleField {
         let enableLatex: PropTypes.Requireable<(...args: any[]) => any>;
         let enableImport: PropTypes.Requireable<(...args: any[]) => any>;
     }
-    namespace defaultProps {
-        let formContext_1: {};
-        export { formContext_1 as formContext };
-    }
 }

package/dist/forms/templates/ArrayFieldTemplates/ArrayFieldTemplateItem.d.ts

@@ -17,7 +17,6 @@ declare namespace ArrayFieldTemplateItem {
     namespace propTypes {
         let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
         let disabled: PropTypes.Requireable<boolean>;
-        let formContext: PropTypes.Requireable<object>;
         let hasMoveDown: PropTypes.Requireable<boolean>;
         let hasMoveUp: PropTypes.Requireable<boolean>;
         let hasRemove: PropTypes.Requireable<boolean>;
@@ -27,8 +26,4 @@ declare namespace ArrayFieldTemplateItem {
         let onReorderClick: PropTypes.Requireable<(...args: any[]) => any>;
         let readonly: PropTypes.Requireable<boolean>;
     }
-    namespace defaultProps {
-        let formContext_1: {};
-        export { formContext_1 as formContext };
-    }
 }

package/dist/forms/widgets/published/DateWidget.d.ts

@@ -0,0 +1,5 @@
+export default DateWidget;
+declare function DateWidget({ value, schema }: {
+    value: any;
+    schema: any;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/forms/widgets/published/SelectWidget.d.ts

@@ -0,0 +1,4 @@
+export default SelectWidget;
+declare function SelectWidget({ value }: {
+    value: any;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/forms/widgets/published/TextBoxWidget.d.ts

@@ -0,0 +1,5 @@
+export default TextBoxWidget;
+declare function TextBoxWidget({ value, Icon }: {
+    value: any;
+    Icon: any;
+}): import("react/jsx-runtime").JSX.Element[] | undefined;

package/dist/forms/widgets/published/UriWidget.d.ts

@@ -2,7 +2,7 @@ import { default as PropTypes } from 'prop-types';
 export default UriWidget;
 declare function UriWidget({ value }: {
     value: any;
-}): import("react/jsx-runtime").JSX.Element;
+}): any;
 declare namespace UriWidget {
     namespace propTypes {
         let value: PropTypes.Requireable<string>;

package/dist/forms/widgets/published/index.d.ts

@@ -1,6 +1,8 @@
 import { default as TextWidget } from './TextWidget';
 import { default as UriWidget } from './UriWidget';
 import { default as RichEditorWidget } from './RichEditorWidget';
+import { default as DateWidget } from './DateWidget';
+import { default as SelectWidget } from './SelectWidget';
 export default widgets;
 declare namespace widgets {
     export { TextWidget as text };
@@ -8,4 +10,6 @@ declare namespace widgets {
     export { UriWidget as uri };
     export { RichEditorWidget as richeditor };
     export { RichEditorWidget as latex };
+    export { DateWidget as date };
+    export { SelectWidget as select };
 }