Askr documentation
Generated API snapshot

@askrjs/themes/field

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

Exports

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

Fieldtype

Field: (props: FieldProps) => JSX.Element

Groups a form control with its hint/error text, marking data-invalid when invalid is set.

FieldErrortype

FieldError: (props: FieldErrorProps) => JSX.Element

Renders validation error text for a {@link Field}, exposed with role="alert".

FieldErrorPropstype

FieldErrorProps: ParagraphProps & {
  children?: unknown;
  ref?: Ref<HTMLParagraphElement>;
}

Props for the {@link FieldError } component.

children
children?: unknown;
ref
ref?: Ref<HTMLParagraphElement>;

FieldHinttype

FieldHint: (props: FieldHintProps) => JSX.Element

Renders supporting hint text for a {@link Field}.

FieldHintPropstype

FieldHintProps: ParagraphProps & {
  children?: unknown;
  ref?: Ref<HTMLParagraphElement>;
}

Props for the {@link FieldHint } component.

children
children?: unknown;
ref
ref?: Ref<HTMLParagraphElement>;

FieldPropstype

FieldProps: DivProps & {
  children?: unknown;
  invalid?: boolean;
  ref?: Ref<HTMLDivElement>;
}

Props for the {@link Field } component.

children
children?: unknown;
invalid
invalid?: boolean | undefined;
ref
ref?: Ref<HTMLDivElement>;