@rebasepro/formex 0.0.1-canary.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rebase
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,165 @@
+# Formex - React Form Library
+
+Formex is a lightweight, flexible library designed to simplify form handling within React applications. By leveraging React's powerful context and hooks features, Formex allows for efficient form state management with minimal boilerplate code.
+
+## Features
+
+- Lightweight and easy to integrate
+- Supports custom field components
+- Built-in validation handling
+- Provides both field-level and form-level state management
+
+## Installation
+
+To install Formex, you can use either npm or yarn:
+
+```sh
+npm install @rebasepro/formex
+
+# or if you're using yarn
+
+yarn add @rebasepro/formex
+```
+
+## Quick Start
+
+To get started with Formex, you first need to create your form context and form controller using the `useCreateFormex` hook. Then, you can structure your form using the `<Field />` components provided by Formex.
+
+### Step 1: Create your form controller
+
+```jsx
+import React from 'react';
+import { useCreateFormex } from 'formex-library';
+
+const MyForm = () => {
+    const formController = useCreateFormex({
+        initialValues: {
+            name: '',
+            email: '',
+        },
+        // Optionally add a validation function
+        // validation: values => {
+        //   const errors = {};
+        //   if (!values.name) errors.name = 'Name is required';
+        //   return errors;
+        // },
+        onSubmit: (values) => {
+            console.log('Form Submitted:', values);
+        },
+    });
+
+    return (
+        <form onSubmit={formController.handleSubmit}>
+            {/* Field components go here */}
+        </form>
+    );
+};
+```
+
+### Step 2: Use the `<Field />` component
+
+```jsx
+import { Field } from 'formex-library';
+
+// Inside your form component
+<Field name="name">
+  {({ field }) => (
+    <input
+      {...field}
+      placeholder="Your name"
+    />
+  )}
+</Field>
+
+<Field name="email">
+  {({ field }) => (
+    <input
+      {...field}
+      type="email"
+      placeholder="Your email"
+    />
+  )}
+</Field>
+
+<button type="submit">Submit</button>
+```
+
+### Handling Submissions
+
+Wrap your form inputs and submit button within a form element and pass the `submitForm` method from your form controller to the form's `onSubmit` event:
+
+```jsx
+<form onSubmit={formController.handleSubmit}>
+    {/* Fields and submit button */}
+</form>
+```
+
+## API Reference
+
+### `useCreateFormex`
+
+Hook to create a form controller.
+
+**Parameters**
+
+- `initialValues`: An object with your form's initial values.
+- `initialErrors` (optional): An object for any initial validation errors.
+- `validation` (optional): A function for validating form data.
+- `validateOnChange` (optional): If `true`, validates fields whenever they change.
+- `onSubmit`: A function that fires when the form is submitted.
+
+
+### `<Field />`
+
+A component used to render individual form fields.
+
+**Props**
+
+- `name`: The name of the form field.
+- `as` (optional): The component or HTML tag that should be rendered. Defaults to `"input"`.
+- `children`: A function that returns the field input component. Receives field props as its parameter.
+
+**Example**
+
+```jsx
+<Field name="username">
+  {({ field }) => <input {...field} />}
+</Field>
+```
+
+## Customization
+
+Formex is designed to be flexible. You can create custom field components, use any validation library, or integrate with UI component libraries.
+
+### Using with UI Libraries
+
+```jsx
+import { Field } from 'formex-library';
+import { TextField } from 'some-ui-library';
+
+<Field name="username">
+  {({ field }) => (
+    <TextField {...field} label="Username" />
+  )}
+</Field>
+```
+
+### Custom Validation
+
+Leverage the `validation` function in `useCreateFormex` to integrate any validation logic or library.
+
+```jsx
+const validate = values => {
+  const errors = {};
+  if (!values.email.includes('@')) {
+    errors.email = 'Invalid email';
+  }
+  return errors;
+};
+```
+
+## Conclusion
+
+Formex provides a simple yet powerful way to manage forms in React applications. It reduces the amount of boilerplate code needed and offers flexibility to work with custom components and validation strategies. Whether you are building simple or complex forms, Formex can help streamline your form management process.
+
+For further examples and advanced usage, refer to the Formex documentation or source code.

package/dist/Field.d.ts

@@ -0,0 +1,52 @@
+import * as React from "react";
+import { FormexController } from "./types";
+export interface FieldInputProps<Value> {
+    /** Value of the field */
+    value: Value;
+    /** Name of the field */
+    name: string;
+    /** Multiple select? */
+    multiple?: boolean;
+    /** Is the field checked? */
+    checked?: boolean;
+    /** Change event handler */
+    onChange: (event: React.SyntheticEvent) => void;
+    /** Blur event handler */
+    onBlur: (event: React.FocusEvent) => void;
+}
+export interface FormexFieldProps<Value = any, FormValues extends object = any> {
+    field: FieldInputProps<Value>;
+    form: FormexController<FormValues>;
+}
+export interface FieldConfig<Value, C extends React.ElementType | undefined = undefined> {
+    /**
+     * Component to render. Can either be a string e.g. 'select', 'input', or 'textarea', or a component.
+     */
+    as?: C | string | React.ForwardRefExoticComponent<any>;
+    /**
+     * Children render function <Field name>{props => ...}</Field>)
+     */
+    children?: ((props: FormexFieldProps<Value>) => React.ReactNode) | React.ReactNode;
+    /**
+     * Validate a single field value independently
+     */
+    /**
+     * Used for 'select' and related input types.
+     */
+    multiple?: boolean;
+    /**
+     * Field name
+     */
+    name: string;
+    /** HTML input type */
+    type?: string;
+    /** Field value */
+    value?: any;
+    /** Inner ref */
+    innerRef?: (instance: any) => void;
+}
+export type FieldProps<T, C extends React.ElementType | undefined> = {
+    as?: C;
+} & (C extends React.ElementType ? (React.ComponentProps<C> & FieldConfig<T, C>) : FieldConfig<T, C>);
+export declare function Field<T, C extends React.ElementType | undefined = undefined>({ validate, name, children, as: is, // `as` is reserved in typescript lol
+className, ...props }: FieldProps<T, C>): any;

package/dist/Formex.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { FormexController } from "./types";
+export declare const useFormex: <T extends object>() => FormexController<T>;
+export declare const Formex: ({ value, children }: {
+    value: FormexController<any>;
+    children: React.ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./Field";
+export * from "./Formex";
+export * from "./types";
+export * from "./utils";
+export * from "./useCreateFormex";