Skip to content

doc(forms): add jsdoc for ReadonlyFieldState #69444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JeanMeche wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −1
Open

doc(forms): add jsdoc for ReadonlyFieldState #69444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion goldens/public-api/forms/signals/index.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,6 @@ export interface ReadonlyFieldState<TValue, TKey extends string | number = strin
readonly disabled: Signal<boolean>;
// (undocumented)
readonly disabledReasons: Signal<readonly DisabledReason[]>;
// (undocumented)
readonly errors: Signal<ValidationError.WithFieldTree[]>;
readonly errorSummary: Signal<ValidationError.WithFieldTree[]>;
readonly fieldTree: ReadonlyFieldTree<unknown, TKey>;
Expand Down
4 changes: 4 additions & 0 deletions packages/forms/signals/src/api/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,10 @@ export interface ReadonlyFieldState<TValue, TKey extends string | number = strin
*/
readonly hidden: Signal<boolean>;
readonly disabledReasons: Signal<readonly DisabledReason[]>;

/**
* A signal containing the {@link errors} of the field itself, excluding its descendants.
*/
readonly errors: Signal<ValidationError.WithFieldTree[]>;

/**
Expand Down
Loading