https://github.com/aboutbits/zod-locales-formatjs
https://github.com/aboutbits/zod-locales-formatjs
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aboutbits/zod-locales-formatjs
- Owner: aboutbits
- License: mit
- Created: 2023-02-13T09:06:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-09-11T05:49:15.000Z (5 months ago)
- Last Synced: 2025-10-02T06:53:24.218Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 558 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
Custom Zod Locales for FormatJS
===============================
[](https://badge.fury.io/js/%40aboutbits%2Fzod-locales-formatjs)
This package provides simplified translations for Zod error messages.
It contains translations for German and Italian.
## Table of content
- [Usage](#usage)
- [Build & Publish](#build--publish)
- [Information](#information)
## Usage
First you need to install the package:
```bash
npm install @aboutbits/zod-locales-formatjs
```
Second, add the custom language packages to your `IntlProvider`:
```js
import { de } from '@aboutbits/zod-locales-formatjs'
import { IntlProvider } from 'react-intl'
{children}
```
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.
```js
import { useZodInternationalizationWithReactIntl } from '@aboutbits/zod-locales-formatjs/react-intl'
useZodInternationalizationWithReactIntl()
```
or
```js
import { ZodInternationalizationWithReactIntl } from '@aboutbits/zod-locales-formatjs/react-intl'
```
If you don't use `React`, you can set the `ZodErrorMap` manually with:
```js
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](https://aboutbits.it).
### Support
For support, please contact [info@aboutbits.it](mailto:info@aboutbits.it).
### Credits
- [All Contributors](../../contributors)
### License
The MIT License (MIT). Please see the [license file](LICENSE.md) for more information.