Custom Zod Locales for FormatJS

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

Table of content

• Usage
• Build & Publish
• Information

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, visit the GitHub Actions page of the repository.

You can choose between two workflows:

• Release Package to publish a new version of the package.
• Pre-Release Package to publish a new pre-release version of the package.

Note: Pre-releases need to be supplied with a pre-id.

Note: To increment a pre-release, you have to run the normal release workflow and select "prerelease". For this action you need to already be on a pre-release version.

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

• All Contributors

License

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