\n\n\n\n\n## Table of Contents\n\n- [Table of Contents](#table-of-contents)\n- [About The Project](#about-the-project)\n - [Built With](#built-with)\n- [Getting Started](#getting-started)\n - [Prerequisites](#prerequisites)\n - [Installation](#installation)\n- [Usage](#usage)\n- [Roadmap](#roadmap)\n- [Contributing](#contributing)\n- [Contact](#contact)\n\n\n\n## About The Project\n\nExports `validator-ajv8` plugin for `react-jsonschema-form`.\n\n### Built With\n\n- [react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form/)\n- [AJV](https://github.com/ajv-validator/ajv/)\n- [TypeScript](https://www.typescriptlang.org/)\n\n\n\n## Getting Started\n\n### Prerequisites\n\n#### React JsonSchema Form Utils\n\n- `@rjsf/utils >= 5.0.0`\n\n```bash\nyarn add @rjsf/core\n```\n\n### Installation\n\n```bash\nyarn add @rjsf/validator-ajv8\n```\n\n\n\n## Usage\n\n```tsx\nimport { RJSFSchema } from 'packages/utils/dist/index';\nimport Form from 'packages/core/dist/index';\nimport validator from '@rjsf/validator-ajv8';\n\nconst schema: RJSFSchema = {\n type: 'string',\n};\n\n;\n```\n\nor, using a more complex example using custom validator with custom formats\n\n```tsx\nimport { RJSFSchema } from '@rjsf/utils';\nimport Form from '@rjsf/core';\nimport { customizeValidator } from '@rjsf/validator-ajv8';\n\nconst customFormats = {\n 'phone-us': /\\(?\\d{3}\\)?[\\s-]?\\d{3}[\\s-]?\\d{4}$/,\n};\n\nconst validator = customizeValidator({\n customFormats,\n});\n\nconst schema: RJSFSchema = {\n type: 'string',\n format: 'phone-us',\n};\n\n;\n```\n\nor, using a more complex example using a custom with additional meta schema\n\n```tsx\nimport { RJSFSchema } from '@rjsf/utils';\nimport Form from '@rjsf/core';\nimport { customizeValidator } from '@rjsf/validator-ajv8';\n\nconst metaSchemaDraft06 = require('ajv/lib/refs/json-schema-draft-06.json');\n\nconst validator = customizeValidator({\n additionalMetaSchemas: [metaSchemaDraft06],\n});\n\nconst schema: RJSFSchema = {\n $schema: 'http://json-schema.org/draft-06/schema#',\n type: 'string',\n};\n\n;\n```\n\nor, using a more complex example using custom validator config override options\n\n```tsx\nimport { RJSFSchema } from '@rjsf/utils';\nimport Form from '@rjsf/core';\nimport { customizeValidator } from '@rjsf/validator-ajv8';\n\nconst validator = customizeValidator({\n ajvOptionsOverrides: {\n $data: true,\n verbose: true,\n },\n});\n\nconst schema: RJSFSchema = {\n type: 'string',\n};\n\n;\n```\n\nor, using a more complex example using `ajv-formats` custom [format options](https://github.com/ajv-validator/ajv-formats).\n\n```tsx\nimport { RJSFSchema } from '@rjsf/utils';\nimport Form from '@rjsf/core';\nimport { customizeValidator } from '@rjsf/validator-ajv8';\n\nconst validator = customizeValidator({\n ajvFormatOptions: {\n keywords: true,\n formats: ['date', 'time'],\n },\n});\n\nconst schema: RJSFSchema = {\n type: 'string',\n};\n\n;\n```\n\nFinally, you can combine both additional meta schemas, custom formats, custom validator config override options and `ajv-formats` custom [format options](https://github.com/ajv-validator/ajv-formats).\n\n```tsx\nimport { RJSFSchema } from '@rjsf/utils';\nimport Form from '@rjsf/core';\nimport { customizeValidator } from '@rjsf/validator-ajv8';\n\nconst metaSchemaDraft06 = require('ajv/lib/refs/json-schema-draft-06.json');\n\nconst customFormats = {\n 'phone-us': /\\(?\\d{3}\\)?[\\s-]?\\d{3}[\\s-]?\\d{4}$/,\n};\n\nconst validator = customizeValidator({\n additionalMetaSchemas: [metaSchemaDraft06],\n customFormats,\n ajvOptionsOverrides: {\n $data: true,\n verbose: true,\n },\n ajvFormatOptions: {\n keywords: true,\n formats: ['date', 'time'],\n },\n});\n\nconst schema: RJSFSchema = {\n $schema: 'http://json-schema.org/draft-06/schema#',\n type: 'string',\n format: 'phone-us',\n};\n\n;\n```\n\n\n\n## Roadmap\n\nSee the [open issues](https://github.com/rjsf-team/react-jsonschema-form/issues) for a list of proposed features (and known issues).\n\n\n\n## Contributing\n\nRead our [contributors' guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing/) to get started.\n\n\n\n## Contact\n\nrjsf team: [https://github.com/orgs/rjsf-team/people](https://github.com/orgs/rjsf-team/people)\n\nGitHub repository: [https://github.com/rjsf-team/react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form)\n\n\n\n\n[build-shield]: https://github.com/rjsf-team/react-jsonschema-form/workflows/CI/badge.svg\n[build-url]: https://github.com/rjsf-team/react-jsonschema-form/actions\n[contributors-shield]: https://img.shields.io/github/contributors/rjsf-team/react-jsonschema-form.svg\n[contributors-url]: https://github.com/rjsf-team/react-jsonschema-form/graphs/contributors\n[license-shield]: https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square\n[license-url]: https://choosealicense.com/licenses/apache-2.0/\n[npm-shield]: https://img.shields.io/npm/v/@rjsf/validator-ajv8/latest.svg?style=flat-square\n[npm-url]: https://www.npmjs.com/package/@rjsf/validator-ajv8\n[npm-dl-shield]: https://img.shields.io/npm/dm/@rjsf/validator-ajv8.svg?style=flat-square\n[npm-dl-url]: https://www.npmjs.com/package/@rjsf/validator-ajv8\n","readmeFilename":"README.md"}