Skip to content

Latest commit

 

History

History
81 lines (50 loc) · 2.01 KB

readme.md

File metadata and controls

81 lines (50 loc) · 2.01 KB

Custom Zod Locales for FormatJS

npm version

This package provides simplified translations for Zod error messages. It contains translations for German and Italian.

Table of content

Usage

First you need to install the package:

npm install @aboutbits/zod-locales-formatjs

Second, add the custom language packages to your IntlProvider:

import { de } from '@aboutbits/zod-locales-formatjs'
import { IntlProvider } from 'react-intl'

<IntlProvider messages={{...yourMessages, ...de }} {...}>{children}</IntlProvider>

Finally, configure Zod to use the new translations. The following helpers can be used with React. They require the react-intl package to be installed.

import { useZodInternationalizationWithReactIntl } from '@aboutbits/zod-locales-formatjs/react-intl'

useZodInternationalizationWithReactIntl()

or

import { ZodInternationalizationWithReactIntl } from '@aboutbits/zod-locales-formatjs/react-intl'

<ZodInternationalizationWithReactIntl />

If you don't use React, you can set the ZodErrorMap manually with:

import { setZodErrorMap } from '@aboutbits/zod-locales-formatjs'

setZodErrorMap(intl)

Build & Publish

To build and publish the package, simply commit all changes and push them to master. Then run one of the following commands locally:

npm version patch
npm version minor
npm version major

Information

About Bits is a company based in South Tyrol, Italy. You can find more information about us on our website.

Support

For support, please contact [email protected].

Credits

License

The MIT License (MIT). Please see the license file for more information.