markdown/docs/1.简单文档/5.components/field.md

title, icon, badges

title	icon	badges
Field	lucide:settings-2	value to target Nuxt UI Pro https://ui.nuxt.com/pro/prose/field _blank value icon to target Source lucide:code https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/components/content/Field.vue _blank

Usage

::stack ::div{class="p-4"} ::field{name="Field" type="string" defaultValue="'default'" required} The description can be set as prop or in the default slot with full markdown support. :: ::

::field{name="Field" type="string" defaultValue="'default'" required}
The _description_ can be set as prop or in the default slot with full **markdown** support.
::

::

The text required is configurable in main.fieldRequiredText.

Props

::field-group :field{name="name" type="string"}[Field name] :field{name="type" type="string"}[Field type] :field{name="description" type="string"}[Field description] :field{name="defaultValue" type="string"}[Field default value] :field{name="required" type="boolean"}[Whether the field is required] ::