angular/packages/forms/signals/test/node/path.spec.ts
Miles Malerba b8314bd340 feat(forms): add experimental signal-based forms (#63408)
This commit introduces an experimental version of a new signal-based forms API for Angular. This new API aims to explore how signals can be leveraged to create a more declarative, intuitive, and reactive way of handling forms.

The primary goals of this new signal-based approach are:

*   **Signal-centric Design:** Place signals at the core of the forms experience, enabling a truly reactive programming model for form state and logic.
*   **Declarative Logic:** Allow developers to define form behavior, such as validation and conditional fields, declaratively using TypeScript. This moves logic out of the template and into a typed, testable schema.
*   **Developer-Owned Data Model:** The library does not maintain a copy of data in a form model, but instead read and write it via a developer-provided `WritableSignal`, eliminating the need for applications to synchronize their data with the form system.
*   **Interoperability:** A key design goal is seamless interoperability with existing reactive forms, allowing for incremental adoption.
*   **Bridging Template and Reactive Forms:** This exploration hopes to close the gap between template and reactive forms, offering a unified and more powerful approach that combines the best aspects of both.

This initial version of the experimental API includes the core building blocks, such as the `form()` function, `Field` and `FieldState` objects, and a `[control]` directive for binding to UI elements. It also introduces a schema-based system for defining validation, conditional logic, and other form behaviors.

Note: This is an early, experimental API. It is not yet complete and is subject to change based on feedback and further exploration.

Co-authored-by: Kirill Cherkashin <kirts@google.com>
Co-authored-by: Alex Rickabaugh <alxhub@users.noreply.github.com>
Co-authored-by: Leon Senft <leonsenft@users.noreply.github.com>
Co-authored-by: Dylan Hunn <dylhunn@gmail.com>
Co-authored-by: Michael Small <michael-small@users.noreply.github.com>

PR Close #63408
2025-08-28 09:02:43 -07:00

102 lines
2.4 KiB
TypeScript

/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/
import {Injector, signal} from '@angular/core';
import {TestBed} from '@angular/core/testing';
import {
apply,
applyEach,
applyWhen,
customError,
form,
requiredError,
validate,
} from '../../public_api';
describe('path', () => {
describe('Active path', () => {
it('Disallows using parent paths for applyWhen', () => {
const data = signal({first: '', needLastName: false, last: ''});
form(
data,
(path) => {
applyWhen(
path,
({value}) => value().needLastName,
(/* UNUSED */) => {
expect(() => {
validate(path.last, ({value}) =>
value().length > 0 ? undefined : requiredError(),
);
}).toThrowError();
},
);
},
{injector: TestBed.inject(Injector)},
);
});
it('Disallows using parent paths for apply', () => {
const data = signal({first: '', needLastName: false, last: ''});
form(
data,
(path) => {
apply(path, () => {
expect(() => {
validate(path.last, () => {
return customError();
});
}).toThrowError();
});
},
{injector: TestBed.inject(Injector)},
);
});
it('Disallows using the same path', () => {
const data = signal({first: '', needLastName: false, last: ''});
form(
data,
(path) => {
apply(path, () => {
expect(() => {
validate(path, () => {
return customError();
});
}).toThrowError();
});
},
{injector: TestBed.inject(Injector)},
);
});
it('Disallows using parent paths for apply', () => {
const data = signal({
needLastName: false,
items: [{first: '', last: ''}],
});
form(
data,
(path) => {
applyEach(path.items, () => {
expect(() => {
validate(path.needLastName, () => {
return customError();
});
}).toThrowError();
});
},
{injector: TestBed.inject(Injector)},
);
});
});
});