ngx-form-stepper 0.0.10 → 0.0.11

package/README.md

@@ -156,6 +156,34 @@ export type ValidatorsNames =
   | 'maxDate';
 ```
 
+## Reusing typed validators
+
+**ngx-form-stepper** allows you to factor them while keeping strict typing based on the `Input` type.
+
+```typescript
+const reqVal: Validator<'required'> = required('Le champ est requis');
+```
+
+Then you can create groups of `validators` compatible only with a given `Input` type :
+
+```typescript
+const emailValidators: ValidatorTuple<ValidatorsNamesOfType<InputType.Email>> = [
+  reqVal,
+  email("L'email n'est pas valide"),
+];
+```
+
+What is impossible (and intentional)
+
+```typescript
+// ❌ Compilation error
+const badValidators: ValidatorTuple<ValidatorsNamesOfType<InputType.Number>> = [
+  email('Invalid email'),
+];
+```
+
+This error is detected at compile time, even before running the application.
+
 ## Select
 
 Tuple of one or more `SelectItem`.
@@ -209,6 +237,16 @@ export type StepConfig = Readonly<{
 }>;
 ```
 
+Duplication of `returnKey` is forbidden (and intentional)
+
+```typescript
+// ❌ Compilation error
+new Step([
+  new Input(InputType.Text, null, 'name', 'First name'),
+  new Input(InputType.Text, null, 'name', 'Last name'),
+]);
+```
+
 ## FormStepper
 
 Impossible to duplicate an `Input` return key between two `Steps`.
@@ -288,7 +326,10 @@ classNames: SingleStepClassNames = {
   },
 };
 
-form = new FormStepper([this.step], { buttonText: 'Submit', classNames: this.classNames });
+form = new FormStepper([this.step], {
+  buttonText: 'Submit',
+  classNames: this.classNames,
+});
 ```
 
 ```css
@@ -384,3 +425,10 @@ export type MultiStepClassNames = DeepPartial<{
   };
 }>;
 ```
+
+## In summary
+
+- Common errors are impossible
+- Types guide the implementation
+- The final form is always consistent
+- The compiler becomes an ally

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-form-stepper",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/rayaneriahi/ngx-form-stepper.git"