mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
b8314bd340
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
85 lines
2.2 KiB
TypeScript
85 lines
2.2 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 {inject, Injector, runInInjectionContext, signal} from '@angular/core';
|
|
import {TestBed} from '@angular/core/testing';
|
|
import {form, required, schema, validate} from '../../public_api';
|
|
|
|
describe('form', () => {
|
|
describe('injection context', () => {
|
|
it('throws when there is no injection context', () => {
|
|
const model = signal(123);
|
|
expect(() => form(model)).toThrowError();
|
|
});
|
|
|
|
it('is not present in rules', () => {
|
|
const injector = TestBed.inject(Injector);
|
|
|
|
const model = signal(123);
|
|
const f = form(
|
|
model,
|
|
(p) => {
|
|
validate(p, () => {
|
|
expect(() => {
|
|
inject(Injector);
|
|
}).toThrow();
|
|
return undefined;
|
|
});
|
|
},
|
|
{injector},
|
|
);
|
|
|
|
// Make sure the validation runs
|
|
f().valid();
|
|
});
|
|
|
|
it('uses provided provided injection context to run the form', () => {
|
|
const injector = TestBed.inject(Injector);
|
|
|
|
const model = signal(123);
|
|
form(
|
|
model,
|
|
() => {
|
|
expect(inject(Injector)).toBe(injector);
|
|
},
|
|
{injector},
|
|
);
|
|
});
|
|
|
|
it('uses provided provided injection context over the one it is run in', () => {
|
|
const injector = TestBed.inject(Injector);
|
|
const injector2 = Injector.create({providers: [], parent: injector});
|
|
|
|
const model = signal(123);
|
|
|
|
runInInjectionContext(injector2, () => {
|
|
form(
|
|
model,
|
|
() => {
|
|
expect(inject(Injector)).toBe(injector);
|
|
},
|
|
{injector: injector},
|
|
);
|
|
});
|
|
});
|
|
});
|
|
|
|
it('should infer schema type', () => {
|
|
runInInjectionContext(TestBed.inject(Injector), () => {
|
|
const f = form(
|
|
signal<{x: string}>({x: ''}),
|
|
schema((p) => {
|
|
// Note: the primary purpose of this test is to verify that the line below does not have
|
|
// a type error due to `p` being of type `unknown`.
|
|
required(p.x);
|
|
}),
|
|
);
|
|
expect(f.x().valid()).toBe(false);
|
|
});
|
|
});
|
|
});
|