elementor / includes / widgets / icon-list.php

icon-list.php in Elementor Website Builder – more than just a page builder 3.11.5, at includes/widgets/icon-list.php

706 lines 18.9 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 icon list widget.
13	*
14	* Elementor widget that displays a bullet list with any chosen icons and texts.
15	*
16	* @since 1.0.0
17	*/
18	class Widget_Icon_List extends Widget_Base {
19
20	/**
21	* Get widget name.
22	*
23	* Retrieve icon list widget name.
24	*
25	* @since 1.0.0
26	* @access public
27	*
28	* @return string Widget name.
29	*/
30	public function get_name() {
31	return 'icon-list';
32	}
33
34	/**
35	* Get widget title.
36	*
37	* Retrieve icon list widget title.
38	*
39	* @since 1.0.0
40	* @access public
41	*
42	* @return string Widget title.
43	*/
44	public function get_title() {
45	return esc_html__( 'Icon List', 'elementor' );
46	}
47
48	/**
49	* Get widget icon.
50	*
51	* Retrieve icon list widget icon.
52	*
53	* @since 1.0.0
54	* @access public
55	*
56	* @return string Widget icon.
57	*/
58	public function get_icon() {
59	return 'eicon-bullet-list';
60	}
61
62	/**
63	* Get widget keywords.
64	*
65	* Retrieve the list of keywords the widget belongs to.
66	*
67	* @since 2.1.0
68	* @access public
69	*
70	* @return array Widget keywords.
71	*/
72	public function get_keywords() {
73	return [ 'icon list', 'icon', 'list' ];
74	}
75
76	/**
77	* Register icon list widget controls.
78	*
79	* Adds different input fields to allow the user to change and customize the widget settings.
80	*
81	* @since 3.1.0
82	* @access protected
83	*/
84	protected function register_controls() {
85	$this->start_controls_section(
86	'section_icon',
87	[
88	'label' => esc_html__( 'Icon List', 'elementor' ),
89	]
90	);
91
92	$this->add_control(
93	'view',
94	[
95	'label' => esc_html__( 'Layout', 'elementor' ),
96	'type' => Controls_Manager::CHOOSE,
97	'default' => 'traditional',
98	'options' => [
99	'traditional' => [
100	'title' => esc_html__( 'Default', 'elementor' ),
101	'icon' => 'eicon-editor-list-ul',
102	],
103	'inline' => [
104	'title' => esc_html__( 'Inline', 'elementor' ),
105	'icon' => 'eicon-ellipsis-h',
106	],
107	],
108	'render_type' => 'template',
109	'classes' => 'elementor-control-start-end',
110	'style_transfer' => true,
111	'prefix_class' => 'elementor-icon-list--layout-',
112	]
113	);
114
115	$repeater = new Repeater();
116
117	$repeater->add_control(
118	'text',
119	[
120	'label' => esc_html__( 'Text', 'elementor' ),
121	'type' => Controls_Manager::TEXT,
122	'label_block' => true,
123	'placeholder' => esc_html__( 'List Item', 'elementor' ),
124	'default' => esc_html__( 'List Item', 'elementor' ),
125	'dynamic' => [
126	'active' => true,
127	],
128	]
129	);
130
131	$repeater->add_control(
132	'selected_icon',
133	[
134	'label' => esc_html__( 'Icon', 'elementor' ),
135	'type' => Controls_Manager::ICONS,
136	'default' => [
137	'value' => 'fas fa-check',
138	'library' => 'fa-solid',
139	],
140	'fa4compatibility' => 'icon',
141	]
142	);
143
144	$repeater->add_control(
145	'link',
146	[
147	'label' => esc_html__( 'Link', 'elementor' ),
148	'type' => Controls_Manager::URL,
149	'dynamic' => [
150	'active' => true,
151	],
152	'placeholder' => esc_html__( 'https://your-link.com', 'elementor' ),
153	]
154	);
155
156	$this->add_control(
157	'icon_list',
158	[
159	'label' => esc_html__( 'Items', 'elementor' ),
160	'type' => Controls_Manager::REPEATER,
161	'fields' => $repeater->get_controls(),
162	'default' => [
163	[
164	'text' => esc_html__( 'List Item #1', 'elementor' ),
165	'selected_icon' => [
166	'value' => 'fas fa-check',
167	'library' => 'fa-solid',
168	],
169	],
170	[
171	'text' => esc_html__( 'List Item #2', 'elementor' ),
172	'selected_icon' => [
173	'value' => 'fas fa-times',
174	'library' => 'fa-solid',
175	],
176	],
177	[
178	'text' => esc_html__( 'List Item #3', 'elementor' ),
179	'selected_icon' => [
180	'value' => 'fas fa-dot-circle',
181	'library' => 'fa-solid',
182	],
183	],
184	],
185	'title_field' => '{{{ elementor.helpers.renderIcon( this, selected_icon, {}, "i", "panel" ) \|\| \'<i class="{{ icon }}" aria-hidden="true"></i>\' }}} {{{ text }}}',
186	]
187	);
188
189	$this->add_control(
190	'link_click',
191	[
192	'label' => esc_html__( 'Apply Link On', 'elementor' ),
193	'type' => Controls_Manager::SELECT,
194	'options' => [
195	'full_width' => esc_html__( 'Full Width', 'elementor' ),
196	'inline' => esc_html__( 'Inline', 'elementor' ),
197	],
198	'default' => 'full_width',
199	'separator' => 'before',
200	'prefix_class' => 'elementor-list-item-link-',
201	]
202	);
203
204	$this->end_controls_section();
205
206	$this->start_controls_section(
207	'section_icon_list',
208	[
209	'label' => esc_html__( 'List', 'elementor' ),
210	'tab' => Controls_Manager::TAB_STYLE,
211	]
212	);
213
214	$this->add_responsive_control(
215	'space_between',
216	[
217	'label' => esc_html__( 'Space Between', 'elementor' ),
218	'type' => Controls_Manager::SLIDER,
219	'range' => [
220	'px' => [
221	'max' => 50,
222	],
223	],
224	'selectors' => [
225	'{{WRAPPER}} .elementor-icon-list-items:not(.elementor-inline-items) .elementor-icon-list-item:not(:last-child)' => 'padding-bottom: calc({{SIZE}}{{UNIT}}/2)',
226	'{{WRAPPER}} .elementor-icon-list-items:not(.elementor-inline-items) .elementor-icon-list-item:not(:first-child)' => 'margin-top: calc({{SIZE}}{{UNIT}}/2)',
227	'{{WRAPPER}} .elementor-icon-list-items.elementor-inline-items .elementor-icon-list-item' => 'margin-right: calc({{SIZE}}{{UNIT}}/2); margin-left: calc({{SIZE}}{{UNIT}}/2)',
228	'{{WRAPPER}} .elementor-icon-list-items.elementor-inline-items' => 'margin-right: calc(-{{SIZE}}{{UNIT}}/2); margin-left: calc(-{{SIZE}}{{UNIT}}/2)',
229	'body.rtl {{WRAPPER}} .elementor-icon-list-items.elementor-inline-items .elementor-icon-list-item:after' => 'left: calc(-{{SIZE}}{{UNIT}}/2)',
230	'body:not(.rtl) {{WRAPPER}} .elementor-icon-list-items.elementor-inline-items .elementor-icon-list-item:after' => 'right: calc(-{{SIZE}}{{UNIT}}/2)',
231	],
232	]
233	);
234
235	$this->add_responsive_control(
236	'icon_align',
237	[
238	'label' => esc_html__( 'Alignment', 'elementor' ),
239	'type' => Controls_Manager::CHOOSE,
240	'options' => [
241	'left' => [
242	'title' => esc_html__( 'Left', 'elementor' ),
243	'icon' => 'eicon-h-align-left',
244	],
245	'center' => [
246	'title' => esc_html__( 'Center', 'elementor' ),
247	'icon' => 'eicon-h-align-center',
248	],
249	'right' => [
250	'title' => esc_html__( 'Right', 'elementor' ),
251	'icon' => 'eicon-h-align-right',
252	],
253	],
254	'prefix_class' => 'elementor%s-align-',
255	]
256	);
257
258	$this->add_control(
259	'divider',
260	[
261	'label' => esc_html__( 'Divider', 'elementor' ),
262	'type' => Controls_Manager::SWITCHER,
263	'label_off' => esc_html__( 'Off', 'elementor' ),
264	'label_on' => esc_html__( 'On', 'elementor' ),
265	'selectors' => [
266	'{{WRAPPER}} .elementor-icon-list-item:not(:last-child):after' => 'content: ""',
267	],
268	'separator' => 'before',
269	]
270	);
271
272	$this->add_control(
273	'divider_style',
274	[
275	'label' => esc_html__( 'Style', 'elementor' ),
276	'type' => Controls_Manager::SELECT,
277	'options' => [
278	'solid' => esc_html__( 'Solid', 'elementor' ),
279	'double' => esc_html__( 'Double', 'elementor' ),
280	'dotted' => esc_html__( 'Dotted', 'elementor' ),
281	'dashed' => esc_html__( 'Dashed', 'elementor' ),
282	],
283	'default' => 'solid',
284	'condition' => [
285	'divider' => 'yes',
286	],
287	'selectors' => [
288	'{{WRAPPER}} .elementor-icon-list-items:not(.elementor-inline-items) .elementor-icon-list-item:not(:last-child):after' => 'border-top-style: {{VALUE}}',
289	'{{WRAPPER}} .elementor-icon-list-items.elementor-inline-items .elementor-icon-list-item:not(:last-child):after' => 'border-left-style: {{VALUE}}',
290	],
291	]
292	);
293
294	$this->add_control(
295	'divider_weight',
296	[
297	'label' => esc_html__( 'Weight', 'elementor' ),
298	'type' => Controls_Manager::SLIDER,
299	'default' => [
300	'size' => 1,
301	],
302	'range' => [
303	'px' => [
304	'min' => 1,
305	'max' => 20,
306	],
307	],
308	'condition' => [
309	'divider' => 'yes',
310	],
311	'selectors' => [
312	'{{WRAPPER}} .elementor-icon-list-items:not(.elementor-inline-items) .elementor-icon-list-item:not(:last-child):after' => 'border-top-width: {{SIZE}}{{UNIT}}',
313	'{{WRAPPER}} .elementor-inline-items .elementor-icon-list-item:not(:last-child):after' => 'border-left-width: {{SIZE}}{{UNIT}}',
314	],
315	]
316	);
317
318	$this->add_control(
319	'divider_width',
320	[
321	'label' => esc_html__( 'Width', 'elementor' ),
322	'type' => Controls_Manager::SLIDER,
323	'size_units' => [ '%', 'px', 'vw' ],
324	'default' => [
325	'unit' => '%',
326	],
327	'condition' => [
328	'divider' => 'yes',
329	'view!' => 'inline',
330	],
331	'selectors' => [
332	'{{WRAPPER}} .elementor-icon-list-item:not(:last-child):after' => 'width: {{SIZE}}{{UNIT}}',
333	],
334	]
335	);
336
337	$this->add_control(
338	'divider_height',
339	[
340	'label' => esc_html__( 'Height', 'elementor' ),
341	'type' => Controls_Manager::SLIDER,
342	'size_units' => [ '%', 'px', 'vh' ],
343	'default' => [
344	'unit' => '%',
345	],
346	'range' => [
347	'px' => [
348	'min' => 1,
349	'max' => 100,
350	],
351	'%' => [
352	'min' => 1,
353	'max' => 100,
354	],
355	'vh' => [
356	'min' => 1,
357	'max' => 100,
358	],
359	],
360	'condition' => [
361	'divider' => 'yes',
362	'view' => 'inline',
363	],
364	'selectors' => [
365	'{{WRAPPER}} .elementor-icon-list-item:not(:last-child):after' => 'height: {{SIZE}}{{UNIT}}',
366	],
367	]
368	);
369
370	$this->add_control(
371	'divider_color',
372	[
373	'label' => esc_html__( 'Color', 'elementor' ),
374	'type' => Controls_Manager::COLOR,
375	'default' => '#ddd',
376	'global' => [
377	'default' => Global_Colors::COLOR_TEXT,
378	],
379	'condition' => [
380	'divider' => 'yes',
381	],
382	'selectors' => [
383	'{{WRAPPER}} .elementor-icon-list-item:not(:last-child):after' => 'border-color: {{VALUE}}',
384	],
385	]
386	);
387
388	$this->end_controls_section();
389
390	$this->start_controls_section(
391	'section_icon_style',
392	[
393	'label' => esc_html__( 'Icon', 'elementor' ),
394	'tab' => Controls_Manager::TAB_STYLE,
395	]
396	);
397
398	$this->add_control(
399	'icon_color',
400	[
401	'label' => esc_html__( 'Color', 'elementor' ),
402	'type' => Controls_Manager::COLOR,
403	'default' => '',
404	'selectors' => [
405	'{{WRAPPER}} .elementor-icon-list-icon i' => 'color: {{VALUE}};',
406	'{{WRAPPER}} .elementor-icon-list-icon svg' => 'fill: {{VALUE}};',
407	],
408	'global' => [
409	'default' => Global_Colors::COLOR_PRIMARY,
410	],
411	]
412	);
413
414	$this->add_control(
415	'icon_color_hover',
416	[
417	'label' => esc_html__( 'Hover', 'elementor' ),
418	'type' => Controls_Manager::COLOR,
419	'default' => '',
420	'selectors' => [
421	'{{WRAPPER}} .elementor-icon-list-item:hover .elementor-icon-list-icon i' => 'color: {{VALUE}};',
422	'{{WRAPPER}} .elementor-icon-list-item:hover .elementor-icon-list-icon svg' => 'fill: {{VALUE}};',
423	],
424	]
425	);
426
427	$this->add_responsive_control(
428	'icon_size',
429	[
430	'label' => esc_html__( 'Size', 'elementor' ),
431	'type' => Controls_Manager::SLIDER,
432	'size_units' => [ 'px', '%', 'vw' ],
433	'default' => [
434	'unit' => 'px',
435	'size' => 14,
436	],
437	'range' => [
438	'px' => [
439	'min' => 6,
440	],
441	'%' => [
442	'min' => 6,
443	],
444	'vw' => [
445	'min' => 6,
446	],
447	],
448	'selectors' => [
449	'{{WRAPPER}}' => '--e-icon-list-icon-size: {{SIZE}}{{UNIT}};',
450	],
451	]
452	);
453
454	$e_icon_list_icon_css_var = 'var(--e-icon-list-icon-size, 1em)';
455	$e_icon_list_icon_align_left = sprintf( '0 calc(%s * 0.25) 0 0', $e_icon_list_icon_css_var );
456	$e_icon_list_icon_align_center = sprintf( '0 calc(%s * 0.125)', $e_icon_list_icon_css_var );
457	$e_icon_list_icon_align_right = sprintf( '0 0 0 calc(%s * 0.25)', $e_icon_list_icon_css_var );
458
459	$this->add_responsive_control(
460	'icon_self_align',
461	[
462	'label' => esc_html__( 'Alignment', 'elementor' ),
463	'type' => Controls_Manager::CHOOSE,
464	'options' => [
465	'left' => [
466	'title' => esc_html__( 'Left', 'elementor' ),
467	'icon' => 'eicon-h-align-left',
468	],
469	'center' => [
470	'title' => esc_html__( 'Center', 'elementor' ),
471	'icon' => 'eicon-h-align-center',
472	],
473	'right' => [
474	'title' => esc_html__( 'Right', 'elementor' ),
475	'icon' => 'eicon-h-align-right',
476	],
477	],
478	'default' => '',
479	'selectors_dictionary' => [
480	'left' => sprintf( '--e-icon-list-icon-align: left; --e-icon-list-icon-margin: %s;', $e_icon_list_icon_align_left ),
481	'center' => sprintf( '--e-icon-list-icon-align: center; --e-icon-list-icon-margin: %s;', $e_icon_list_icon_align_center ),
482	'right' => sprintf( '--e-icon-list-icon-align: right; --e-icon-list-icon-margin: %s;', $e_icon_list_icon_align_right ),
483	],
484	'selectors' => [
485	'{{WRAPPER}}' => '{{VALUE}}',
486	],
487	]
488	);
489
490	$this->end_controls_section();
491
492	$this->start_controls_section(
493	'section_text_style',
494	[
495	'label' => esc_html__( 'Text', 'elementor' ),
496	'tab' => Controls_Manager::TAB_STYLE,
497	]
498	);
499
500	$this->add_control(
501	'text_color',
502	[
503	'label' => esc_html__( 'Text Color', 'elementor' ),
504	'type' => Controls_Manager::COLOR,
505	'default' => '',
506	'selectors' => [
507	'{{WRAPPER}} .elementor-icon-list-text' => 'color: {{VALUE}};',
508	],
509	'global' => [
510	'default' => Global_Colors::COLOR_SECONDARY,
511	],
512	]
513	);
514
515	$this->add_control(
516	'text_color_hover',
517	[
518	'label' => esc_html__( 'Hover', 'elementor' ),
519	'type' => Controls_Manager::COLOR,
520	'default' => '',
521	'selectors' => [
522	'{{WRAPPER}} .elementor-icon-list-item:hover .elementor-icon-list-text' => 'color: {{VALUE}};',
523	],
524	]
525	);
526
527	$this->add_control(
528	'text_indent',
529	[
530	'label' => esc_html__( 'Text Indent', 'elementor' ),
531	'type' => Controls_Manager::SLIDER,
532	'range' => [
533	'px' => [
534	'max' => 50,
535	],
536	],
537	'selectors' => [
538	'{{WRAPPER}} .elementor-icon-list-text' => is_rtl() ? 'padding-right: {{SIZE}}{{UNIT}};' : 'padding-left: {{SIZE}}{{UNIT}};',
539	],
540	]
541	);
542
543	$this->add_group_control(
544	Group_Control_Typography::get_type(),
545	[
546	'name' => 'icon_typography',
547	'selector' => '{{WRAPPER}} .elementor-icon-list-item > .elementor-icon-list-text, {{WRAPPER}} .elementor-icon-list-item > a',
548	'global' => [
549	'default' => Global_Typography::TYPOGRAPHY_TEXT,
550	],
551	]
552	);
553
554	$this->add_group_control(
555	Group_Control_Text_Shadow::get_type(),
556	[
557	'name' => 'text_shadow',
558	'selector' => '{{WRAPPER}} .elementor-icon-list-text',
559	]
560	);
561
562	$this->end_controls_section();
563	}
564
565	/**
566	* Render icon list widget output on the frontend.
567	*
568	* Written in PHP and used to generate the final HTML.
569	*
570	* @since 1.0.0
571	* @access protected
572	*/
573	protected function render() {
574	$settings = $this->get_settings_for_display();
575	$fallback_defaults = [
576	'fa fa-check',
577	'fa fa-times',
578	'fa fa-dot-circle-o',
579	];
580
581	$this->add_render_attribute( 'icon_list', 'class', 'elementor-icon-list-items' );
582	$this->add_render_attribute( 'list_item', 'class', 'elementor-icon-list-item' );
583
584	if ( 'inline' === $settings['view'] ) {
585	$this->add_render_attribute( 'icon_list', 'class', 'elementor-inline-items' );
586	$this->add_render_attribute( 'list_item', 'class', 'elementor-inline-item' );
587	}
588	?>
589	<ul <?php $this->print_render_attribute_string( 'icon_list' ); ?>>
590	<?php
591	foreach ( $settings['icon_list'] as $index => $item ) :
592	$repeater_setting_key = $this->get_repeater_setting_key( 'text', 'icon_list', $index );
593
594	$this->add_render_attribute( $repeater_setting_key, 'class', 'elementor-icon-list-text' );
595
596	$this->add_inline_editing_attributes( $repeater_setting_key );
597	$migration_allowed = Icons_Manager::is_migration_allowed();
598	?>
599	<li <?php $this->print_render_attribute_string( 'list_item' ); ?>>
600	<?php
601	if ( ! empty( $item['link']['url'] ) ) {
602	$link_key = 'link_' . $index;
603
604	$this->add_link_attributes( $link_key, $item['link'] );
605	?>
606	<a <?php $this->print_render_attribute_string( $link_key ); ?>>
607
608	<?php
609	}
610
611	// add old default
612	if ( ! isset( $item['icon'] ) && ! $migration_allowed ) {
613	$item['icon'] = isset( $fallback_defaults[ $index ] ) ? $fallback_defaults[ $index ] : 'fa fa-check';
614	}
615
616	$migrated = isset( $item['__fa4_migrated']['selected_icon'] );
617	$is_new = ! isset( $item['icon'] ) && $migration_allowed;
618	if ( ! empty( $item['icon'] ) \|\| ( ! empty( $item['selected_icon']['value'] ) && $is_new ) ) :
619	?>
620	<span class="elementor-icon-list-icon">
621	<?php
622	if ( $is_new \|\| $migrated ) {
623	Icons_Manager::render_icon( $item['selected_icon'], [ 'aria-hidden' => 'true' ] );
624	} else { ?>
625	<i class="<?php echo esc_attr( $item['icon'] ); ?>" aria-hidden="true"></i>
626	<?php } ?>
627	</span>
628	<?php endif; ?>
629	<span <?php $this->print_render_attribute_string( $repeater_setting_key ); ?>><?php $this->print_unescaped_setting( 'text', 'icon_list', $index ); ?></span>
630	<?php if ( ! empty( $item['link']['url'] ) ) : ?>
631	</a>
632	<?php endif; ?>
633	</li>
634	<?php
635	endforeach;
636	?>
637	</ul>
638	<?php
639	}
640
641	/**
642	* Render icon list widget output in the editor.
643	*
644	* Written as a Backbone JavaScript template and used to generate the live preview.
645	*
646	* @since 2.9.0
647	* @access protected
648	*/
649	protected function content_template() {
650	?>
651	<#
652	view.addRenderAttribute( 'icon_list', 'class', 'elementor-icon-list-items' );
653	view.addRenderAttribute( 'list_item', 'class', 'elementor-icon-list-item' );
654
655	if ( 'inline' == settings.view ) {
656	view.addRenderAttribute( 'icon_list', 'class', 'elementor-inline-items' );
657	view.addRenderAttribute( 'list_item', 'class', 'elementor-inline-item' );
658	}
659	var iconsHTML = {},
660	migrated = {};
661	#>
662	<# if ( settings.icon_list ) { #>
663	<ul {{{ view.getRenderAttributeString( 'icon_list' ) }}}>
664	<# _.each( settings.icon_list, function( item, index ) {
665
666	var iconTextKey = view.getRepeaterSettingKey( 'text', 'icon_list', index );
667
668	view.addRenderAttribute( iconTextKey, 'class', 'elementor-icon-list-text' );
669
670	view.addInlineEditingAttributes( iconTextKey ); #>
671
672	<li {{{ view.getRenderAttributeString( 'list_item' ) }}}>
673	<# if ( item.link && item.link.url ) { #>
674	<a href="{{ item.link.url }}">
675	<# } #>
676	<# if ( item.icon \|\| item.selected_icon.value ) { #>
677	<span class="elementor-icon-list-icon">
678	<#
679	iconsHTML[ index ] = elementor.helpers.renderIcon( view, item.selected_icon, { 'aria-hidden': true }, 'i', 'object' );
680	migrated[ index ] = elementor.helpers.isIconMigrated( item, 'selected_icon' );
681	if ( iconsHTML[ index ] && iconsHTML[ index ].rendered && ( ! item.icon \|\| migrated[ index ] ) ) { #>
682	{{{ iconsHTML[ index ].value }}}
683	<# } else { #>
684	<i class="{{ item.icon }}" aria-hidden="true"></i>
685	<# }
686	#>
687	</span>
688	<# } #>
689	<span {{{ view.getRenderAttributeString( iconTextKey ) }}}>{{{ item.text }}}</span>
690	<# if ( item.link && item.link.url ) { #>
691	</a>
692	<# } #>
693	</li>
694	<#
695	} ); #>
696	</ul>
697	<# } #>
698
699	<?php
700	}
701
702	public function on_import( $element ) {
703	return Icons_Manager::on_import_migration( $element, 'icon', 'selected_icon', true );
704	}
705	}
706