ProseFieldGroup

GitHub

Group related fields together for comprehensive API documentation.

Usage

Group fields together in a list.

analytics

boolean

Defaults to false. Enables analytics for your project (coming soon).

blob

boolean

Defaults to false. Enables blob storage to store static assets, such as images, videos and more.

cache

boolean

Defaults to false. Enables cache storage to cache your server route responses or functions using Nitro's cachedEventHandler and cachedFunction.

database

boolean

Defaults to false. Enables SQL database to store your application's data.

::field-group
  ::field{name="analytics" type="boolean"}
    Defaults to `false`. Enables analytics for your project (coming soon).
  ::

  ::field{name="blob" type="boolean"}
    Defaults to `false`. Enables blob storage to store static assets, such as images, videos and more.
  ::

  ::field{name="cache" type="boolean"}
    Defaults to `false`. Enables cache storage to cache your server route responses or functions using Nitro's `cachedEventHandler` and `cachedFunction`.
  ::

  ::field{name="database" type="boolean"}
    Defaults to `false`. Enables SQL database to store your application's data.
  ::
::

API

Props

Prop	Default	Type
`as`	`'div'`	`any` The element or component this component should render as.
`ui`		`{ base?: any; }`

Slots

Slot	Type
`default`	`{}`

Theme

app.config.ts

export default defineAppConfig({
  ui: {
    prose: {
      fieldGroup: {
        base: 'my-5 divide-y divide-default *:not-last:pb-5'
      }
    }
  }
})

vite.config.ts

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import ui from '@nuxt/ui/vite'

export default defineConfig({
  plugins: [
    vue(),
    ui({
      ui: {
        prose: {
          fieldGroup: {
            base: 'my-5 divide-y divide-default *:not-last:pb-5'
          }
        }
      }
    })
  ]
})

Changelog

No recent changes

Field

Document API parameters, props, and configuration options clearly.

Icon

Display icons from popular icon libraries to enhance your content.