---
title: "Field"
description: "Describe an API parameter, its type, default, and required state."
canonical_url: "https://indocio.igrislabs.com/components/field"
---

> Index of every page on this site: [llms.txt](https://indocio.igrislabs.com/llms.txt)

## Usage

`field-group` contains `field` components describing an API. These are documentation fields, separate from `Ui*` form controls.

<field-group>
<field name="name" type="string" :required="true">

The documentation site's public name.

</field>

<field name="width" type="string" default-value="42rem">

The article's maximum width.

</field>
</field-group>

```md
::field-group

:::field{name="name" type="string" required}
The documentation site's public name.
:::

:::field{name="width" type="string" default-value="42rem"}
The article's maximum width.
:::

::
```

`field.name` is required. Optional props are `type`, Boolean `required`, and `default-value`; the default slot holds the description.

See [Field Group](https://indocio.igrislabs.com/components/field-group) for grouping related API fields.

## Sitemap

See the full [sitemap](https://indocio.igrislabs.com/sitemap.md) for all pages.
