@rjsf/validator-ajv6

@rjsf/validator-ajv6

AJV-6 based validator plugin for react-jsonschema-form.
Explore the docs »

View Playground · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• Contact

About The Project

Exports validator-ajv6 plugin for react-jsonschema-form.

Built With

• react-jsonschema-form
• AJV
• TypeScript

Getting Started

Prerequisites

React JsonSchema Form Utils

• @rjsf/utils >= 5.0.0

yarn add @rjsf/core

Installation

yarn add @rjsf/validator-ajv6

Usage

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import validator from '@rjsf/validator-ajv6';

const schema: RJSFSchema = {
  type: 'string',
};

<Form schema={schema} validator={validator} />

or, using a more complex example using custom validator with custom formats

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv6';

const customFormats = {
  'phone-us': /\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$/
};

const validator = customizeValidator({
  customFormats,
});

const schema: RJSFSchema = {
  type: 'string',
  format: 'phone-us'
};

<Form schema={schema} validator={validator} />

or, using a more complex example using a custom with additional meta schema

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv6';

const metaSchemaDraft04 = require("ajv/lib/refs/json-schema-draft-04.json");

const validator = customizeValidator({
  additionalMetaSchemas: [metaSchemaDraft04],
});

const schema: RJSFSchema = {
  "$schema": "http://json-schema.org/draft-04/schema#",
  type: 'string',
};

<Form schema={schema} validator={validator} />

or, using a more complex example using custom validator config override options

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv6';

const validator = customizeValidator({
  ajvOptionsOverrides: {
    $data: true,
    verbose: true,
  }
});

const schema: RJSFSchema = {
  type: 'string',
};

<Form schema={schema} validator={validator} />

Finally, you can combine both additional meta schemas, custom formats and custom validator config override options.

import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv6';

const metaSchemaDraft04 = require("ajv/lib/refs/json-schema-draft-04.json");

const customFormats = {
  'phone-us': /\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$/
};

const validator = customizeValidator({
  additionalMetaSchemas: [metaSchemaDraft04],
  customFormats,
  ajvOptionsOverrides: {
    $data: true,
    verbose: true,
  }
});

const schema: RJSFSchema = {
  "$schema": "http://json-schema.org/draft-04/schema#",
  type: 'string',
  format: 'phone-us'
};

<Form schema={schema} validator={validator} />

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Read our contributors' guide to get started.

Contact

rjsf team: https://github.com/orgs/rjsf-team/people

GitHub repository: https://github.com/rjsf-team/react-jsonschema-form

Changelog

v5.0.0-beta.6

@rjsf/bootstrap-4

• Change custom attribute to bsPrefix by @WillowP, fixing (https://github.com/rjsf-team/react-jsonschema-form/issues/2648)

@rjsf/core

• Added tests for the new @rjsf/validator-ajv8 to the validate_test.js file to ensure the validation works with both validator implementations

@rjsf/mui

• Fixed the README.md to correct the package name in several places to match the actual package

@rjsf/utils

• Fixed the README.md to remove references to ajv6 validator, adding link to the utility-functions.md in the docs
• Fixed the README.md to correct the package name in several places to match the actual package
• Updated getDefaultFormState() so that oneOf and anyOf default values do not always use the first option when formData contains a better option, fixing (https://github.com/rjsf-team/react-jsonschema-form/issues/2183)

@rjsf/validator-ajv6

• Fixed the README.md to correct the package name in several places to match the actual package

@rjsf/validator-ajv8

• Support for localization (L10n) on a customized validator using a Localizer function passed as a second parameter to customizeValidator(), fixing (https://github.com/rjsf-team/react-jsonschema-form/pull/846, and https://github.com/rjsf-team/react-jsonschema-form/issues/1195)
• Fixed the README.md to correct the package name in several places to match the actual package

Dev / docs / playground

• Added two new validator selections, AJV8 and AJV8_es to the list of available validators for the playground; Using the second one will translate error messages to spanish.
• Updated the validation documentation to clarify the case of empty strings being stored as null in certain cases.