npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@vtaits/react-final-form-schema

v2.1.0

Published

Integration of react-final-form and @vtaits/form-schema

Downloads

421

Readme

NPM dependencies status

@vtaits/react-final-form-schema

Integration of react-final-form and @vtaits/form-schema.

Installation

yarn add final-form react-final-form @vtaits/react-final-form-schema

or

npm install final-form react-final-form @vtaits/react-final-form-schema --save

Examples

Usage

import { Form } from '@vtaits/react-final-form-schema';

<Form
  onSubmit={(values, rawValues) => {
    // submit logic
  }}
  getFieldSchema={getFieldSchema}
  getFieldType={getFieldType}
  names={names}
  mapErrors={(rawErrors, values, rawValues) => {
    // map errors berore process with mapFieldErrors
  }}
  {...reactFinalFormProps}
>
  {
    (reactFinalFormRenderProps) => {
      // render logic, e.g.

      return (
        <>
          <FormField name="field1" />
          <FormField name="field2" />

          <hr />

          <FormField name="field3" payload="payload" />
        </>
      );
    }
  }
</Form>

It similar to react-final-form but there is some differences:

  • getFieldSchema, getFieldType, names are required. They are described in @vtaits/form-schema;

  • onSubmit receives serialized values as first argument;

  • mapErrors (not required) can map submission errors of form to format of final-form;

  • initialValuesPlaceholder - new prop, initial runtime values of form during asynchronous initialization.

FormField

A component for rendering field by name according to its schema

Props

  • name - required, string, name of field for render;
  • payload - not required, payload prop of nested field;
  • parents - not required, stack of parent fields for child field.

Type declaration

Type declaration is similar with @vtaits/form-schema but there is new prop:

  • component - react component that will be rendered with FormField. Receives next props:

    • name - string, name of field;

    • fieldSchema - any, result of getFieldSchema by name of field;

    • payload - any, prop of FormField, can be helpful for arrays of repeating fields;

    • getFieldSchema - see @vtaits/form-schema;

    • getFieldType - see @vtaits/form-schema;

    • parents - prop of FormField, stack of parent fields above current field with runtime values.

Built-in field types

Dynamic

The field that depends from other fields. Example:

import { dynamic } from '@vtaits/react-final-form-schema/fields/dynamic';

const schema = {
  type: 'dynamic',

  getSchema: ({
    otherField,
  }, phase) => ({
    type: 'string',
    label: 'String field',
    required: Boolean(otherField),
  }),
};

const getFieldType = (fieldSchema) => {
  if (fieldSchema.type === 'dynamic') {
    return dynamic;
  }

  // ...
}

Parameters:

  • getSchema - required, function, should return schema for render or null. Arguments:

    1. values - object of values of form, depends from 2nd argument;

    2. phase - current phase ('parse', 'serialize', 'render'). If phase is 'parse', 1st argument is initial values before parsing, otherwise it is current values of form.

    3. getFieldSchema - see @vtaits/form-schema;

    4. getFieldType - see @vtaits/form-schema;

    5. parents - stack of parent fields above current field with runtime values;

  • getSchemaAsync - not required, function. Can be used for asynchronous parsing. Similar to getSchema but should return Promise with result schema;

  • onShow - not required, callback that called when field has shown. Arguments:

    1. form - instance of final-form;

    2. name - name of field;

    3. schema - result schema of subfield;

    4. getFieldSchema - current getFieldSchema;

    5. getFieldType - global getFieldType;

    6. parents - stack of parent fields above current field with runtime values;

  • onHide - not required, callback that called when field has hidden. Arguments:

    1. form - instance of final-form;

    2. name - name of field;

    3. getFieldSchema - current getFieldSchema;

    4. getFieldType - global getFieldType;

    5. parents - stack of parent fields above current field with runtime values.

Set

The group of fields. It's comfortable when the dynamic field must render several fields. Example:

import { dynamic } from '@vtaits/react-final-form-schema/fields/dynamic';
import { set } from '@vtaits/react-final-form-schema/fields/set';

const schema = {
  type: 'dynamic',

  getSchema: ({
    responsibleType,
  }) => {
    if (responsibleType !== 'human') {
      return null;
    }

    return {
      type: 'set',
      schemas: {
        firstName: {
          type: 'string',
          label: 'First name',
        },

        lastName: {
          type: 'string',
          label: 'Last name',
        },
      },
    };
  },
};

const getFieldType = (fieldSchema) => {
  if (fieldSchema.type === 'dynamic') {
    return dynamic;
  }

  if (fieldSchema.type === 'set') {
    return set;
  }

  // ...
}

Parameters:

  • schemas - required, object whose keys are field names and values are their schemas;

  • render - not required, render function. . Arguments:

    1. names - fields names (keys of schemas);

Utils

checkValuesReady

import { useFormState } from 'react-final-form';
import { checkValuesReady } from '@vtaits/react-final-form-schema';

// ...

const {
  values,
} = useFormState();

const isValuesReady: boolean = checkValuesReady(values);

If parsing if asynchronous it returns true only after end of parsing;

If parsing if synchronous it always returns true.

useValuesReady

import { useValuesReady } from '@vtaits/react-final-form-schema';

// ...

const isValuesReady: boolean = useValuesReady();

Hook that encapsulates receiving state of form and checking ready state.

useFormSchemaState

Hook that returns state for wrapper above react-final-form. This is object with next values:

  • isValuesReady - boolean, result of useValuesReady.