Creates a tags element with a title, that allows you to select multiple items from a list.
The value that is submitted will have the following convention – {variable}_{option key}. In the example below the submitted variables’ keys will be example_tags_first_tag and example_tags_second_tag. Their value will be 1 or 0 depending on if they are checked or not.
Passing pre-selected values is done with an array where the key is the key of the tag and the value is a boolean.
titleString | The field's title
itemsArray | An array of items that should be passed in key - value pairs
paramsArray | Additional parameters such as variable and value
errorString | Default: false | Custom error message
$this->formkitTags('Tags Example', array(
'first_tag' => 'First Tag',
'second_tag' => 'Second Tag'
), array(
'variable' => 'example_tags'
));
// Tags with pre-selected values
$this->formkitTags('Tags Example', array(
'first_tag' => 'First Tag',
'second_tag' => 'Second Tag'
), array(
'variable' => 'example_tags',
'value' => array(
'first_tag' => 1
)
));
Creates a slider component with a title and dynamically displaying the current value.
titleString | The field title
variablenameString | The variable name
defaultvalueNumber | The slider's default value
minvalueNumber | The slider's minimal allowed value
maxvalueNumber | The slider's maximal allowed value
stepNumber | The slider movement step
$this->formkitSlider('Example Slider', 'example_slider', 100, 0, 500, 10);
Creates a radio buttons element. Works similarly to formkitTags but allows only one selected option at a time. Unlike tags, selected value is passed as a string.
titleString | The field title
itemsArray | The radio items
paramsArray | Default: false | Additional params such as variable name and value
errorString | Default: false | Custom error message
$this->formkitRadiobuttons('Example Radio Buttons', array(
'first_option' => 'First Option',
'second_option' => 'Second Option',
), array(
'variable' => 'example_radio'
));
// Radio buttons with pre-selected value
$this->formkitRadiobuttons('Example Radio Buttons', array(
'first_option' => 'First Option',
'second_option' => 'Second Option',
), array(
'variable' => 'example_radio',
'value' => 'first_option'
));
Creates a single checkbox element with a title.
variableString | The variable name
titleString | The field title
paramsArray | Default: false | An array of parameters
errorString | Default: false | Custom error message
$this->formkitCheckbox('example_checkbox', 'Example Checkbox');
Creates a checkboxes component. Under the hood it uses the formkitRadiobuttons component, but will have style differences.
titleString | The field title
itemsArray | Array of items
paramsArray | Default: false | Additional parameters such as variable
errorString | Default: '' | Custom error message
$this->data->scroll[] = $this->formkitCheckboxes('Example Checkboxes', array(
'first_check' => 'First Check',
'second_check' => 'Second Check'
), array(
'variable' => 'example_check'
));
Creates a textarea component.
variableString | The variable name
titleString | The field title
hintString | Hint for the textarea
typeString
errorString | Custom error message
$this->formkitTextarea('example_textarea', 'Example Textarea', 'Example', '', '');
Creates a datepicker component. Allows you to specify date, month and year. Date is returned as three separate variables using the following convention – {variable name}_day, {variable name}_month and {variable_name}_year. In the example bellow those would be – example_date_day, example_date_month and example_date_year.
titleString | The field title
variableString | The variable name
paramsArray | Default: false | Additional parameters
errorString | Default: false | Custom error message
$this->formkitDate('Example Date', 'example_date');