Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/jannikbuschke/formik-antd

Simple declarative bindings for Ant Design and Formik.
https://github.com/jannikbuschke/formik-antd
ant-design antd declarative formik forms react
Last synced: about 2 months ago
JSON representation
Simple declarative bindings for Ant Design and Formik.
Host: GitHub
URL: https://github.com/jannikbuschke/formik-antd
Owner: jannikbuschke
License: mit
Created: 2019-01-02T22:25:07.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-10-28T10:50:43.000Z (11 months ago)
Last Synced: 2024-05-22T05:42:28.957Z (4 months ago)
Topics: ant-design, antd, declarative, formik, forms, react
Language: TypeScript
Homepage: https://codesandbox.io/s/github/jannikbuschke/formik-antd-example
Size: 1.39 MB
Stars: 582
Watchers: 8
Forks: 79
Open Issues: 46
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

awesome-ant-design - formik-antd - Declarative bindings for the popular form state management library Formik. (Tools)
README

        [![Build Status](https://dev.azure.com/jannikb/glue/_apis/build/status/jannikbuschke.formik-antd?branchName=master)](https://dev.azure.com/jannikb/glue/_build/latest?definitionId=40&branchName=master)

![GitHub stars](https://img.shields.io/github/stars/jannikbuschke/formik-antd)

![npm](https://img.shields.io/npm/dw/formik-antd)

[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors)

[![license](https://badgen.now.sh/badge/license/MIT)](./LICENSE)

Install for ant design 5 (beta)

```

npm i formik-antd@beta

```

Install for ant design 4

```

npm i formik-antd

```

- [formik-antd v2 CodeSandbox (Ant Design 4)](https://codesandbox.io/s/github/jannikbuschke/formik-antd-example)

# formik-antd

Simple declarative bindings for [Ant Design](https://ant.design/docs/react/introduce) and [Formik](https://github.com/jaredpalmer/Formik).

## Core Concept

This library enriches several Ant Design components with a required `name: string` prop that connects them to a Formik form field. It is quite simple. Instead of importing your form components from antd, you need to import them from 'formik-antd' and set their `name` prop. Now the component is connected/synced with the corresponding `Formik` field!

The Ant Design components are feature rich and provide a lot of props to customize their visual presentation. These features and also their apis stay exactly the same. Visit their documentation to learn more.

### Example:

```jsx

import React from 'react'

import { Form, Input, InputNumber, Checkbox } from 'formik-antd'

import { Formik } from 'formik'

function App() {

  return (

     (

        

          {/* every formik-antd component must have the 'name' prop set: */}

          

          {/* the rest of the api stays as is */}

          

          Newsletter

        

      )}

    />

  )

}

```

## Getting started

```

npm install formik-antd

```

Add `import "antd/dist/antd.css"` to your `index.js` file or check the [Advanced setup](https://github.com/jannikbuschke/formik-antd#advanced-setup) section

## Core Components

|                    | Name 
| ------------------ | ---------------------- 
| :white_check_mark: | AutoComplete 
| :white_check_mark: | Cascader 
| :white_check_mark: | Checkbox 
| :white_check_mark: | Checkbox.Group 
| :white_check_mark: | DatePicker 
| :white_check_mark: | DatePicker.WeekPicker 
| :white_check_mark: | DatePicker.RangePicker 
| :white_check_mark: | DatePicker.MonthPicker 
| :white_check_mark: | Input 
| :white_check_mark: | InputNumber 
| :white_check_mark: | Input.Password 
| :white_check_mark: | Input.TextArea 
| :white_check_mark: | Mentions 
| :white_check_mark: | Radio.Group 
| :white_check_mark: | Rate 
| :white_check_mark: | Select 
| :white_check_mark: | Slider 
| :white_check_mark: | Switch 
| :white_check_mark: | Table 
| :white_check_mark: | TimePicker 
|  | 
| :white_check_mark: | Transfer 
| :white_check_mark: | TreeSelect

| Props                                                                                                                   | | ----------------------------------------------------------------------------------------------------------------------- | | { name, validate?, fast? } & [AutoCompleteProps](https://ant.design/components/auto-complete/)                          | | { name, validate?, fast? } & [CascaderProps](https://ant.design/components/cascader/)                                   | | { name, validate?, fast? } & [CheckboxProps](https://ant.design/components/checkbox/)                                   | | { name, validate?, fast? } & [CheckboxGroupProps](https://ant.design/components/checkbox/#Checkbox-Group)               | | { name, validate?, fast? } & [DatePickerProps](https://ant.design/components/date-picker/)                              | | { name, validate?, fast? } & [WeekPickerProps](https://ant.design/components/date-picker/#WeekPicker)                   | | { name, validate?, fast? } & [RangePickerProps](https://ant.design/components/date-picker/#RangePicker)                 | | { name, validate?, fast? } & [MonthPickerProps](https://ant.design/components/date-picker/#MonthPicker)                 | | { name, validate?, fast? } & [InputProps](https://ant.design/components/input/)                                         | | { name, validate?, fast? } & [InputNumberProps](https://ant.design/components/input-number/)                            | | { name, validate?, fast? } & [InputPasswordProps](https://ant.design/components/input/)                                 | | { name, validate?, fast? } & [Input.TextAreaProps](https://ant.design/components/input/#components-input-demo-textarea) | | { name, validate?, fast? } & [MentionsProps](https://ant.design/components/mentions/)                                   | | { name, validate?, fast? } & [RadioGroupProps](https://ant.design/components/radio/#RadioGroup)                         | | { name, validate?, fast? } & [RateProps](https://ant.design/components/rate/)                                           | | { name, validate?, fast? } & [SelectProps](https://ant.design/components/select/)                                       | | { name, validate?, fast? } & [SliderProps](https://ant.design/components/slider/)                                       | | { name, validate?, fast? } & [SwitchProps](https://ant.design/components/switch/)                                       | | { name, fast? } & [TableProps](https://ant.design/components/table/)                                                    | | { name, validate?, fast? } & [TimePickerProps](https://ant.design/components/time-picker/#API)                          | | { name, validate?, fast? } & [TransferProps](https://ant.design/components/transfer/)                                   | | { name, validate?, fast? } & [TreeSelectProps](https://ant.design/components/tree-select/)                              |

## Submitting and Resetting Forms

Directly under each `` container a `` component _should_ be placed. This component composes the functionality provided by Ant Designs (https://ant.design/components/form/) as well as Formiks (https://jaredpalmer.com/formik/docs/api/form) `` components:

```jsx

import React from 'react'

import { Form, SubmitButton, ResetButton /* ... */ } from 'formik-antd'

import { Formik } from 'formik'

function App() {

  return (

    

      

        {/* ... */}

        

        

      

    

  )

}

```

The `SubmitButton` and `ResetButton` will disable automatically depending on form state. The `ResetButton` is enabled if the form is dirty. The `SubmitButton` is enabled if the form is valid or if it is not dirty and the submit count is zero.

If you do want to control the disable behavior yourself you can provide the `disable: boolean` prop.

I.e. `` will make the button always be enabled.

## Form- and Field-level Validation

Formik provides form- and field-level [validation callbacks](https://jaredpalmer.com/formik/docs/guides/validation) to provide validation logic. How to validate is neither part of formik nor of this library.

Form-level validation is done by setting formiks `validate` prop. Field-level validation is optional available on the components. Additional to the `name` prop formiks optional `validate?: (value: any) => undefined | string | Promise` is added to all core components to allow field-level validation.

There is one special case to be aware of when using field-level validation: When using the `Form.Item` component with another Antd field component, the `validate` prop has to be added to the `Form.Item`, not the input component:

```jsx

  

```

## Rendering Validation Feedback

Showing validation messages can be accomplished with the `Form.Item` component (or `FormItem` which is the same). It

- renders _error_ messages if the field has been touched and the corresponding field has a validation error (and changes the border color of enclosed input component to red).

- renders a green _success_ icon messages if it's `showValidateSuccess: boolean` prop is set to true, the field has been touched and the corresponding field does not have a validation error.

- exposes some layout features and a label (visit https://ant.design/components/form/ for the details).

```jsx

  

```

## FastField support

Formik allows performance optimizations through the [``](https://jaredpalmer.com/formik/docs/api/fastfield) component. Please read the formik docs on when to use such an optimization (usually you don't and maybe should not optimize, unless you encounter performance issues in production).

To opt-in to FastField support, all `formik-antd` components provide an optional `fast?: boolean` prop. Setting this to `true` enables the optimization:

```jsx

```

## Table

The table components comes with additional helper buttons to add and delete rows. An example can be seen in the [codesandbox](https://codesandbox.io/s/github/jannikbuschke/formik-antd-example).

## Lists and Nested objects

Nested objects and arrays can be accessed with lodash-like bracket syntax as described in the [Formik documentation](https://jaredpalmer.com/Formik/docs/guides/arrays).

```jsx

```

## Advanced setup

> You can checkout [this](https://github.com/jannikbuschke/cra-antd-x) github template project get the following setup (and more).

If you do not want to import the full ant design library and its stylesheet (in order to reduce the bundle size) you can import specific components and their stylesheet by their path, as it is described in the antd documentation https://ant.design/docs/react/getting-started#Import-on-Demand

```jsx

import Input from 'formik-antd/es/input'

import 'formik-antd/es/input/style'

```

Some build tools like webpack are now able to "tree shake", meaning unused code from ant design will not be bundled.

As writing imports like this is a little cumbersome there is a babel import helper: https://github.com/ant-design/babel-plugin-import. In `create-react-app` projects babel plugins do not work out of the box. With third party projects like `customize-cra` and `react-app-rewired` we are able to change the webpack config. Be warned though, the team behind `create-react-app` does not support this scenario, so if you run into problems you are on your own.

```

npm install babel-plugin-import customize-cra react-app-rewired --save-dev

```

`config-overrides.js`

```js

const path = require('path')

const { override, fixBabelImports } = require('customize-cra')

module.exports = override(

  fixBabelImports('antd', {

    libraryName: 'antd',

    libraryDirectory: 'es',

    style: 'css',

  }),

  fixBabelImports('formik-antd', {

    libraryName: 'formik-antd',

    libraryDirectory: 'es',

    style: 'css',

  }),

)

```

`package.json`

```json

  "scripts": {

    "start": "react-app-rewired start",

    "build": "react-app-rewired build",

    "test": "react-app-rewired test"

  }

```

## Playground & Contributions

If you want to dig into the source code and test locally you can use https://github.com/jannikbuschke/Formik-antd-playground (clone with the --recursive flag and follow the README, its pretty simple).

## TypeScript

Types are included.

### Typechecking limitations

Form values currently cannot be typechecked (at least to my knowledge). For example the following ideally would give a compile error:

```jsx

 initialValues={{name:""}}>

  

```

Typescript cannot (yet) enforce types of children. In the future this hopefully will be possible.

## Related projects

- [cra-antd-x](https://github.com/jannikbuschke/cra-antd-x) a template project with react-app-rewired (babel imports, fast-refresh, themeable), typescript and react-router.

## License

MIT

## Contributors

Special thanks to all contributors:

  

    

      
_{Nile Daley}
💻

      
_{James W Mann}
💻

      
_{Jannik Buschke}
💻

      
_{Lars-Jørgen Kristiansen}
💻

      
_Adam
💻

      
_jeessy2
💻

      
_{Pavan Agrawal}
📖

    

    

      
_Khartir
💻

      
_{Yury Kozhenov}
💻

      
_{Tonye Jack}
💻

      
_{Edon Gashi}
🚇

      
_{Roman Tsegelskyi}
💻

      
_{Daniel Schulz}
💻

      
_{Harry Green}
📖

    

    

      
_{Daniel Huth}
💻

      
_{Gabriel Berlanda}
💻 📖

      
_{Alexandre Giard}
🤔

      
_kissthom
🐛

      
_{Chris Higgins}
💻

      
_{Felipe Lima}
💻

      
_{Frédéric Barthelet}
💻

    

    

      
_Vincent
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!