@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.16
ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314CheckboxWidget validating that the schema.title is passed as the label, fixing #3302generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072withConfigConsumer with the ConfigConsumer component instead, fixing #3336ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314CheckboxWidget to get the required state of the checkbox from the schemaRequiresTrueValue() utility function rather than the required prop, fixing #3317CheckboxWidget validating that the schema.title is passed as the label, fixing #3302generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314CheckboxWidget to get the required state of the checkbox from the schemaRequiresTrueValue() utility function rather than the required prop, fixing #3317CheckboxWidget validating that the schema.title is passed as the label, fixing #3302generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314
registry into the SubmitButton inside of the Form as part of this fixArrayField to pass the new totalItems and canAdd props to the ArrayFieldItemTemplate instances, fixing #3315
onAddClick and onAddIndexClick into a new _handleAddClick() function, fixing #3316ValidatorType, CustomValidator and ErrorTransformer to add the new generics, as well as passing uiSchema to the validateFormData() call, partially fixing #3170ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314CheckboxWidget validating that the schema.title is passed as the label, fixing #3302generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314CheckboxWidget validating that the schema.title is passed as the label, fixing #3302generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314CheckboxWidget validating that the schema.title is passed as the label, fixing #3302generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072ButtonTemplates to pass the new required registry prop, filtering it out in the actual implementations before spreading props, fixing - #3314CheckboxWidget to get the required state of the checkbox from the schemaRequiresTrueValue() utility function rather than the required prop, fixing #3317
CheckboxWidget missing label issue #3302CheckboxWidget validating that the schema.title is passed as the label, fixing #3302generateXXX functions for Form, Theme, Templates and Widgets to support using the theme with user-specified type generics, partially fixing #3072SubmitButtonProps and IconButtonProps to add required registry prop, fixing - #3314ArrayFieldTemplateItemType to add the new totalItems and canAdd props, fixing #3315CustomValidator and ErrorTransformer types to take the full set of T, S, F generics in order to accept a new optional uiSchema property, partially fixing #3170ValidatorType to add the F generic to allow the validateFormData() function to take a new optional uiSchema parameter, partially fixing #3170
ValidatorType interface changecustomizeValidator and AJV6Validator implementations to add the S and F generics, so that validateFormData() can accept a new optional uiSchema parameter that is passed to transformErrors() and customValidate(), partially fixing #3170customizeValidator and AJV8Validator implementations to add the F generic, so that validateFormData() can accept a new optional uiSchema parameter that is passed to transformErrors() and customValidate(), partially fixing #3170ArrayFieldItemTemplate, SubmitButtonProps and IconButtonProps as part of the fix for #3314 and #3315form-props.md for children, fixing #3322typescript.md documentation to Advanced Customization describing how to use custom generics as part of the fix for #3072utilty-functions.md to add the new F generic to all the places which needed themReadme
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.