typedef LinkOptions

package shared.component.field

import shared.component.field.Link

Link fields can have one or multiple types. You can use it for internal and external links but also to upload files or images.

{
  "key": "link",
  "label": "Link",
  "type": "Link",
  "options":{
    "type":["entry", "external"]
  }
}
{
  "key": "image",
  "label": "Image",
  "type": "Link",
  "options":{
    "type": "image"
  }
}

Properties

@:optionalchannels:Null<Array<String>>

Allow only links from a particular channel.

"channels": ["contentpage"]

@:optionalextensions:Null<Array<String>>

Restrict files to these extensions.

"extensions": ["svg"]

@:optionalhelp:Null<Dynamic>

Adding help or instructional text to a field.

"help": "This field can only contain letters."

@:optionalhidden:Null<Bool>

Hide this field in the interface.

"hidden": true

@:optionalhide_description:Null<Bool>

Hide the description field.

"hide_description": true

@:optionalmax:Null<Int>

@:optionalmin:Null<Int>

@:optionalmin_resolution:Null<Array<Int>>

@:optionalminimal:Null<Bool>

Hide the label of the textfield.

"minimal": true

@:optionalmultiple:Null<Bool>

You can select multiple images or links within the same key.

"multiple": true

@:optionaloverview:Null<Bool>

@:optionaloverview_editable:Null<Bool>

@:optionaloverview_filter:Null<Bool>

@:optionaloverview_searchable:Null<Bool>

@:optionalplaceholder:Null<Dynamic>

@:optionalprojects:Null<Array<String>>

@:optionalprovides_metadata:Null<String>

You can prefill metadata image.

"provides_metadata": "image"

@:optionalreadonly:Null<Bool>

Field is read only.

"readonly": true

@:optionalrequired:Null<Bool>

This field can't be empty.

"required": true

@:optionalselect_entry:Null<Int>

Start searching for entry links within a specific entry. Note: always specify a project

"select_project": ["projectname"]
"select_entry": 7

@:optionalselect_project:Null<String>

With several projects it's possible to determine which project can be used as default when selecting entries.

"select_project": ["projectname"]

@:optionalshow_when:Null<EitherType<ShowOptions, Array<ShowOptions>>>

The "value" can be set to "null" of "!null" to check if something is empty.

@:optionaltype:Null<Dynamic>

Set one or multiple types. If you don't define a type then they are all available.

"type": ["image", "file", "entry", "external"]

@:optionalvalue:Null<Any>

@:optionalwidth:Null<Float>

Width percentpoint 0-1.

"width": 0.5"