Built-in components

Table of contents

• Basic components
  • Enable all basic components
  • Enable specific basic components
  • Disable all basic components

Basic components

Contentful offers built-in basic components, including Heading, Text, Rich Text, Image, Button, and Divider, which are enabled by default. If needed, you can disable these components using the defineComponents function when registering custom components.

Enable all basic components

All built-in basic components are enabled by default when you call the defineComponents function and do not provide the enabledBuiltInComponents option in the optional second parameter.

import { defineComponents } from '@contentful/experiences-sdk-react';

defineComponents(
  [
    // Register components here...
    // {
    //   component: Example,
    //   definition: exampleDefinition,
    // }
  ]
);

Enable specific basic components

To enable only specific built-in components, pass an array of their IDs to enabledBuiltInComponents.

In the example below, all built-in components except the Image component are enabled:

import { defineComponents, CONTENTFUL_COMPONENTS } from '@contentful/experiences-sdk-react';

defineComponents(
  [
    // Register components here...
    // {
    //   component: Example,
    //   definition: exampleDefinition,
    // }
  ],
  {
    enabledBuiltInComponents: [
      CONTENTFUL_COMPONENTS.button.id,
      CONTENTFUL_COMPONENTS.divider.id,
      CONTENTFUL_COMPONENTS.heading.id,
      CONTENTFUL_COMPONENTS.richText.id,
      CONTENTFUL_COMPONENTS.text.id,
    ],
  }
);

Disable all basic components

To disable all built-in basic components, pass an object with enabledBuiltInComponents set to an empty array as the second parameter to defineComponents.

import { defineComponents } from '@contentful/experiences-sdk-react';

defineComponents(
  [
    // Register components here...
    // {
    //   component: Example,
    //   definition: exampleDefinition,
    // }
  ],
  {
    enabledBuiltInComponents: [],
  }
);