Skip to content

Tags

Class: Code16\Sharp\Form\Fields\SharpFormTagsField

Configuration

setCreatable

If true, the user can create a new value from the form. Default: false.

setCreateText

The text displayed to the user when creating a new value. Default: "Create"

setCreateAttribute

The name of the attribute which should be used for the creation.

setCreateAdditionalAttributes

Optional additional attributes to be set at creation. Example: with -⁠>setCreateAdditionalAttributes(["group"=>"public"]), the group attribute of a created tag would be set to "public". Default: []

setIdAttribute

Set the id name attribute of tags. Default: "id"

setDisplayAsDropdown

Display as a classic dropdown.

setMaxTagsCount

Set a maximum tags selection. Default: unlimited.

setMaxTagCountUnlimited

Unset a maximum tags selection.

setInline

Display an inline checklist (if multiple + display=list).

Formatter

  • toFront: expects an array of id values OR an array of models.

  • fromFront: returns an array of arrays with the "id" key, and the "createAttribute" key in creation case:

php
[
    ["id" => 1],
    ["id" => null, "name" => "Bob Marley]
]
[
    ["id" => 1],
    ["id" => null, "name" => "Bob Marley]
]

In this example, the user selected one tag and created another one with the "Bob Marley" text.

Released under the MIT License.