elementor / includes / widgets / button.php

button.php in Elementor Website Builder – more than just a page builder 3.3.1, at includes/widgets/button.php

581 lines 14.1 KB

Raw Download Zip

1	<?php
2	namespace Elementor;
3
4	if ( ! defined( 'ABSPATH' ) ) {
5	exit; // Exit if accessed directly.
6	}
7
8	use Elementor\Core\Kits\Documents\Tabs\Global_Colors;
9	use Elementor\Core\Kits\Documents\Tabs\Global_Typography;
10
11	/**
12	* Elementor button widget.
13	*
14	* Elementor widget that displays a button with the ability to control every
15	* aspect of the button design.
16	*
17	* @since 1.0.0
18	*/
19	class Widget_Button extends Widget_Base {
20
21	/**
22	* Get widget name.
23	*
24	* Retrieve button widget name.
25	*
26	* @since 1.0.0
27	* @access public
28	*
29	* @return string Widget name.
30	*/
31	public function get_name() {
32	return 'button';
33	}
34
35	/**
36	* Get widget title.
37	*
38	* Retrieve button widget title.
39	*
40	* @since 1.0.0
41	* @access public
42	*
43	* @return string Widget title.
44	*/
45	public function get_title() {
46	return __( 'Button', 'elementor' );
47	}
48
49	/**
50	* Get widget icon.
51	*
52	* Retrieve button widget icon.
53	*
54	* @since 1.0.0
55	* @access public
56	*
57	* @return string Widget icon.
58	*/
59	public function get_icon() {
60	return 'eicon-button';
61	}
62
63	/**
64	* Get widget categories.
65	*
66	* Retrieve the list of categories the button widget belongs to.
67	*
68	* Used to determine where to display the widget in the editor.
69	*
70	* @since 2.0.0
71	* @access public
72	*
73	* @return array Widget categories.
74	*/
75	public function get_categories() {
76	return [ 'basic' ];
77	}
78
79	/**
80	* Get button sizes.
81	*
82	* Retrieve an array of button sizes for the button widget.
83	*
84	* @since 1.0.0
85	* @access public
86	* @static
87	*
88	* @return array An array containing button sizes.
89	*/
90	public static function get_button_sizes() {
91	return [
92	'xs' => __( 'Extra Small', 'elementor' ),
93	'sm' => __( 'Small', 'elementor' ),
94	'md' => __( 'Medium', 'elementor' ),
95	'lg' => __( 'Large', 'elementor' ),
96	'xl' => __( 'Extra Large', 'elementor' ),
97	];
98	}
99
100	/**
101	* Register button widget controls.
102	*
103	* Adds different input fields to allow the user to change and customize the widget settings.
104	*
105	* @since 3.1.0
106	* @access protected
107	*/
108	protected function register_controls() {
109	$this->start_controls_section(
110	'section_button',
111	[
112	'label' => __( 'Button', 'elementor' ),
113	]
114	);
115
116	$this->add_control(
117	'button_type',
118	[
119	'label' => __( 'Type', 'elementor' ),
120	'type' => Controls_Manager::SELECT,
121	'default' => '',
122	'options' => [
123	'' => __( 'Default', 'elementor' ),
124	'info' => __( 'Info', 'elementor' ),
125	'success' => __( 'Success', 'elementor' ),
126	'warning' => __( 'Warning', 'elementor' ),
127	'danger' => __( 'Danger', 'elementor' ),
128	],
129	'prefix_class' => 'elementor-button-',
130	]
131	);
132
133	$this->add_control(
134	'text',
135	[
136	'label' => __( 'Text', 'elementor' ),
137	'type' => Controls_Manager::TEXT,
138	'dynamic' => [
139	'active' => true,
140	],
141	'default' => __( 'Click here', 'elementor' ),
142	'placeholder' => __( 'Click here', 'elementor' ),
143	]
144	);
145
146	$this->add_control(
147	'link',
148	[
149	'label' => __( 'Link', 'elementor' ),
150	'type' => Controls_Manager::URL,
151	'dynamic' => [
152	'active' => true,
153	],
154	'placeholder' => __( 'https://your-link.com', 'elementor' ),
155	'default' => [
156	'url' => '#',
157	],
158	]
159	);
160
161	$this->add_responsive_control(
162	'align',
163	[
164	'label' => __( 'Alignment', 'elementor' ),
165	'type' => Controls_Manager::CHOOSE,
166	'options' => [
167	'left' => [
168	'title' => __( 'Left', 'elementor' ),
169	'icon' => 'eicon-text-align-left',
170	],
171	'center' => [
172	'title' => __( 'Center', 'elementor' ),
173	'icon' => 'eicon-text-align-center',
174	],
175	'right' => [
176	'title' => __( 'Right', 'elementor' ),
177	'icon' => 'eicon-text-align-right',
178	],
179	'justify' => [
180	'title' => __( 'Justified', 'elementor' ),
181	'icon' => 'eicon-text-align-justify',
182	],
183	],
184	'prefix_class' => 'elementor%s-align-',
185	'default' => '',
186	]
187	);
188
189	$this->add_control(
190	'size',
191	[
192	'label' => __( 'Size', 'elementor' ),
193	'type' => Controls_Manager::SELECT,
194	'default' => 'sm',
195	'options' => self::get_button_sizes(),
196	'style_transfer' => true,
197	]
198	);
199
200	$this->add_control(
201	'selected_icon',
202	[
203	'label' => __( 'Icon', 'elementor' ),
204	'type' => Controls_Manager::ICONS,
205	'fa4compatibility' => 'icon',
206	'skin' => 'inline',
207	'label_block' => false,
208	]
209	);
210
211	$this->add_control(
212	'icon_align',
213	[
214	'label' => __( 'Icon Position', 'elementor' ),
215	'type' => Controls_Manager::SELECT,
216	'default' => 'left',
217	'options' => [
218	'left' => __( 'Before', 'elementor' ),
219	'right' => __( 'After', 'elementor' ),
220	],
221	'condition' => [
222	'selected_icon[value]!' => '',
223	],
224	]
225	);
226
227	$this->add_control(
228	'icon_indent',
229	[
230	'label' => __( 'Icon Spacing', 'elementor' ),
231	'type' => Controls_Manager::SLIDER,
232	'range' => [
233	'px' => [
234	'max' => 50,
235	],
236	],
237	'selectors' => [
238	'{{WRAPPER}} .elementor-button .elementor-align-icon-right' => 'margin-left: {{SIZE}}{{UNIT}};',
239	'{{WRAPPER}} .elementor-button .elementor-align-icon-left' => 'margin-right: {{SIZE}}{{UNIT}};',
240	],
241	]
242	);
243
244	$this->add_control(
245	'view',
246	[
247	'label' => __( 'View', 'elementor' ),
248	'type' => Controls_Manager::HIDDEN,
249	'default' => 'traditional',
250	]
251	);
252
253	$this->add_control(
254	'button_css_id',
255	[
256	'label' => __( 'Button ID', 'elementor' ),
257	'type' => Controls_Manager::TEXT,
258	'dynamic' => [
259	'active' => true,
260	],
261	'default' => '',
262	'title' => __( 'Add your custom id WITHOUT the Pound key. e.g: my-id', 'elementor' ),
263	'description' => __( 'Please make sure the ID is unique and not used elsewhere on the page this form is displayed. This field allows <code>A-z 0-9</code> & underscore chars without spaces.', 'elementor' ),
264	'separator' => 'before',
265
266	]
267	);
268
269	$this->end_controls_section();
270
271	$this->start_controls_section(
272	'section_style',
273	[
274	'label' => __( 'Button', 'elementor' ),
275	'tab' => Controls_Manager::TAB_STYLE,
276	]
277	);
278
279	$this->add_group_control(
280	Group_Control_Typography::get_type(),
281	[
282	'name' => 'typography',
283	'global' => [
284	'default' => Global_Typography::TYPOGRAPHY_ACCENT,
285	],
286	'selector' => '{{WRAPPER}} .elementor-button',
287	]
288	);
289
290	$this->add_group_control(
291	Group_Control_Text_Shadow::get_type(),
292	[
293	'name' => 'text_shadow',
294	'selector' => '{{WRAPPER}} .elementor-button',
295	]
296	);
297
298	$this->start_controls_tabs( 'tabs_button_style' );
299
300	$this->start_controls_tab(
301	'tab_button_normal',
302	[
303	'label' => __( 'Normal', 'elementor' ),
304	]
305	);
306
307	$this->add_control(
308	'button_text_color',
309	[
310	'label' => __( 'Text Color', 'elementor' ),
311	'type' => Controls_Manager::COLOR,
312	'default' => '',
313	'selectors' => [
314	'{{WRAPPER}} .elementor-button' => 'fill: {{VALUE}}; color: {{VALUE}};',
315	],
316	]
317	);
318
319	$this->add_group_control(
320	Group_Control_Background::get_type(),
321	[
322	'name' => 'background',
323	'label' => __( 'Background', 'elementor' ),
324	'types' => [ 'classic', 'gradient' ],
325	'exclude' => [ 'image' ],
326	'selector' => '{{WRAPPER}} .elementor-button',
327	'fields_options' => [
328	'background' => [
329	'default' => 'classic',
330	],
331	'color' => [
332	'global' => [
333	'default' => Global_Colors::COLOR_ACCENT,
334	],
335	],
336	],
337	]
338	);
339
340	$this->end_controls_tab();
341
342	$this->start_controls_tab(
343	'tab_button_hover',
344	[
345	'label' => __( 'Hover', 'elementor' ),
346	]
347	);
348
349	$this->add_control(
350	'hover_color',
351	[
352	'label' => __( 'Text Color', 'elementor' ),
353	'type' => Controls_Manager::COLOR,
354	'selectors' => [
355	'{{WRAPPER}} .elementor-button:hover, {{WRAPPER}} .elementor-button:focus' => 'color: {{VALUE}};',
356	'{{WRAPPER}} .elementor-button:hover svg, {{WRAPPER}} .elementor-button:focus svg' => 'fill: {{VALUE}};',
357	],
358	]
359	);
360
361	$this->add_group_control(
362	Group_Control_Background::get_type(),
363	[
364	'name' => 'button_background_hover',
365	'label' => __( 'Background', 'elementor' ),
366	'types' => [ 'classic', 'gradient' ],
367	'exclude' => [ 'image' ],
368	'selector' => '{{WRAPPER}} .elementor-button:hover, {{WRAPPER}} .elementor-button:focus',
369	'fields_options' => [
370	'background' => [
371	'default' => 'classic',
372	],
373	],
374	]
375	);
376
377	$this->add_control(
378	'button_hover_border_color',
379	[
380	'label' => __( 'Border Color', 'elementor' ),
381	'type' => Controls_Manager::COLOR,
382	'condition' => [
383	'border_border!' => '',
384	],
385	'selectors' => [
386	'{{WRAPPER}} .elementor-button:hover, {{WRAPPER}} .elementor-button:focus' => 'border-color: {{VALUE}};',
387	],
388	]
389	);
390
391	$this->add_control(
392	'hover_animation',
393	[
394	'label' => __( 'Hover Animation', 'elementor' ),
395	'type' => Controls_Manager::HOVER_ANIMATION,
396	]
397	);
398
399	$this->end_controls_tab();
400
401	$this->end_controls_tabs();
402
403	$this->add_group_control(
404	Group_Control_Border::get_type(),
405	[
406	'name' => 'border',
407	'selector' => '{{WRAPPER}} .elementor-button',
408	'separator' => 'before',
409	]
410	);
411
412	$this->add_control(
413	'border_radius',
414	[
415	'label' => __( 'Border Radius', 'elementor' ),
416	'type' => Controls_Manager::DIMENSIONS,
417	'size_units' => [ 'px', '%', 'em' ],
418	'selectors' => [
419	'{{WRAPPER}} .elementor-button' => 'border-radius: {{TOP}}{{UNIT}} {{RIGHT}}{{UNIT}} {{BOTTOM}}{{UNIT}} {{LEFT}}{{UNIT}};',
420	],
421	]
422	);
423
424	$this->add_group_control(
425	Group_Control_Box_Shadow::get_type(),
426	[
427	'name' => 'button_box_shadow',
428	'selector' => '{{WRAPPER}} .elementor-button',
429	]
430	);
431
432	$this->add_responsive_control(
433	'text_padding',
434	[
435	'label' => __( 'Padding', 'elementor' ),
436	'type' => Controls_Manager::DIMENSIONS,
437	'size_units' => [ 'px', 'em', '%' ],
438	'selectors' => [
439	'{{WRAPPER}} .elementor-button' => 'padding: {{TOP}}{{UNIT}} {{RIGHT}}{{UNIT}} {{BOTTOM}}{{UNIT}} {{LEFT}}{{UNIT}};',
440	],
441	'separator' => 'before',
442	]
443	);
444
445	$this->end_controls_section();
446	}
447
448	/**
449	* Render button widget output on the frontend.
450	*
451	* Written in PHP and used to generate the final HTML.
452	*
453	* @since 1.0.0
454	* @access protected
455	*/
456	protected function render() {
457	$settings = $this->get_settings_for_display();
458
459	$this->add_render_attribute( 'wrapper', 'class', 'elementor-button-wrapper' );
460
461	if ( ! empty( $settings['link']['url'] ) ) {
462	$this->add_link_attributes( 'button', $settings['link'] );
463	$this->add_render_attribute( 'button', 'class', 'elementor-button-link' );
464	}
465
466	$this->add_render_attribute( 'button', 'class', 'elementor-button' );
467	$this->add_render_attribute( 'button', 'role', 'button' );
468
469	if ( ! empty( $settings['button_css_id'] ) ) {
470	$this->add_render_attribute( 'button', 'id', $settings['button_css_id'] );
471	}
472
473	if ( ! empty( $settings['size'] ) ) {
474	$this->add_render_attribute( 'button', 'class', 'elementor-size-' . $settings['size'] );
475	}
476
477	if ( $settings['hover_animation'] ) {
478	$this->add_render_attribute( 'button', 'class', 'elementor-animation-' . $settings['hover_animation'] );
479	}
480	?>
481	<div <?php echo $this->get_render_attribute_string( 'wrapper' ); ?>>
482	<a <?php echo $this->get_render_attribute_string( 'button' ); ?>>
483	<?php $this->render_text(); ?>
484	</a>
485	</div>
486	<?php
487	}
488
489	/**
490	* Render button widget output in the editor.
491	*
492	* Written as a Backbone JavaScript template and used to generate the live preview.
493	*
494	* @since 2.9.0
495	* @access protected
496	*/
497	protected function content_template() {
498	?>
499	<#
500	view.addRenderAttribute( 'text', 'class', 'elementor-button-text' );
501	view.addInlineEditingAttributes( 'text', 'none' );
502	var iconHTML = elementor.helpers.renderIcon( view, settings.selected_icon, { 'aria-hidden': true }, 'i' , 'object' ),
503	migrated = elementor.helpers.isIconMigrated( settings, 'selected_icon' );
504	#>
505	<div class="elementor-button-wrapper">
506	<a id="{{ settings.button_css_id }}" class="elementor-button elementor-size-{{ settings.size }} elementor-animation-{{ settings.hover_animation }}" href="{{ settings.link.url }}" role="button">
507	<span class="elementor-button-content-wrapper">
508	<# if ( settings.icon \|\| settings.selected_icon ) { #>
509	<span class="elementor-button-icon elementor-align-icon-{{ settings.icon_align }}">
510	<# if ( ( migrated \|\| ! settings.icon ) && iconHTML.rendered ) { #>
511	{{{ iconHTML.value }}}
512	<# } else { #>
513	<i class="{{ settings.icon }}" aria-hidden="true"></i>
514	<# } #>
515	</span>
516	<# } #>
517	<span {{{ view.getRenderAttributeString( 'text' ) }}}>{{{ settings.text }}}</span>
518	</span>
519	</a>
520	</div>
521	<?php
522	}
523
524	/**
525	* Render button text.
526	*
527	* Render button widget text.
528	*
529	* @since 1.5.0
530	* @access protected
531	*/
532	protected function render_text() {
533	$settings = $this->get_settings_for_display();
534
535	$migrated = isset( $settings['__fa4_migrated']['selected_icon'] );
536	$is_new = empty( $settings['icon'] ) && Icons_Manager::is_migration_allowed();
537
538	if ( ! $is_new && empty( $settings['icon_align'] ) ) {
539	// @todo: remove when deprecated
540	// added as bc in 2.6
541	//old default
542	$settings['icon_align'] = $this->get_settings( 'icon_align' );
543	}
544
545	$this->add_render_attribute( [
546	'content-wrapper' => [
547	'class' => 'elementor-button-content-wrapper',
548	],
549	'icon-align' => [
550	'class' => [
551	'elementor-button-icon',
552	'elementor-align-icon-' . $settings['icon_align'],
553	],
554	],
555	'text' => [
556	'class' => 'elementor-button-text',
557	],
558	] );
559
560	$this->add_inline_editing_attributes( 'text', 'none' );
561	?>
562	<span <?php echo $this->get_render_attribute_string( 'content-wrapper' ); ?>>
563	<?php if ( ! empty( $settings['icon'] ) \|\| ! empty( $settings['selected_icon']['value'] ) ) : ?>
564	<span <?php echo $this->get_render_attribute_string( 'icon-align' ); ?>>
565	<?php if ( $is_new \|\| $migrated ) :
566	Icons_Manager::render_icon( $settings['selected_icon'], [ 'aria-hidden' => 'true' ] );
567	else : ?>
568	<i class="<?php echo esc_attr( $settings['icon'] ); ?>" aria-hidden="true"></i>
569	<?php endif; ?>
570	</span>
571	<?php endif; ?>
572	<span <?php echo $this->get_render_attribute_string( 'text' ); ?>><?php echo $settings['text']; ?></span>
573	</span>
574	<?php
575	}
576
577	public function on_import( $element ) {
578	return Icons_Manager::on_import_migration( $element, 'icon', 'selected_icon' );
579	}
580	}
581