DocsAPI ReferencePluginsfield-contentful

field-contentful

A pre-built external field for selecting Contentful entries.

npm i @reacteditor/field-contentful --save

createFieldContentful

import { createFieldContentful } from "@reacteditor/field-contentful";
 
const config = {
  components: {
    BlogCard: {
      fields: {
        post: createFieldContentful("blogPost", {
          space: process.env.CONTENTFUL_SPACE!,
          accessToken: process.env.CONTENTFUL_TOKEN!,
        }),
      },
      render: ({ post }) => <h2>{post?.fields.title}</h2>,
    },
  },
};

Args

ParamExampleDescription
contentType"blogPost"The Contentful content type ID to query. Required.
options{ space, accessToken }See Options below.

Options

ParamExampleDescription
spaceprocess.env.CONTENTFUL_SPACEContentful space ID. Required unless client is supplied.
accessTokenprocess.env.CONTENTFUL_TOKENContentful Delivery API access token. Required unless client is supplied.
clientclient: createClient({ ... })Pre-built contentful client.
titleField"title"Entry field used as the row title. Defaults to "title".
filterFieldsfilterFields: { ... }Filter UI for the picker.
initialFilters{ category: "news" }Initial filter values.