README.md

description
Improves the form development experience thanks to the use of webcomponents to centralize submission

@atomico/magic-form

{% embed url="https://github.com/atomicojs/magic-form" %}

A powerful form submission manager created with Atomicojs webcomponents, with MagicForm you can:

1. Simplify the sending of forms by centralizing the sending actions through a provider.
2. Know at all times the forms that are being provided and show their status.
3. Isolate a group of actions according to provider, this means that if a provider does not register the action it will bubble to the parent provider.

Installation and import

{% tabs %} {% tab title="Instalation" %}

npm install @atomico/magic-form

{% endtab %}

{% tab title="Module webcomponents" %}

import { 
    MagicForm,
    MagicFormProvider 
} from "@atomico/magic-form";

{% endtab %}

{% tab title="Module hooks" %}

import { 
    useMagicForm, 
    useMagicFormProvider 
} from "@atomico/magic-form/hooks";

{% endtab %} {% endtabs %}

Usage

{% tabs %} {% tab title="HTML" %}

<magic-form-provider>
  <magic-form>
    <form action="user">
      <input type="text" name="name" />
      <input type="text" name="email" />
      <button>Create user</button>
    </form>
  </magic-form>
</magic-form-provider>
<script>
  document.querySelector("magic-form-provider").actions = {
    async add(form) {
      return fetch("./my-api", {
        method: "post",
        body: new FormData(form),
      }).then((res) => res.json());
    },
  };
</script>

{% endtab %}

{% tab title="JSX Atomico" %}

import { MagicForm, MagicFormProvider } from "@atomico/magic-form";

function component() {
  return (
    <host>
      <MagicFormProvider 
        actions={{
          async add(form) {
            return fetch("./my-api", {
              method: "post",
              body: new FormData(form),
            }).then((res) => res.json());
          },
        }}
      >
        <MagicForm>
          <form action="user">
            <input type="text" name="name" />
            <input type="text" name="email" />
            <button>Create user</button>
          </form>
        </MagicForm>
      </MagicFormProvider>
    </host>
  );
}

{% endtab %} {% endtabs %}

magic-form-provider captures all the forms nested in magic-form when executing the submit event by the form and distributes them according to the definition of the action attribute to each method of the actions object

API

{% content-ref url="magicformprovider-or-less-than-magic-form-provider-greater-than.md" %} magicformprovider-or-less-than-magic-form-provider-greater-than.md {% endcontent-ref %}

{% content-ref url="magicform-or-less-than-magic-form-greater-than.md" %} magicform-or-less-than-magic-form-greater-than.md {% endcontent-ref %}

{% content-ref url="magicform-hooks.md" %} magicform-hooks.md {% endcontent-ref %}

{% content-ref url="magicform-in-react-and-preact.md" %} magicform-in-react-and-preact.md {% endcontent-ref %}