`blockText`

The blockText property is used to define a rich text value.

Rich text is served as JSON data and editable by the admin's rich text component.


import { atom, blockText } from '@iridiumcms/core';

export const sample = atom('sample', {
  myProp: blockText(),
});

Configuration

The blockText field takes an optional configuration object with the following properties:

defaultValuestring
The default value of the field. Defaults to undefined.
displayNamestring
The display name of the field. Defaults to the name of the property.
requiredboolean
Whether the field is required. Defaults to false.
markdownEnabledboolean
Allows editing the field as markdown. Defaults to false.
searchableboolean
Allows searching the field. Defaults to false.
filterableboolean
Allows filtering the field. Defaults to false.
layoutLAYOUT
The layout of the field in the admin. Defaults to LAYOUT.full.