defineSchema

defineSchema<TSchemaDefinition>(definition): TSchemaDefinition

Defined in: packages/editor/src/editor/define-schema.ts:52

A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.

Type Parameters

• TSchemaDefinition extends SchemaDefinition<BaseDefinition>

Parameters

definition

TSchemaDefinition

Returns

TSchemaDefinition

Example

import { defineSchema } from '@portabletext/editor'

const schemaDefinition = defineSchema({
 decorators: [{name: 'strong'}, {name: 'em'}, {name: 'underline'}],
 annotations: [{name: 'link'}],
 styles: [
   {name: 'normal'},
   {name: 'h1'},
   {name: 'h2'},
   {name: 'h3'},
   {name: 'blockquote'},
 ],
 lists: [],
 inlineObjects: [],
 blockObjects: [],
}