Components

RichText

<RichText />

Members

# constant DefaultQuillToolbarOptions

variable holding a default quill toolbar. It looks like this:

export const DefaultQuillToolbarOptions = [
  [{ header: [1, 2, 3, 4, 5, 6, false] }],
  ['bold', 'italic', 'underline', 'strike'], // toggled buttons
  ['blockquote', 'code-block'],
  [{ list: 'ordered' }, { list: 'bullet' }],
  [{ indent: '-1' }, { indent: '+1' }],

  [{ align: [] }],
  ['link', 'image', 'video'],

  ['clean'], // remove formatting button
]

Usage

import { DefaultQuillToolbarOptions } from '@adminjs/design-system`

View Source adminjs-design-system/src/molecules/rich-text/rich-text-props.ts, line 30

Type Definitions

object

# QuillOptions

Prop Types of a a Quill editor

Properties:
Name Type Attributes Description
theme 'snow' | 'bubble' <optional>

Theme - default to snow

modules object <optional>
toolbar Array.<QuillToolbarOptions> | object <optional>
toolbar.handlers Record.<string, any> <optional>
toolbar.container Array.<QuillToolbarOptions> <optional>
{...} any
debug string | boolean <optional>
placeholder string <optional>
readOnly boolean <optional>
formats Array <optional>
bounds HTMLElement | string <optional>
scrollingContainer HTMLElement | string <optional>
strict boolean <optional>
See:

View Source adminjs-design-system/src/molecules/rich-text/rich-text-props.ts, line 44

# RichTextOnChange(content)

OnChange callback passed to RichTextProps

Parameters:
Name Type Description
content string

value of the component

View Source adminjs-design-system/src/molecules/rich-text/rich-text-props.ts, line 65

object

# RichTextProps

Prop Types of an entire RichText

Properties:
Name Type Attributes Description
value string <optional>

HTML value

borderless boolean <optional>

Indicates if editor should be more fancy: borderless

onChange RichTextOnChange <optional>

On change callback

quill QuillOptions

Quill related options

View Source adminjs-design-system/src/molecules/rich-text/rich-text-props.ts, line 72