*
* @since 1.0.0
*
* @param string $label Optional. The label that appears above of the
* field. Default is empty.
* @param string $description Optional. The description that appears below the
* field. Default is empty.
* @param string $placeholder Optional. The field placeholder that appears when
* the field has no values. Default is empty.
* @param array $default {
* Optional. Defautl dimension values.
*
* @type int $top Optional. Top dimension. Default is empty.
* @type int $right Optional. Right dimension. Default is empty.
* @type int $bottom Optional. Bottom dimension. Default is empty.
* @type int $left Optional. Left dimension. Default is empty.
* @type string $unit Optional. The CSS unit type. Available units are
* '%', 'px', 'em', 'rem' or 'deg'. Default is 'px'.
* @type bool $isLinked Optional. Whether to link all the values together
* or not. Used to prevent setting different values
* foreach dimension location (top, right, bottom,
* left). Default is true, all the dimension are linked.
* }
* @param array|string $allowed_dimensions Optional. Which fields to show.
* Available values are 'all',
* 'horizontal', 'vertical',
* [ 'top', 'left' ... ]. Default is 'all'.
* @param string $separator Optional. 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. Default
* is 'default'.
* @param bool $show_label Optional. Whether to display the label. Default is
* true.
* @param bool $label_block Optional. Whether to display the label in a
* separate line. Default is true.
*
* @return array {
* An array containing the dimensions values - top / right / bottom / left:
* `[ 'top' => '', 'right' => '', 'bottom' => '', 'left' => '', 'unit' => '', 'isLinked' => '' ]`.
*
* @type int $top Top dimension.
* @type int $right Right dimension.
* @type int $bottom Bottom dimension.
* @type int $left Left dimension.
* @type string $unit The CSS unit type.
* @type bool $isLinked Whether to link all the values together or not.
* }
*/
class Control_Dimensions extends Control_Base_Units {
/**
* Retrieve dimensions control type.
*
* @since 1.0.0
* @access public
*
* @return string Control type.
*/
public function get_type() {
return 'dimensions';
}
/**
* Retrieve dimensions control default values.
*
* Get the default value of the dimensions control. Used to return the
* default values while initializing the dimensions control.
*
* @since 1.0.0
* @access public
*
* @return array Control default value.
*/
public function get_default_value() {
return array_merge(
parent::get_default_value(), [
'top' => '',
'right' => '',
'bottom' => '',
'left' => '',
'isLinked' => true,
]
);
}
/**
* Retrieve dimensions control default settings.
*
* Get the default settings of the dimensions control. Used to return the
* default settings while initializing the dimensions control.
*
* @since 1.0.0
* @access protected
*
* @return array Control default settings.
*/
protected function get_default_settings() {
return array_merge(
parent::get_default_settings(), [
'label_block' => true,
'allowed_dimensions' => 'all',
'placeholder' => '',
]
);
}
/**
* Render dimensions control output in the editor.
*
* Used to generate the control HTML in the editor using Underscore JS
* template. The variables for the class are available using `data` JS
* object.
*
* @since 1.0.0
* @access public
*/
public function content_template() {
$dimensions = [
'top' => __( 'Top', 'elementor' ),
'right' => __( 'Right', 'elementor' ),
'bottom' => __( 'Bottom', 'elementor' ),
'left' => __( 'Left', 'elementor' ),
];
?>