@rjsf/validator-ajv8
Advanced tools
Package description
@rjsf/validator-ajv8 is a validation package for React JSON Schema Form (RJSF) that uses AJV version 8 for JSON schema validation. It allows you to validate form data against a JSON schema, ensuring that the data conforms to the specified structure and constraints.
Schema Validation
This feature allows you to validate data against a JSON schema. The code sample demonstrates how to compile a schema and validate data using AJV.
const Ajv = require('ajv');
const ajv = new Ajv();
const schema = {
type: 'object',
properties: {
name: { type: 'string' },
age: { type: 'integer' }
},
required: ['name', 'age']
};
const validate = ajv.compile(schema);
const data = { name: 'John', age: 30 };
const valid = validate(data);
if (!valid) console.log(validate.errors);Custom Keywords
This feature allows you to add custom validation keywords to your schema. The code sample shows how to add a custom keyword 'isPositive' and use it in a schema.
const Ajv = require('ajv');
const ajv = new Ajv();
ajv.addKeyword('isPositive', {
type: 'number',
validate: (schema, data) => data > 0
});
const schema = {
type: 'object',
properties: {
positiveNumber: { type: 'number', isPositive: true }
}
};
const validate = ajv.compile(schema);
const data = { positiveNumber: 10 };
const valid = validate(data);
if (!valid) console.log(validate.errors);Error Messages
This feature provides detailed error messages when validation fails. The code sample demonstrates how to enable all error messages and validate data that does not meet the schema requirements.
const Ajv = require('ajv');
const ajv = new Ajv({ allErrors: true });
const schema = {
type: 'object',
properties: {
name: { type: 'string' },
age: { type: 'integer', minimum: 18 }
},
required: ['name', 'age']
};
const validate = ajv.compile(schema);
const data = { name: 'John', age: 16 };
const valid = validate(data);
if (!valid) console.log(validate.errors);AJV (Another JSON Schema Validator) is a popular JSON schema validator used for validating data against JSON schemas. It is highly performant and supports JSON Schema draft-07 and later. Compared to @rjsf/validator-ajv8, AJV is a more general-purpose validator and can be used outside of the React JSON Schema Form context.
The jsonschema package is a simple and lightweight JSON schema validator for JavaScript. It supports JSON Schema draft-04 and is easy to use for basic validation needs. While it is not as feature-rich as AJV, it provides a straightforward way to validate JSON data. Compared to @rjsf/validator-ajv8, jsonschema is less powerful but may be sufficient for simpler use cases.
is-my-json-valid is a fast JSON schema validator that supports JSON Schema draft-04. It is designed for performance and can be used in both Node.js and browser environments. Compared to @rjsf/validator-ajv8, is-my-json-valid is focused on speed and may lack some of the advanced features provided by AJV.
Changelog
5.0.0-beta.17
SelectWidget by the label that the user sees rather than by the valuestyle prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
SchemaField to handle the new style prop in the uiSchema similarly to classNames, passing it to the FieldTemplate and removing it from being passed down to children.
style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapperCheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
style prop on FieldTemplate rendering them on the outermost wrapper, partially fixing #1200CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
SelectWidget to support additional TextFieldProps in a manner similar to how BaseInputTemplate doesstyle prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
SelectWidget to support additional TextFieldProps in a manner similar to how BaseInputTemplate doesstyle prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
style prop on FieldTemplate and WrapIfAdditionalTemplate rendering them on the outermost wrapper, partially fixing #1200CheckboxesWidget to treat the value as an array when selecting/deselecting values and when determining the checked state - fixing #2141aria-describedby value built using the ariaDescribedByIds() function, partially fixing #959
FieldTemplateProps, WrapIfAdditionalTemplateProps and UIOptionsBaseType types to add style?: StyleHTMLAttributes<any>, partially fixing #1200enumOptionsDeselectValue() and enumOptionsSelectValue() as a loose refactor of the duplicated functions in the various CheckboxesWidget implementationsFieldTemplateProps, WrapIfAdditionalTemplateProps and UIOptionsBaseType types to add style?: StyleHTMLAttributes<any>, partially fixing #1200ariaDescribedByIds(), descriptionId(), errorId(), examplesId(), helpId() optionId() and titleId() id generator functionsAJV8Validator#transformRJSFValidationErrors to return more human-readable error messages. The ajv8 ErrorObject message is enhanced by replacing the error message field with either the uiSchema's ui:title field if one exists or the parentSchema title if one exists. Fixes #3246preserveSymlinks to true, which provides an alternative fix for #3228 since the prior fix caused #3215.custom-templates.md and uiSchema.md to document the new style propvalidation.md documentation to describe the new uiSchema parameter passed to the customValidate() and transformError() functionsutility-functions documentation to add the new enumOptionsDeselectValue() and enumOptionsSelectValue() functions and to describe the new id generator functions5.x migration guide documentation to describe potential breaking id changesReadme
AJV-8 based validator plugin for react-jsonschema-form.
Explore the docs »
View Playground
·
Report Bug
·
Request Feature
Exports validator-ajv8 plugin for react-jsonschema-form.
@rjsf/utils >= 5.0.0yarn add @rjsf/core
yarn add @rjsf/validator-ajv8
import {RJSFSchema} from "packages/utils/dist/index";
import Form from 'packages/core/dist/index';
import validator from '@rjsf/validator-ajv8';
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-ajv8';
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-ajv8';
const metaSchemaDraft06 = require("ajv/lib/refs/json-schema-draft-06.json");
const validator = customizeValidator({
additionalMetaSchemas: [metaSchemaDraft06],
});
const schema: RJSFSchema = {
"$schema": "http://json-schema.org/draft-06/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-ajv8';
const validator = customizeValidator({
ajvOptionsOverrides: {
$data: true,
verbose: true,
}
});
const schema: RJSFSchema = {
type: 'string',
};
<Form schema={schema} validator={validator} />
or, using a more complex example using ajv-formats custom format options.
import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv8';
const validator = customizeValidator({
ajvFormatOptions: {
keywords: true,
formats: ["date", "time"]
}
});
const schema: RJSFSchema = {
type: 'string',
};
<Form schema={schema} validator={validator} />
Finally, you can combine both additional meta schemas, custom formats, custom validator config override options and ajv-formats custom format options.
import { RJSFSchema } from "@rjsf/utils";
import Form from '@rjsf/core';
import { customizeValidator } from '@rjsf/validator-ajv8';
const metaSchemaDraft06 = require("ajv/lib/refs/json-schema-draft-06.json");
const customFormats = {
'phone-us': /\(?\d{3}\)?[\s-]?\d{3}[\s-]?\d{4}$/
};
const validator = customizeValidator({
additionalMetaSchemas: [metaSchemaDraft06],
customFormats,
ajvOptionsOverrides: {
$data: true,
verbose: true,
},
ajvFormatOptions: {
keywords: true,
formats: ["date", "time"]
}
});
const schema: RJSFSchema = {
"$schema": "http://json-schema.org/draft-06/schema#",
type: 'string',
format: 'phone-us'
};
<Form schema={schema} validator={validator} />
See the open issues for a list of proposed features (and known issues).
Read our contributors' guide to get started.
rjsf team: https://github.com/orgs/rjsf-team/people
GitHub repository: https://github.com/rjsf-team/react-jsonschema-form
FAQs
Unknown package
We found that @rjsf/validator-ajv8 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
![Massive Automated Spam Campaign Abuses GitHub to Flood npm Registry with Thousands of Garbage Tea[.]xyz Packages](https://cdn.sanity.io/images/cgdhsj6q/production/a74d1072ff2bb5cb96a404be58a649931ced2ba5-1024x1024.webp?w=400&fit=max&auto=format)
Security News
In a reprisal of their previous Tea[.]xyz spam campaign, a new wave of thousands of garbage packages are hitting npm, to artificially inflate the number of dependents for spammers' projects.
Security News
The maintainer of the node-ip project restored the GitHub repo after disputing an exaggerated CVE rating, highlighting the impact of bogus CVEs on open source projects.
Security News
pnpm 9.5 introduces a Catalogs feature, enabling shareable dependency version specifiers, reducing merge conflicts and improving support for monorepos.