Skip to content

Field

Describe an API parameter, its type, default, and required state.

On this page

Usage

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

namestringrequired

The documentation site's public name.

widthstringDefault: 42rem

The article's maximum width.

md
export default defineAppConfig({
  indocio: {
    docs: {
      content: { width: '42rem' },
      sidebar: { enabled: true, width: 240, collapsible: false },
      toc: { enabled: true, position: 'content', depth: 3 },
      breadcrumbs: true,
      footer: true,
      navigation: true,
      search: true,
      actions: { copyLink: true },
    },
    spaces: { switcher: 'dropdown' },
  },
})

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

See Field Group for grouping related API fields.

Indocio · Built with Nuxt Content, IPEX, and Akaza UI.