g
Frontend | Backend | Api

Forms\Models\Api\InputCheckbox

Entity for ` `. Could represent two types of checkbox: - single: input to save bool value based on checked attribute. - multiple: save different values inside. Actually the same with multiple InputSelect.

Property Description Returns
type Returns the type of the current element string
multiple Returns whether multiple value is set bool
options Returns options array from settings. Returns null if setting is not set or set incorrect (every option should have at least `value` and `title` keys). Returns only unique value based on `value` key. NOTE values are not encoded. You need to encode them before rendering in HTML. Also, remember to encode value when you are comparing them. array
errors Gets all violations (error messages) related to the element's current submission array
errorMessage Gets error message for the field. If there are several errors for the element, all of them will be added to this message. string
errors Returns whether element has at least one error bool
name string
entity string
id int
help Gets help text for the element. It could be used as a tooltip or in HTML as a title attribute, e.g. ' '. string
editor string
text Text for the element that usually is used for element's label string
defaultValue string
placeholder string
required bool
regex string
position int
settings array
revision FormRevision
step Step
submissions Collection (ElementSubmission)
parent ElementGroup