Table of Contents
Elementor switcher control displays a an on/off switcher. It’s basically a fancy representation of the Checkbox Control.
The control is defined in Control_Switcher class which extends Base_Data_Control class.
Note that when using the control, the type should be set using the \Elementor\Controls_Manager::SWITCHER constant.
Arguments
| Name | Type | Default | Description |
|---|---|---|---|
type |
string |
switcher | The type of the control. |
label |
string |
The label that appears above of the field. | |
description |
string |
The description that appears below the field. | |
show_label |
bool |
true | Whether to display the label. |
label_block |
bool |
false | Whether to display the label in a separate line. |
separator |
string |
default | Set the position of the control separator. Available values are default, before, after and none. default will position the separator depending on the control type. before / after will position the separator before/after the control. none will hide the separator. |
label_on |
string |
Yes | The label for the “unchecked” state. |
label_off |
string |
No | The label for the “checked” state. |
return_value |
string |
yes | The value returned when checked. |
default |
string |
The field default value. |
Return Value
(string) The switcher field value.
Usage
<?php
class Elementor_Test_Widget extends \Elementor\Widget_Base {
protected function _register_controls() {
$this->start_controls_section(
'content_section',
[
'label' => __( 'Content', 'plugin-name' ),
'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
]
);
$this->add_control(
'show_title',
[
'label' => __( 'Show Title', 'plugin-domain' ),
'type' => \Elementor\Controls_Manager::SWITCHER,
'label_on' => __( 'Show', 'your-plugin' ),
'label_off' => __( 'Hide', 'your-plugin' ),
'return_value' => 'yes',
'default' => 'yes',
]
);
$this->add_control(
'title',
[
'label' => __( 'Title', 'plugin-domain' ),
'type' => \Elementor\Controls_Manager::TEXT,
'default' => __( 'Default title', 'plugin-domain' ),
]
);
$this->end_controls_section();
}
protected function render() {
$settings = $this->get_settings_for_display();
if ( 'yes' === $settings['show_title'] ) {
echo '<h2>' . $settings['title'] . '</h2>';
}
}
protected function _content_template() {
?>
<# if ( 'yes' === settings.show_title ) { #>
<h2>{{{ settings.title }}}</h2>
<# } #>
<?php
}
}