<?php
namespace Elementor;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
use Elementor\Core\Kits\Documents\Tabs\Global_Colors;
use Elementor\Core\Kits\Documents\Tabs\Global_Typography;
/**
* Elementor text editor widget.
*
* Elementor widget that displays a WYSIWYG text editor, just like the WordPress
* editor.
*
* @since 1.0.0
*/
class Widget_Text_Editor extends Widget_Base {
/**
* Get widget name.
*
* Retrieve text editor widget name.
*
* @since 1.0.0
* @access public
*
* @return string Widget name.
*/
public function get_name() {
return 'text-editor';
}
/**
* Get widget title.
*
* Retrieve text editor widget title.
*
* @since 1.0.0
* @access public
*
* @return string Widget title.
*/
public function get_title() {
return esc_html__( 'Text Editor', 'elementor' );
}
/**
* Get widget icon.
*
* Retrieve text editor widget icon.
*
* @since 1.0.0
* @access public
*
* @return string Widget icon.
*/
public function get_icon() {
return 'eicon-text';
}
/**
* Get widget categories.
*
* Retrieve the list of categories the text editor widget belongs to.
*
* Used to determine where to display the widget in the editor.
*
* @since 2.0.0
* @access public
*
* @return array Widget categories.
*/
public function get_categories() {
return [ 'basic' ];
}
/**
* Get widget keywords.
*
* Retrieve the list of keywords the widget belongs to.
*
* @since 2.1.0
* @access public
*
* @return array Widget keywords.
*/
public function get_keywords() {
return [ 'text', 'editor' ];
}
/**
* Get style dependencies.
*
* Retrieve the list of style dependencies the widget requires.
*
* The 'widget-text-editor' style is required only when the drop cap is used.
* Therefor, style should not be loaded on the widget level, rather only on
* control level when the drop cap is active.
*
* Only in the Editor, these style should be loaded on the widget level.
*
* @since 3.24.0
* @access public
*
* @return array Widget style dependencies.
*/
public function get_style_depends(): array {
$style_dependencies = Plugin::$instance->editor->is_edit_mode() || Plugin::$instance->preview->is_preview_mode()
? [ 'widget-text-editor' ]
: [];
return $style_dependencies;
}
public function has_widget_inner_wrapper(): bool {
return ! Plugin::$instance->experiments->is_feature_active( 'e_optimized_markup' );
}
/**
* Register text editor widget controls.
*
* Adds different input fields to allow the user to change and customize the widget settings.
*
* @since 3.1.0
* @access protected
*/
protected function register_controls() {
$this->start_controls_section(
'section_editor',
[
'label' => esc_html__( 'Text Editor', 'elementor' ),
]
);
$this->add_control(
'editor',
[
'label' => '',
'type' => Controls_Manager::WYSIWYG,
'default' => '<p>' . esc_html__( 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut elit tellus, luctus nec ullamcorper mattis, pulvinar dapibus leo.', 'elementor' ) . '</p>',
]
);
$this->add_control(
'drop_cap', [
'label' => esc_html__( 'Drop Cap', 'elementor' ),
'type' => Controls_Manager::SWITCHER,
'label_off' => esc_html__( 'Off', 'elementor' ),
'label_on' => esc_html__( 'On', 'elementor' ),
'prefix_class' => 'elementor-drop-cap-',
'frontend_available' => true,
'assets' => [
'styles' => [
[
'name' => 'widget-text-editor',
'conditions' => [
'terms' => [
[
'name' => 'drop_cap',
'operator' => '===',
'value' => 'yes',
],
],
],
],
],
],
]
);
$this->add_responsive_control(
'text_columns',
[
'label' => esc_html__( 'Columns', 'elementor' ),
'type' => Controls_Manager::SELECT,
'separator' => 'before',
'options' => [
'' => esc_html__( 'Default', 'elementor' ),
'1' => esc_html__( '1', 'elementor' ),
'2' => esc_html__( '2', 'elementor' ),
'3' => esc_html__( '3', 'elementor' ),
'4' => esc_html__( '4', 'elementor' ),
'5' => esc_html__( '5', 'elementor' ),
'6' => esc_html__( '6', 'elementor' ),
'7' => esc_html__( '7', 'elementor' ),
'8' => esc_html__( '8', 'elementor' ),
'9' => esc_html__( '9', 'elementor' ),
'10' => esc_html__( '10', 'elementor' ),
],
'selectors' => [
'{{WRAPPER}}' => 'columns: {{VALUE}};',
],
]
);
$this->add_responsive_control(
'column_gap',
[
'label' => esc_html__( 'Columns Gap', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', '%', 'em', 'rem', 'vw', 'custom' ],
'range' => [
'px' => [
'max' => 100,
],
'%' => [
'max' => 10,
'step' => 0.1,
],
'vw' => [
'max' => 10,
'step' => 0.1,
],
'em' => [
'max' => 10,
],
'rem' => [
'max' => 10,
],
],
'selectors' => [
'{{WRAPPER}}' => 'column-gap: {{SIZE}}{{UNIT}};',
],
'conditions' => [
'relation' => 'or',
'terms' => [
[
'name' => 'text_columns',
'operator' => '>',
'value' => 1,
],
[
'name' => 'text_columns',
'operator' => '===',
'value' => '',
],
],
],
]
);
$this->end_controls_section();
$this->start_controls_section(
'section_style',
[
'label' => esc_html__( 'Text Editor', 'elementor' ),
'tab' => Controls_Manager::TAB_STYLE,
]
);
$this->add_responsive_control(
'align',
[
'label' => esc_html__( 'Alignment', 'elementor' ),
'type' => Controls_Manager::CHOOSE,
'options' => [
'start' => [
'title' => esc_html__( 'Start', 'elementor' ),
'icon' => 'eicon-text-align-left',
],
'center' => [
'title' => esc_html__( 'Center', 'elementor' ),
'icon' => 'eicon-text-align-center',
],
'end' => [
'title' => esc_html__( 'End', 'elementor' ),
'icon' => 'eicon-text-align-right',
],
'justify' => [
'title' => esc_html__( 'Justified', 'elementor' ),
'icon' => 'eicon-text-align-justify',
],
],
'classes' => 'elementor-control-start-end',
'selectors_dictionary' => [
'left' => is_rtl() ? 'end' : 'start',
'right' => is_rtl() ? 'start' : 'end',
],
'selectors' => [
'{{WRAPPER}}' => 'text-align: {{VALUE}};',
],
'separator' => 'after',
]
);
$this->add_group_control(
Group_Control_Typography::get_type(),
[
'name' => 'typography',
'global' => [
'default' => Global_Typography::TYPOGRAPHY_TEXT,
],
]
);
$this->add_group_control(
Group_Control_Text_Shadow::get_type(),
[
'name' => 'text_shadow',
'selector' => '{{WRAPPER}}',
]
);
$this->add_responsive_control(
'paragraph_spacing',
[
'label' => esc_html__( 'Paragraph Spacing', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', 'em', 'rem', 'vh', 'custom' ],
'range' => [
'px' => [
'max' => 100,
],
'em' => [
'min' => 0.1,
'max' => 20,
],
],
'selectors' => [
'{{WRAPPER}} p' => 'margin-block-end: {{SIZE}}{{UNIT}}',
],
]
);
$this->add_control(
'separator',
[
'type' => Controls_Manager::DIVIDER,
]
);
$this->start_controls_tabs( 'link_colors' );
$this->start_controls_tab(
'colors_normal',
[
'label' => esc_html__( 'Normal', 'elementor' ),
]
);
$this->add_control(
'text_color',
[
'label' => esc_html__( 'Text Color', 'elementor' ),
'type' => Controls_Manager::COLOR,
'default' => '',
'selectors' => [
'{{WRAPPER}}' => 'color: {{VALUE}};',
],
'global' => [
'default' => Global_Colors::COLOR_TEXT,
],
]
);
$this->add_control(
'link_color',
[
'label' => esc_html__( 'Link Color', 'elementor' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}} a' => 'color: {{VALUE}};',
],
]
);
$this->end_controls_tab();
$this->start_controls_tab(
'colors_hover',
[
'label' => esc_html__( 'Hover', 'elementor' ),
]
);
$this->add_control(
'link_hover_color',
[
'label' => esc_html__( 'Link Color', 'elementor' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}} a:hover, {{WRAPPER}} a:focus' => 'color: {{VALUE}};',
],
]
);
$this->add_control(
'link_hover_color_transition_duration',
[
'label' => esc_html__( 'Transition Duration', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 's', 'ms', 'custom' ],
'default' => [
'unit' => 's',
],
'selectors' => [
'{{WRAPPER}} a' => 'transition-duration: {{SIZE}}{{UNIT}};',
],
]
);
$this->end_controls_tab();
$this->end_controls_tabs();
$this->end_controls_section();
$this->start_controls_section(
'section_drop_cap',
[
'label' => esc_html__( 'Drop Cap', 'elementor' ),
'tab' => Controls_Manager::TAB_STYLE,
'condition' => [
'drop_cap' => 'yes',
],
]
);
$this->add_control(
'drop_cap_view',
[
'label' => esc_html__( 'View', 'elementor' ),
'type' => Controls_Manager::SELECT,
'options' => [
'default' => esc_html__( 'Default', 'elementor' ),
'stacked' => esc_html__( 'Stacked', 'elementor' ),
'framed' => esc_html__( 'Framed', 'elementor' ),
],
'default' => 'default',
'prefix_class' => 'elementor-drop-cap-view-',
]
);
$this->add_control(
'drop_cap_primary_color',
[
'label' => esc_html__( 'Primary Color', 'elementor' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}}.elementor-drop-cap-view-stacked .elementor-drop-cap' => 'background-color: {{VALUE}};',
'{{WRAPPER}}.elementor-drop-cap-view-framed .elementor-drop-cap, {{WRAPPER}}.elementor-drop-cap-view-default .elementor-drop-cap' => 'color: {{VALUE}}; border-color: {{VALUE}};',
],
'global' => [
'default' => Global_Colors::COLOR_PRIMARY,
],
]
);
$this->add_control(
'drop_cap_secondary_color',
[
'label' => esc_html__( 'Secondary Color', 'elementor' ),
'type' => Controls_Manager::COLOR,
'selectors' => [
'{{WRAPPER}}.elementor-drop-cap-view-framed .elementor-drop-cap' => 'background-color: {{VALUE}};',
'{{WRAPPER}}.elementor-drop-cap-view-stacked .elementor-drop-cap' => 'color: {{VALUE}};',
],
'condition' => [
'drop_cap_view!' => 'default',
],
]
);
$this->add_group_control(
Group_Control_Text_Shadow::get_type(),
[
'name' => 'drop_cap_shadow',
'selector' => '{{WRAPPER}} .elementor-drop-cap',
]
);
$this->add_control(
'drop_cap_size',
[
'label' => esc_html__( 'Size', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', 'em', 'rem', 'custom' ],
'default' => [
'size' => 5,
],
'range' => [
'px' => [
'max' => 30,
],
'em' => [
'max' => 3,
],
'rem' => [
'max' => 3,
],
],
'selectors' => [
'{{WRAPPER}} .elementor-drop-cap' => 'padding: {{SIZE}}{{UNIT}};',
],
'condition' => [
'drop_cap_view!' => 'default',
],
]
);
$this->add_control(
'drop_cap_space',
[
'label' => esc_html__( 'Space', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', 'em', 'rem', 'custom' ],
'default' => [
'size' => 10,
],
'range' => [
'px' => [
'max' => 50,
],
'em' => [
'max' => 5,
],
'rem' => [
'max' => 5,
],
],
'selectors' => [
'{{WRAPPER}} .elementor-drop-cap' => 'margin-inline-end: {{SIZE}}{{UNIT}};',
],
]
);
$this->add_control(
'drop_cap_border_radius',
[
'label' => esc_html__( 'Border Radius', 'elementor' ),
'type' => Controls_Manager::SLIDER,
'size_units' => [ 'px', '%', 'em', 'rem', 'custom' ],
'default' => [
'unit' => '%',
],
'range' => [
'%' => [
'max' => 50,
],
],
'selectors' => [
'{{WRAPPER}} .elementor-drop-cap' => 'border-radius: {{SIZE}}{{UNIT}};',
],
'condition' => [
'drop_cap_view!' => 'default',
],
]
);
$this->add_control(
'drop_cap_border_width', [
'label' => esc_html__( 'Border Width', 'elementor' ),
'type' => Controls_Manager::DIMENSIONS,
'size_units' => [ 'px', '%', 'em', 'rem', 'vw', 'custom' ],
'selectors' => [
'{{WRAPPER}} .elementor-drop-cap' => 'border-width: {{TOP}}{{UNIT}} {{RIGHT}}{{UNIT}} {{BOTTOM}}{{UNIT}} {{LEFT}}{{UNIT}};',
],
'condition' => [
'drop_cap_view' => 'framed',
],
]
);
$this->add_group_control(
Group_Control_Typography::get_type(),
[
'name' => 'drop_cap_typography',
'selector' => '{{WRAPPER}} .elementor-drop-cap-letter',
'exclude' => [
'letter_spacing',
],
]
);
$this->end_controls_section();
}
/**
* Render text editor widget output on the frontend.
*
* Written in PHP and used to generate the final HTML.
*
* @since 1.0.0
* @access protected
*/
protected function render() {
$should_render_inline_editing = Plugin::$instance->editor->is_edit_mode();
$editor_content = $this->get_settings_for_display( 'editor' );
$editor_content = $this->parse_text_editor( $editor_content );
if ( empty( $editor_content ) ) {
return;
}
if ( $should_render_inline_editing ) {
$this->add_render_attribute( 'editor', 'class', [ 'elementor-text-editor', 'elementor-clearfix' ] );
}
$this->add_inline_editing_attributes( 'editor', 'advanced' );
?>
<?php if ( $should_render_inline_editing ) { ?>
<div <?php $this->print_render_attribute_string( 'editor' ); ?>>
<?php } ?>
<?php // PHPCS - DO NOT REMOVE THIS ECHO - THE MAIN TEXT OF A WIDGET SHOULD NOT BE ESCAPED!
echo $editor_content; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
?>
<?php if ( $should_render_inline_editing ) { ?>
</div>
<?php } ?>
<?php
}
/**
* Render text editor widget as plain content.
*
* Override the default behavior by printing the content without rendering it.
*
* @since 1.0.0
* @access public
*/
public function render_plain_content() {
// In plain mode, render without shortcode
$this->print_unescaped_setting( 'editor' );
}
/**
* Render text editor widget output in the editor.
*
* Written as a Backbone JavaScript template and used to generate the live preview.
*
* @since 2.9.0
* @access protected
*/
public function render_markdown(): string {
$editor_content = $this->get_settings_for_display( 'editor' );
$editor_content = $this->parse_text_editor( $editor_content );
if ( empty( $editor_content ) ) {
return '';
}
return \Elementor\Modules\MarkdownRender\Html_To_Markdown::convert( $editor_content );
}
protected function content_template() {
?>
<#
if ( '' === settings.editor ) {
return;
}
const shouldRenderInlineEditing = elementorFrontend.isEditMode();
if ( shouldRenderInlineEditing ) {
view.addRenderAttribute( 'editor', 'class', [ 'elementor-text-editor', 'elementor-clearfix' ] );
}
view.addInlineEditingAttributes( 'editor', 'advanced' );
if ( shouldRenderInlineEditing ) { #>
<div {{{ view.getRenderAttributeString( 'editor' ) }}}>
<# } #>
{{{ settings.editor }}}
<# if ( shouldRenderInlineEditing ) { #>
</div>
<# } #>
<?php
}
}