Switcher Control

Elementor Core Basic

Elementor switcher control displays an on/off switcher. It's basically a fancy representation of checkboxes.

The control is defined in Control_Switcher class which extends Base_Data_Control class.

When using this control, the type should be set to \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 and after. default will hide the separator, unless the control type has specific separator settings. before / after will position the separator before/after the control.
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, based on return_value argument.

Usage

<?php
class Elementor_Test_Widget extends \Elementor\Widget_Base {

	protected function register_controls(): void {

		$this->start_controls_section(
			'content_section',
			[
				'label' => esc_html__( 'Content', 'textdomain' ),
				'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
			]
		);

		$this->add_control(
			'show_title',
			[
				'label' => esc_html__( 'Show Title', 'textdomain' ),
				'type' => \Elementor\Controls_Manager::SWITCHER,
				'label_on' => esc_html__( 'Show', 'textdomain' ),
				'label_off' => esc_html__( 'Hide', 'textdomain' ),
				'return_value' => 'yes',
				'default' => 'yes',
			]
		);

		$this->add_control(
			'title',
			[
				'label' => esc_html__( 'Title', 'textdomain' ),
				'type' => \Elementor\Controls_Manager::TEXT,
				'default' => esc_html__( 'Default title', 'textdomain' ),
			]
		);

		$this->end_controls_section();

	}

	protected function render(): void {
		$settings = $this->get_settings_for_display();
		if ( 'yes' === $settings['show_title'] ) {
			echo '<h2>' . $settings['title'] . '</h2>';
		}
	}

	protected function content_template(): void {
		?>
		<# if ( 'yes' === settings.show_title ) { #>
			<h2>{{{ settings.title }}}</h2>
		<# } #>
		<?php
	}

}