API ReferenceFieldsBase

Base

The base type shared by all fields.

Params

Param	Example	Type	Status
`label`	`label: "Title"`	String	-
`labelIcon`	`labelIcon: <Icon />`	ReactNode	-
`metadata`	`metadata: {}`	Object	-
`visible`	`visible: false`	Boolean	-

Optional params

`label`

Set the label for the input. Puck will use the key if not provided.


const config = {
  components: {
    Example: {
      fields: {
        items: {
          label: "My Field",
          // ...
        },
      },
      // ...
    },
  },
};

`labelIcon`

Set an icon to display next to the label.


const config = {
  components: {
    Example: {
      fields: {
        items: {
          labelIcon: <Icon />,
          // ...
        },
      },
      // ...
    },
  },
};

`metadata`

An object containing additional information for the field.


const config = {
  components: {
    Example: {
      fields: {
        items: {
          metadata: {
            title: "Hello, world",
          },
          // ...
        },
      },
      // ...
    },
  },
};

`visible`

Show or hide the field. Defaults to true.


const config = {
  components: {
    Example: {
      fields: {
        items: {
          visible: false,
          // ...
        },
      },
      // ...
    },
  },
};

Fields

Array