https://github.com/RiskChallenger/translation-validation
Automatic validation messages for Angular forms in any language
https://github.com/RiskChallenger/translation-validation
Last synced: 4 months ago
JSON representation
Automatic validation messages for Angular forms in any language
- Host: GitHub
- URL: https://github.com/RiskChallenger/translation-validation
- Owner: RiskChallenger
- License: mit
- Created: 2021-02-25T18:26:17.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-06-19T09:46:18.000Z (4 months ago)
- Last Synced: 2025-07-03T20:51:48.157Z (4 months ago)
- Language: TypeScript
- Homepage: https://riskchallenger.github.io/translation-validation/
- Size: 4.58 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-angular - translation-validation - Automatic validation messages for Angular forms in any language. (Third Party Components / Form Validation)
- fucking-awesome-angular - translation-validation - Automatic validation messages for Angular forms in any language. (Third Party Components / Form Validation)
README
# Translation validation
> Automatic validation messages for Angular forms in any language
[](https://github.com/RiskChallenger/translation-validation/releases)
[](https://github.com/RiskChallenger/translation-validation/blob/main/LICENSE)
[](https://commitizen.github.io/cz-cli/)
[](https://github.com/RiskChallenger/translation-validation/blob/main/CONTRIBUTING.md)
[](https://github.com/prettier/prettier)
We got tired of having to write code to display validation messages whenever a form control was invalid.
So instead we wrote a library that automatically injects a component displaying the error message.
## Features
✅ Custom error component
✅ Show validation message on change, blur or submit
✅ Translates using [Transloco](https://ngneat.github.io/transloco/)
⚠️ WIP: translates using [ngx-translate](https://github.com/ngx-translate/core)
## Table of Contents
- [Blog posts](#blog-posts)
- [Installation](#installation)
- [Usage](#usage)
- [Versioning](#versioning)
- [FAQ](#faq)
# Blog posts
- [Translation validation for Angular - automatic validation messages translated](https://dev.to/langstra/translation-validation-automatic-validation-messages-translated-17ng)
# Installation
From your project folder, run:
```shell
yarn add ngx-translation-validation
```
or
```shell
npm install --save ngx-translation-validation
```
Also add transloco to your project if you haven't done so yet. [Add transloco to your project](https://ngneat.github.io/transloco/docs/installation)
After this, you will need to register the providers using `provideNgxTv()`
This command will import the `NgxTvModule.forRoot()` in your `AppModule`:
```ts
import { provideNgxTv } from 'ngx-translation-validation';
bootstrapApplication(AppComponent, {
providers: [provideNgxTv(/* Optionally you can provide a config here **/)],
});
```
## Usage
To get started simply import the `NgxTvModule` in the module of the component you want to have validation messages.
```ts
import { NgxTvModule } from 'ngx-translation-validation';
@NgModule({
declarations: [UserComponent],
imports: [NgxTvModule],
bootstrap: [UserComponent],
})
export class UserModule {}
```
And then every [formControlName] or [formControl] element will automatically show validation messages when it is invalid.
```angular2html
Name
```
### Internationalization
To show the validation in the current language of the application we use [Transloco](https://ngneat.github.io/transloco/) by default. It translates a key to a string in the current language of the app. The keys for the validation generates by this packages have the following form:
```ts
type.scope.controlName.error;
```
- `type` - Name of the validation messages type. Useful for specifying a directory for the validation messages (default: validation)
- `scope` - Group several validation messages to a specific form/group (default: general)
- `controlName` - Name of the control on which the validation error occurs
- `error` - The name of the validation error that occurs
> [!NOTE]
> If the parent of the control is a FormArray, the control name will be set to the name of the parent of the FormArray.
More on resolving control names
```js
formBuilder.group({
name: ['', Validators.required], // When the control is in a group, use the key of the group, controlName -> name
company: formBuilder.group({
address: ['', Validators.required], // Nesting of groups is ignored, only direct parent is considered, controlName -> address
}),
cars: formBuilder.array([
formBuilder.group({
model: ['', Validators.required], // Group nested in array, only direct parent is considered, controlName -> model
}),
]),
colorPreferences: formBuilder.array([
['', Validators.required], // Control nested in array, controlName is name of array, controlName -> colorPreferences
]),
});
```
If the name of a control cannot be found, a `ControlNameNotFoundError` will be thrown, **no validation error will be shown!**
Examples
```ts
validation.general.name.required;
validation.general.email.email;
validation.organizationForm.name.required;
```
### Configuration
To customize the behavior of the plugin you can pass an object to the `forRoot()` method.
```ts
import { provideNgxTv } from 'ngx-translation-validation';
bootstrapApplication(AppComponent, {
providers: [
provideNgxTv({
type: 'validation', // default 'validation'
defaultScope: 'general', // default 'general'
invalidClass: 'invalid-input', // default undefined
submittedClass: 'form-submitted', // default 'ng-submitted'
errorsComponent: SomeErrorContainerComponent, // default NgxTvContainerComponent
}),
],
});
```
- `invalidClass` - Class that is added to a formControl element when the control is invalid. Can be used for custom styling when you do not want to use `ng-invalid` (default: undefined)
- `submittedClass` - Class that is added to the formGroup element when it is submitted. Can be used in combination with ng-invalid to style elements when invalid and the form is submitted (default: 'ng-submitted')
- `errorsComponent` - Component in which the error message is rendered. If you want to use a custom component, please sure to extend the default (default: `NgxTvContainerComponent`)
#### Configure scope
To specify to what scope validation messages belong you can use the `ngxTvScope` directive.
### Styling
By default, the ngx-tv-container-component gets injected right after the formControl element. So you html would look something like this:
```html
```
But if you'd like the container to appear in a parent of the controlForm you could specify the location of the container with the `ngxTvContainer` directive.
```angular2html
Name
Submit
// container component will be rendered here
```
## Contribute
We welcome you to contribute. This can be done by reporting issues or feature requests. Even better is to not only report issues or feature requests, but then also to pick those issues up yourself.
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on the process for submitting pull requests to us.
## Versioning
| Library version | Angular version |
| :-------------: | :-------------: |
| 14.x | >16 |
| 13.x | >=13 <16 |
| 1.x | 12.x |