Interface EditorField

EditorField defines "editor" type field to store HTML formatted text.

The respective zero record field value is empty string.

Hierarchy

Implemented by

Methods

calculateMaxBodySize columnType getHidden getId getName getSystem prepareValue setHidden setId setName setSystem type validateSettings validateValue

Properties

convertURLs hidden id maxSize name presentable required system

Methods

calculateMaxBodySize

  • CalculateMaxBodySize implements the [MaxBodySizeCalculator] interface.

    Returns number

columnType

  • ColumnType implements [Field.ColumnType] interface method.

    Parameters

    Returns string

getHidden

  • GetHidden implements [Field.GetHidden] interface method.

    Returns boolean

getId

  • GetId implements [Field.GetId] interface method.

    Returns string

getName

  • GetName implements [Field.GetName] interface method.

    Returns string

getSystem

  • GetSystem implements [Field.GetSystem] interface method.

    Returns boolean

prepareValue

  • PrepareValue implements [Field.PrepareValue] interface method.

    Parameters

    Returns any

setHidden

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

setId

  • SetId implements [Field.SetId] interface method.

    Parameters

    • id: string

    Returns void

setName

  • SetName implements [Field.SetName] interface method.

    Parameters

    • name: string

    Returns void

setSystem

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

type

  • Type implements [Field.Type] interface method.

    Returns string

validateSettings

validateValue

Properties

convertURLs

convertURLs: boolean

ConvertURLs is usually used to instruct the editor whether to apply url conversion (eg. stripping the domain name in case the urls are using the same domain as the one where the editor is loaded).

(see also https://www.tiny.cloud/docs/tinymce/6/url-handling/#convert_urls)

hidden

hidden: boolean

Hidden hides the field from the API response.

id

id: string

Id is the unique stable field identifier.

It is automatically generated from the name when adding to a collection FieldsList.

maxSize

maxSize: number

MaxSize specifies the maximum size of the allowed field value (in bytes).

If zero, a default limit of ~5MB is applied.

name

name: string

Name (required) is the unique name of the field.

presentable

presentable: boolean

Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.

required

required: boolean

Required will require the field value to be non-empty string.

system

system: boolean

System prevents the renaming and removal of the field.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc