antd-zod

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 50 Open GitHub ↗

Antd Zod validation

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Antd Zod validation

The aim of this library is to enable seamless integration of Zod validation with Antd form fields.

## Installation

### Zod 4 and Antd 6

```
npm install antd-zod
```

### Older versions

#### Zod 4 and Antd 5
```
npm install antd-zod@7.0.0
```

#### Zod 3 and Antd 5
```
npm install antd-zod@6.1.0
```
Link to npm package [antd-zod](https://npmjs.com/package/antd-zod).

## Usage

```jsx
import z from 'zod';
import { Form, Button, Input, InputNumber } from 'antd';
import { createSchemaFieldRule } from 'antd-zod';

// Create zod schema - base schema MUST be an object
const CustomFormValidationSchema = z.object({
  fieldString: z.string(),
  fieldNumber: z.number(),
});

// Create universal rule for Form.Item rules prop for EVERY schema field
const rule = createSchemaFieldRule(CustomFormValidationSchema);

// Set rule to Form.Item
const SimpleForm = () => {
    return (
        <Form>
            <Form.Item label="String field" name="fieldString" rules={[rule]}>
                <Input/>
            </Form.Item>
            <Form.Item label="Number field" name="fieldNumber" rules={[rule]}>
                <InputNumber/>
            </Form.Item>
            <Button htmlType="submit">Submit</Button>
        </Form>
    );
};
```

## Examples
All examples are in Storybook stories

- Basic examples - https://github.com/MrBr/antd-zod/blob/main/stories/basic.stories.tsx
- Refined examples - https://github.com/MrBr/antd-zod/blob/main/stories/refined.stories.tsx

To start storybook locally, install depenedencies and run `npm run storybook`.

## Specifications
Antd Form.Item (rc-field-form) has a certain validation lifecycle which works the best with Form.Item rules. In order to respect that behaviour, `antd-zod` provides a way to create a generic rule that will validate all schema properties and refinements on a field level.

- Base schema for Form data must be an object
- Object may have refinements on a root level
- Object may have nested object children
- Object children may have their own refinements

antd-zod

Today's picks

Was this content helpful?

Recent Feedback

antd-zod

Today's picks

Was this content helpful?

Recent Feedback

Download README