Skip to content

chore: expose fieldset metadata #781

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: expose fieldset metadata #781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ba230e
chore: expose fieldset metadata
lifeiscontent Sep 20, 2024
94f905f
Merge branch 'main' into chore/expose-fieldset-metadata
lifeiscontent Sep 24, 2024
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
19 changes: 12 additions & 7 deletions packages/conform-react/context.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,17 @@ export type Metadata<
dirty: boolean;
};

export type FieldsetMetadata<
Schema extends Record<string, unknown> = Record<string, unknown>,
FormError = string[],
> = Required<{
[Key in keyof Combine<Schema>]: FieldMetadata<
Combine<Schema>[Key],
Schema,
FormError
>;
}>;

Comment on lines +63 to +73
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should reuse this for the return type of getFieldset() on SubfieldMetadata well. Meaning Schema and FormSchema could be different. Maybe something like this?

export type FieldsetMetadata<
	Schema extends Record<string, unknown> = Record<string, unknown>,
	FormSchema extends Record<string, any> = Schema,
	FormError = string[],
> = Required<{
	[Key in keyof Combine<Schema>]: FieldMetadata<
		Combine<Schema>[Key],
		FormSchema,
		FormError
	>;
}>;

export type FormMetadata<
Schema extends Record<string, unknown> = Record<string, unknown>,
FormError = string[],
Expand All @@ -68,13 +79,7 @@ export type FormMetadata<
id: FormId<Schema, FormError>;
context: Wrapped<FormContext<Schema, FormError>>;
status?: 'success' | 'error';
getFieldset: () => Required<{
[Key in keyof Combine<Schema>]: FieldMetadata<
Combine<Schema>[Key],
Schema,
FormError
>;
}>;
getFieldset: () => FieldsetMetadata<Schema, FormError>;
onSubmit: (event: React.FormEvent<HTMLFormElement>) => void;
noValidate: boolean;
};
Expand Down
1 change: 1 addition & 0 deletions packages/conform-react/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export {
} from '@conform-to/dom';
export {
type FieldMetadata,
type FieldsetMetadata,
type FormMetadata,
FormProvider,
FormStateInput,
Expand Down
Loading