Skip to content

Form Field

Label, description, and error wrapper for form fields.

Usage

vue
<script setup>
import { ArchFormField, ArchInput } from "@archora/ui";
</script>

<template>
  <ArchFormField label="Email" description="Used for alerts" v-slot="field">
    <ArchInput :id="field.id" :aria-describedby="field.describedby" />
  </ArchFormField>
</template>

Live sandbox

Form Field can be tested directly on this page.

interactive

Used for alerts

<FormField />

Props

PropTypeDefaultDescription
idstring-Unique id.
labelstring-Accessible label or text.
descriptionstring-Description.
errorstring-Error text.
requiredbooleanfalseMarks the field as required.
invalidbooleanfalseInvalid state.
describedbystring | undefined-Description/error id for aria-describedby.

Slots

SlotPropsDescription
default{ id: string; describedby?: string; invalid: boolean; required: boolean }Field slot; receives linked accessibility props.