defineSchema
defineSchema<
TSchemaDefinition>(definition):TSchemaDefinition
Defined in: packages/schema/dist/index.d.ts:118
A helper wrapper that adds editor support, such as autocomplete and type checking, for a schema definition.
Type Parameters
Section titled “Type Parameters”TSchemaDefinition
Section titled “TSchemaDefinition”TSchemaDefinition extends SchemaDefinition
Parameters
Section titled “Parameters”definition
Section titled “definition”TSchemaDefinition
Returns
Section titled “Returns”TSchemaDefinition
Example
Section titled “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: [],}