Skip to content

Document object field options #668

Open
@jossmac

Description

@jossmac

Add a section to the object field documentation detailing the options argument:

type ObjectFieldOptions = {
  label: string;
  description?: string;
}

Where usage looks like:

fields.object(
  {
    a: fields.text({ label: 'A' }),
    b: fields.text({ label: 'B' }),
  },
  {
    label: 'Group label',
    description: 'Group description',
  }
)

Relates to #641

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions