Askr documentation

Generated API snapshot

@askrjs/ui/form

Exports from the declarations published in @askrjs/ui. Signatures reflect the published artifact.

Exports

This entrypoint publishes 3 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

`Form`type

Form: { (props: FormProps): JSX.Element; (props: FormAsChildProps): JSX.Element; }

Renders a part of `form`. Supports polymorphic rendering via `asChild`.

`FormAsChildProps`type

FormAsChildProps: Omit<JSX.IntrinsicElements['form'], 'children' | 'ref'> & FormOwnProps & {
  asChild: true;
  children: JSX.Element;
  ref?: import('@askrjs/askr/foundations/utilities').Ref<Element>;
}

`asChild` keeps the form host supplied by the consumer, while retaining the native form attribute contract (method, action, target, encoding, etc.).

asChild: asChild: true;
children: children: JSX.Element;
ref: ref?: Ref<Element>;

`FormProps`type

FormProps: BoxProps<'form', HTMLFormElement> & FormOwnProps

Props for Form.

asChild: asChild?: false | undefined;
children: children?: unknown;
ref: ref?: Ref<HTMLFormElement>;