URLField defines "url" type field for storing a single URL string value.

The respective zero record field value is empty string.

Hierarchy

Implements

Constructors

Methods

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

  • SetId implements [Field.SetId] interface method.

    Parameters

    • id: string

    Returns void

  • SetName implements [Field.SetName] interface method.

    Parameters

    • name: string

    Returns void

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

Properties

exceptDomains: string[]

ExceptDomains will require the URL domain to NOT be included in the listed ones.

This validator can be set only if OnlyDomains is empty.

hidden: boolean

Hidden hides the field from the API response.

id: string

Id is the unique stable field identifier.

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

name: string

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

onlyDomains: string[]

OnlyDomains will require the URL domain to be included in the listed ones.

This validator can be set only if ExceptDomains is empty.

presentable: boolean

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

required: boolean

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

system: boolean

System prevents the renaming and removal of the field.

Generated using TypeDoc