<?php
namespace ElementorPro\Modules\Carousel\Widgets;
use Elementor\Controls_Manager;
use Elementor\Group_Control_Image_Size;
use Elementor\Icons_Manager;
use Elementor\Repeater;
use ElementorPro\Base\Base_Widget;
use ElementorPro\Plugin;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
abstract class Base extends Base_Widget {
private $slide_prints_count = 0;
public function get_script_depends() {
return [ 'imagesloaded' ];
}
abstract protected function add_repeater_controls( Repeater $repeater );
abstract protected function get_repeater_defaults();
abstract protected function print_slide( array $slide, array $settings, $element_key );
protected function register_controls() {
$this->start_controls_section(
'section_slides',
[
'label' => esc_html__( 'Slides', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_CONTENT,
]
);
$repeater = new Repeater();
$this->add_repeater_controls( $repeater );
$this->add_control(
'slides',
[
'label' => esc_html__( 'Slides', 'elementor-pro' ),
'type' => Controls_Manager::REPEATER,
'fields' => $repeater->get_controls(),
'default' => $this->get_repeater_defaults(),
'separator' => 'after',
]
);
$this->add_control(
'effect',
[
'type' => Controls_Manager::SELECT,
'label' => esc_html__( 'Effect', 'elementor-pro' ),
'default' => 'slide',
'options' => [
'slide' => esc_html__( 'Slide', 'elementor-pro' ),
'fade' => esc_html__( 'Fade', 'elementor-pro' ),
'cube' => esc_html__( 'Cube', 'elementor-pro' ),
],
'frontend_available' => true,
]
);
$slides_per_view = range( 1, 10 );
$slides_per_view = array_combine( $slides_per_view, $slides_per_view );
$this->add_responsive_control(
'slides_per_view',
[
'type' => Controls_Manager::SELECT,
'label' => esc_html__( 'Slides Per View', 'elementor-pro' ),
'options' => [ '' => esc_html__( 'Default', 'elementor-pro' ) ] + $slides_per_view,
'inherit_placeholders' => false,
'condition' => [
'effect' => 'slide',
],
'frontend_available' => true,
]
);
$this->add_responsive_control(
'slides_to_scroll',
[
'type' => Controls_Manager::SELECT,
'label' => esc_html__( 'Slides to Scroll', 'elementor-pro' ),
'description' => esc_html__( 'Set how many slides are scrolled per swipe.', 'elementor-pro' ),
'options' => [ '' => esc_html__( 'Default', 'elementor-pro' ) ] + $slides_per_view,
'inherit_placeholders' => false,
'condition' => [
'effect' => 'slide',
],
'frontend_available' => true,
]
);
$this->add_responsive_control(
'height',
[
'type' => Controls_Manager::SLIDER,
'label' => esc_html__( 'Height', 'elementor-pro' ),
'size_units' => [ 'px', 'em', 'rem', 'vh', 'custom' ],
'range' => [
'px' => [
'min' => 100,
'max' => 1000,
],
'vh' => [
'min' => 20,
],
],
'selectors' => [
'{{WRAPPER}} .elementor-main-swiper' => 'height: {{SIZE}}{{UNIT}};',
],
]
);
$this->add_responsive_control(
'width',
[
'type' => Controls_Manager::SLIDER,
'label' => esc_html__( 'Width', 'elementor-pro' ),
'size_units' => [ 'px', '%', 'em', 'rem', 'vw', 'custom' ],
'range' => [
'px' => [
'min' => 100,
'max' => 1140,
],
'%' => [
'min' => 50,
],
],
'default' => [
'unit' => '%',
],
'selectors' => [
'{{WRAPPER}} .elementor-main-swiper' => 'width: {{SIZE}}{{UNIT}};',
],
]
);
$this->end_controls_section();
$this->start_controls_section(
'section_additional_options',
[
'label' => esc_html__( 'Additional Options', 'elementor-pro' ),
]
);
$this->add_control(
'show_arrows',
[
'type' => Controls_Manager::SWITCHER,
'label' => esc_html__( 'Arrows', 'elementor-pro' ),
'default' => 'yes',
'label_off' => esc_html__( 'Hide', 'elementor-pro' ),
'label_on' => esc_html__( 'Show', 'elementor-pro' ),
'prefix_class' => 'elementor-arrows-',
'render_type' => 'template',
'frontend_available' => true,
]
);
$this->add_control(
'pagination',
[
'label' => esc_html__( 'Pagination', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'default' => 'bullets',
'options' => [
'' => esc_html__( 'None', 'elementor-pro' ),
'bullets' => esc_html__( 'Dots', 'elementor-pro' ),
'fraction' => esc_html__( 'Fraction', 'elementor-pro' ),
'progressbar' => esc_html__( 'Progress', 'elementor-pro' ),
],
'prefix_class' => 'elementor-pagination-type-',
'render_type' => 'template',
'frontend_available' => true,
]
);
$this->add_control(
'speed',
[
'label' => esc_html__( 'Transition Duration', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => 500,
'render_type' => 'none',
'frontend_available' => true,
]
);
$this->add_control(
'autoplay',
[
'label' => esc_html__( 'Autoplay', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'default' => 'yes',
'separator' => 'before',
'render_type' => 'none',
'frontend_available' => true,
]
);
$this->add_control(
'autoplay_speed',
[
'label' => esc_html__( 'Autoplay Speed', 'elementor-pro' ),
'type' => Controls_Manager::NUMBER,
'default' => 5000,
'condition' => [
'autoplay' => 'yes',
],
'render_type' => 'none',
'frontend_available' => true,
]
);
$this->add_control(
'loop',
[
'label' => esc_html__( 'Infinite Loop', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'default' => 'yes',
'frontend_available' => true,
]
);
$this->add_control(
'pause_on_hover',
[
'label' => esc_html__( 'Pause on Hover', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'default' => 'yes',
'condition' => [
'autoplay' => 'yes',
],
'render_type' => 'none',
'frontend_available' => true,
]
);
$this->add_control(
'pause_on_interaction',
[
'label' => esc_html__( 'Pause on Interaction', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'default' => 'yes',
'condition' => [
'autoplay' => 'yes',
],
'render_type' => 'none',
'frontend_available' => true,
]
);
$this->add_group_control(
Group_Control_Image_Size::get_type(),
[
'name' => 'image_size',
'default' => 'full',
'separator' => 'before',
]
);
$this->add_control(
'lazyload',
[
'label' => esc_html__( 'Lazyload', 'elementor-pro' ),
'type' => Controls_Manager::SWITCHER,
'separator' => 'before',
'frontend_available' => true,
]
);
$this->end_controls_section();
$this->start_controls_section(
'section_slides_style',
[
'label' => esc_html__( 'Slides', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_STYLE,
]
);
$space_between_config = [
'label' => esc_html__( 'Space Between', 'elementor-pro' ),
'type' => Controls_Manager::SLIDER,
'range' => [
'px' => [
'max' => 50,
],
],
'render_type' => 'none',
'frontend_available' => true,
];
// TODO: Once Core 3.4.0 is out, get the active devices using Breakpoints/Manager::get_active_devices_list().
$active_breakpoint_instances = Plugin::elementor()->breakpoints->get_active_breakpoints();
// Devices need to be ordered from largest to smallest.
$active_devices = array_reverse( array_keys( $active_breakpoint_instances ) );
// Add desktop in the correct position.
if ( in_array( 'widescreen', $active_devices, true ) ) {
$active_devices = array_merge( array_slice( $active_devices, 0, 1 ), [ 'desktop' ], array_slice( $active_devices, 1 ) );
} else {
$active_devices = array_merge( [ 'desktop' ], $active_devices );
}
foreach ( $active_devices as $active_device ) {
$space_between_config[ $active_device . '_default' ] = [
'size' => 10,
];
}
$this->add_responsive_control(
'space_between',
$space_between_config
);
$this->add_control(
'slide_background_color',
[
'label' => esc_html__( 'Background Color', 'elementor-pro' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}} .elementor-main-swiper .swiper-slide' => 'background-color: {{VALUE}}',
],
]
);
$this->add_control(
'slide_border_size',
[
'label' => esc_html__( 'Border Width', 'elementor-pro' ),
'type' => Controls_Manager::DIMENSIONS,
'size_units' => [ 'px', '%', 'em', 'rem', 'vw', 'custom' ],
'selectors' => [
'{{WRAPPER}} .elementor-main-swiper .swiper-slide' => 'border-width: {{TOP}}{{UNIT}} {{RIGHT}}{{UNIT}} {{BOTTOM}}{{UNIT}} {{LEFT}}{{UNIT}}',
],
]
);
$this->add_control(
'slide_border_radius',
[
'label' => esc_html__( 'Border Radius', 'elementor-pro' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', '%', 'em', 'rem', 'custom' ],
'range' => [
'%' => [
'max' => 50,
],
],
'selectors' => [
'{{WRAPPER}} .elementor-main-swiper .swiper-slide' => 'border-radius: {{SIZE}}{{UNIT}}',
],
]
);
$this->add_control(
'slide_border_color',
[
'label' => esc_html__( 'Border Color', 'elementor-pro' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}} .elementor-main-swiper .swiper-slide' => 'border-color: {{VALUE}}',
],
]
);
$this->add_control(
'slide_padding',
[
'label' => esc_html__( 'Padding', 'elementor-pro' ),
'type' => Controls_Manager::DIMENSIONS,
'size_units' => [ 'px', '%', 'em', 'rem', 'vw', 'custom' ],
'selectors' => [
'{{WRAPPER}} .elementor-main-swiper .swiper-slide' => 'padding: {{TOP}}{{UNIT}} {{RIGHT}}{{UNIT}} {{BOTTOM}}{{UNIT}} {{LEFT}}{{UNIT}}',
],
'separator' => 'before',
]
);
$this->end_controls_section();
$this->start_controls_section(
'section_navigation',
[
'label' => esc_html__( 'Navigation', 'elementor-pro' ),
'tab' => Controls_Manager::TAB_STYLE,
]
);
$this->add_control(
'heading_arrows',
[
'label' => esc_html__( 'Arrows', 'elementor-pro' ),
'type' => Controls_Manager::HEADING,
'separator' => 'none',
]
);
$this->add_control(
'arrows_size',
[
'label' => esc_html__( 'Size', 'elementor-pro' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', 'em', 'rem', 'custom' ],
'default' => [
'size' => 20,
],
'range' => [
'px' => [
'min' => 10,
],
],
'selectors' => [
'{{WRAPPER}} .elementor-swiper-button' => 'font-size: {{SIZE}}{{UNIT}}',
],
]
);
$this->add_control(
'arrows_color',
[
'label' => esc_html__( 'Color', 'elementor-pro' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}} .elementor-swiper-button' => 'color: {{VALUE}}',
'{{WRAPPER}} .elementor-swiper-button svg' => 'fill: {{VALUE}}',
],
]
);
$this->add_control(
'heading_pagination',
[
'label' => esc_html__( 'Pagination', 'elementor-pro' ),
'type' => Controls_Manager::HEADING,
'condition' => [
'pagination!' => '',
],
]
);
$this->add_control(
'pagination_position',
[
'label' => esc_html__( 'Position', 'elementor-pro' ),
'type' => Controls_Manager::SELECT,
'default' => 'outside',
'options' => [
'outside' => esc_html__( 'Outside', 'elementor-pro' ),
'inside' => esc_html__( 'Inside', 'elementor-pro' ),
],
'prefix_class' => 'elementor-pagination-position-',
'condition' => [
'pagination!' => '',
],
]
);
$swiper_class = Plugin::elementor()->experiments->is_feature_active( 'e_swiper_latest' ) ? 'swiper' : 'swiper-container';
$this->add_control(
'pagination_size',
[
'label' => esc_html__( 'Size', 'elementor-pro' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', 'em', 'rem', 'custom' ],
'range' => [
'px' => [
'max' => 20,
],
],
'selectors' => [
'{{WRAPPER}} .swiper-pagination-bullet' => 'height: {{SIZE}}{{UNIT}}; width: {{SIZE}}{{UNIT}}',
'{{WRAPPER}} .' . $swiper_class . '-horizontal .swiper-pagination-progressbar' => 'height: {{SIZE}}{{UNIT}}',
'{{WRAPPER}} .swiper-pagination-fraction' => 'font-size: {{SIZE}}{{UNIT}}',
],
'condition' => [
'pagination!' => '',
],
]
);
$this->add_control(
'pagination_color_inactive',
[
'label' => esc_html__( 'Color', 'elementor-pro' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
// The opacity property will override the default inactive dot color which is opacity 0.2.
'{{WRAPPER}} .swiper-pagination-bullet:not(.swiper-pagination-bullet-active)' => 'background-color: {{VALUE}}; opacity: 1;',
],
'condition' => [
'pagination!' => '',
],
]
);
$this->add_control(
'pagination_color',
[
'label' => esc_html__( 'Active Color', 'elementor-pro' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}} .swiper-pagination-bullet-active, {{WRAPPER}} .swiper-pagination-progressbar-fill' => 'background-color: {{VALUE}}',
'{{WRAPPER}} .swiper-pagination-fraction' => 'color: {{VALUE}}',
],
'condition' => [
'pagination!' => '',
],
]
);
$this->end_controls_section();
}
protected function print_slider( array $settings = null ) {
if ( null === $settings ) {
$settings = $this->get_settings_for_display();
}
$default_settings = [
'container_class' => 'elementor-main-swiper',
'video_play_icon' => true,
];
$settings = array_merge( $default_settings, $settings );
$slides_count = count( $settings['slides'] );
$swiper_class = Plugin::elementor()->experiments->is_feature_active( 'e_swiper_latest' ) ? 'swiper' : 'swiper-container';
?>
<div class="elementor-swiper">
<div class="<?php echo esc_attr( $settings['container_class'] ); ?> <?php echo esc_attr( $swiper_class ); ?>">
<div class="swiper-wrapper">
<?php
foreach ( $settings['slides'] as $index => $slide ) :
$this->slide_prints_count++;
?>
<div class="swiper-slide">
<?php $this->print_slide( $slide, $settings, 'slide-' . $index . '-' . $this->slide_prints_count ); ?>
</div>
<?php endforeach; ?>
</div>
<?php if ( 1 < $slides_count ) : ?>
<?php if ( $settings['pagination'] ) : ?>
<div class="swiper-pagination"></div>
<?php endif; ?>
<?php if ( $settings['show_arrows'] ) : ?>
<div class="elementor-swiper-button elementor-swiper-button-prev" role="button" tabindex="0">
<?php $this->render_swiper_button( 'previous' ); ?>
<span class="elementor-screen-only"><?php echo esc_html__( 'Previous', 'elementor-pro' ); ?></span>
</div>
<div class="elementor-swiper-button elementor-swiper-button-next" role="button" tabindex="0">
<?php $this->render_swiper_button( 'next' ); ?>
<span class="elementor-screen-only"><?php echo esc_html__( 'Next', 'elementor-pro' ); ?></span>
</div>
<?php endif; ?>
<?php endif; ?>
</div>
</div>
<?php
}
protected function get_slide_image_url( $slide, array $settings ) {
$image_url = Group_Control_Image_Size::get_attachment_image_src( $slide['image']['id'], 'image_size', $settings );
if ( ! $image_url ) {
$image_url = $slide['image']['url'];
}
return $image_url;
}
protected function get_slide_image_alt_attribute( $slide ) {
if ( ! empty( $slide['name'] ) ) {
return $slide['name'];
}
if ( ! empty( $slide['image']['alt'] ) ) {
return $slide['image']['alt'];
}
return '';
}
private function render_swiper_button( $type ) {
$direction = 'next' === $type ? 'right' : 'left';
if ( is_rtl() ) {
$direction = 'right' === $direction ? 'left' : 'right';
}
$icon_value = 'eicon-chevron-' . $direction;
Icons_Manager::render_icon( [
'library' => 'eicons',
'value' => $icon_value,
], [ 'aria-hidden' => 'true' ] );
}
}