Fields

Description Field

PayloadCMS text field for descriptions with sensible defaults

Preview

import descriptionField from "~/payload/fields/description/config";

// Usage in PayloadCMS block/collection config
const featureDescription = descriptionField({
  name: "description",
  label: "Feature Description",
  required: true,
});

Props

The descriptionField function accepts the following configuration options:

Prop

Type

Installation

npx shadcn@latest add @uifoundry/description-field

If you encounter issues, check the registry setup guide for configuration help.

Registry Dependencies

This component uses the following registry components:

  • Field Types - TypeScript definitions for PayloadCMS fields

Dependencies

This component requires the following NPM packages:

  • React - JavaScript library for building user interfaces
  • Next.js - React framework for production