Rich text

Rich text can contain text marks like bold, italics or underline. Content can be structured using headings. It can even contain other types as blocks that can be moved around freely.

richText('My rich text field', {
  blocks: schema({
    CodeBlock: CodeBlockSchema,
    ImageBlock: ImageBlockSchema
  })
})

Types

/**

Optional settings to configure a rich text field */

export type RichTextOptions<T, Q>

{

/**

Allow these blocks to be created between text fragments */

blocks: SchemaConfig<T>

/**

Add instructional text to a field */

help: Label

/**

A default value */

initialValue: string

/**

Display a minimal version */

inline: boolean

/**

Field is optional */

optional: boolean

/**

Modify value returned when queried through `Pages` */

query<P>(

field: Expr<TextDoc<T>>,

pages: Pages<P>

): undefined | Expr<Q>

}

Text

Select