object Type

The object field is a dynamic field type that can be used to manage repeated data structures, group related data and/or give users the option to choose between a set of templates.

Ultimately there are 3 options to choose from with this type:

• with list set to false, the fields array can be used to wrap some data – this appears in the editor as a nested page of data.
• with list set to true, the fields array can to set some set of fields – this appears in the editor as above, but with the list selector.
• with list set to false, the fields array can be used to wrap some data – this appears as above, but adding more to the list gives you the option to choose betwen templates.

type ObjectField = {
  label: string
  name: string
  type: 'object'
  list?: boolean
  // `fields` OR `templates` may be provided, not both
  fields?: Field[]
  templates?: Template[]
  /** Customize the default "_template" key that gets set
     in a document to identify a block-type.
     Only applicable when list: true **/
  templatesKey?: string
  // See https://tina.io/docs/extending-tina/overview/ for customizing the UI
  ui?: {
     // Whether or not the Visual Selector  is enabled. See https://tina.io/docs/editing/blocks/#adding-a-visual-block-selector-experimental
    visualSelector?: boolean,
    // defaultItem can only can be used when {list: true}
    defaultItem?: Record<string, any> | () => Record<string, any>,
    itemProps?(
      item: Record<string, any>
    ): {
      label?: string
    }
  }
}

Examples

Tina will generate the appropriate component depending on the configuration provided.

A basic object configuration

{
  label: "Testimonial",
  name: "testimonial",
  type: "object",
  fields: [
      {
        label: "Author",
        name: "author",
        type: "string"
      },
      {
        label: "Role",
        name: "role",
        type: "string"
      },
      {
        label: "Quote",
        name: "quote",
        type: "string",
        ui: {
          component: "textarea"
        }
      }
        ]
}

As a list with default values

{
  label: "Testimonials",
  name: "testimonials",
  type: "object",
        list: true,
          ui: {
    itemProps: (item) => {
      return { label: `${item?.author}  ( ${item?.role} ) ` }
    },
      defaultItem: {
      author: "Judith Black",
        role: "CEO",
          quote: "Lorem ipsum dol..."
    }
  },
  fields: [
    {
      name: "author",
      // ...
    },
    {
      name: "role",
      // ...
    },
    {
      name: "quote",
      // ...
    }
  ]
}

Using list object as a wrapper for other types

Number, boolean, datetime and rich-text field types can be used in this way to add list options to the TinaCMS editor.

Reference field types can be used in this way to create a list of references.

{
  label: "Author List",
  name: "authorList",
  type: "object",
  list: true,      
  fields: [
    {
      label: 'Author',
      name: 'author',
      type: 'reference',
      collections: ['author'],
    },
  ]
}

Using templates instead of fields

{
  label: "Page Blocks",
  name: "pageBlocks",
  type: "object",
  list: true,
  templates: [
    {
      label: "CTA",
      name: "cta",
      fields: [...]
    },
    {
      label: "Testimonial",
      name: "testimonial",
      fields: [...]
    }
  ]
}

Last Edited: September 12, 2024