Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add settings to enable visual or text editor for TinyMCE #6179

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft

Add settings to enable visual or text editor for TinyMCE #6179

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2586034
Add tinymce and quicktags settings
JoryHogeveen Oct 19, 2021
45547a9
Codestyle
JoryHogeveen Oct 19, 2021
e30f391
Add wysiwyg tinymce prop types
JoryHogeveen Oct 19, 2021
c0cfe88
Enable/disable quicktags or tinymce editor
JoryHogeveen Oct 20, 2021
9437442
Just a plain paragraph if both are disabled
JoryHogeveen Oct 20, 2021
0c96bc5
Pass tinymce and quicktag settings to TinyMCE component
JoryHogeveen Oct 20, 2021
cd20af4
Rebuild assets (dev)
JoryHogeveen Oct 20, 2021
3f317e9
Comments
JoryHogeveen Oct 20, 2021
c219ee7
Wrong key
JoryHogeveen Oct 20, 2021
3cb43c6
Enforce booleans
JoryHogeveen Oct 20, 2021
3c075b7
Set defaults if set to empty string
sc0ttkclark Oct 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions classes/fields/wysiwyg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,25 @@ public function options() {
'dependency' => true,
),
'editor_options' => array(
'label' => __( 'Editor Options', 'pods' ),
'type' => 'boolean_group',
'depends-on' => array( static::$type . '_editor' => 'tinymce' ),
'boolean_group' => array(
'label' => __( 'Editor Options', 'pods' ),
'type' => 'boolean_group',
'depends-on' => array( static::$type . '_editor' => 'tinymce' ),
'boolean_group' => array(
static::$type . '_media_buttons' => array(
'label' => __( 'Enable Media Buttons', 'pods' ),
'default' => 1,
'type' => 'boolean',
),
static::$type . '_tinymce' => array(
'label' => __( 'Enable TinyMCE (Visual)', 'pods' ),
'default' => 1,
'type' => 'boolean',
),
static::$type . '_quicktags' => array(
'label' => __( 'Enable Quicktags (Text)', 'pods' ),
'default' => 1,
'type' => 'boolean',
),
),
),
static::$type . '_editor_height' => array(
Expand Down Expand Up @@ -257,8 +267,10 @@ public function input( $name, $value = null, $options = null, $pod = null, $id =
} elseif ( 'tinymce' === pods_v( static::$type . '_editor', $options ) ) {
$field_type = 'tinymce';

// Enforce boolean.
$options[ static::$type . '_media_buttons' ] = filter_var( pods_v( static::$type . '_editor', $options, true ), FILTER_VALIDATE_BOOLEAN );
// Enforce booleans.
$options[ static::$type . '_media_buttons' ] = filter_var( pods_v( static::$type . '_media_buttons', $options, true ), FILTER_VALIDATE_BOOLEAN );
$options[ static::$type . '_tinymce' ] = filter_var( pods_v( static::$type . '_tinymce', $options, true ), FILTER_VALIDATE_BOOLEAN );
JoryHogeveen marked this conversation as resolved.
Show resolved Hide resolved
$options[ static::$type . '_quicktags' ] = filter_var( pods_v( static::$type . '_quicktags', $options, true ), FILTER_VALIDATE_BOOLEAN );
sc0ttkclark marked this conversation as resolved.
Show resolved Hide resolved

wp_tinymce_inline_scripts();
wp_enqueue_editor();
Expand Down
2 changes: 1 addition & 1 deletion ui/js/blocks/pods-blocks-api.min.asset.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"dependencies":["wp-api-fetch","wp-autop","wp-block-editor","wp-blocks","wp-components","wp-compose","wp-date","wp-element","wp-i18n","wp-keycodes","wp-server-side-render","wp-url"],"version":"1ae572d3f990891697f42359d4789570"}
{"dependencies":["wp-api-fetch","wp-autop","wp-block-editor","wp-blocks","wp-components","wp-compose","wp-date","wp-element","wp-i18n","wp-keycodes","wp-server-side-render","wp-url"],"version":"eee47e8051ea21b3ee6a152dd4851aad"}
1,270 changes: 1,269 additions & 1 deletion ui/js/blocks/pods-blocks-api.min.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion ui/js/dfv/pods-dfv.min.asset.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"dependencies":["moment","wp-api-fetch","wp-autop","wp-components","wp-compose","wp-data","wp-element","wp-i18n","wp-keycodes","wp-plugins","wp-primitives","wp-url"],"version":"24a252ba15d83803f1b7826ab7b44b4c"}
{"dependencies":["moment","wp-api-fetch","wp-autop","wp-components","wp-compose","wp-data","wp-element","wp-i18n","wp-keycodes","wp-plugins","wp-primitives","wp-url"],"version":"c469aceb94e7980870ea6c5c1fdb8067"}
7,370 changes: 7,369 additions & 1 deletion ui/js/dfv/pods-dfv.min.js
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion ui/js/dfv/src/config/prop-types.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,9 @@ export const FIELD_PROP_TYPE = {
wysiwyg_convert_chars: PropTypes.string,
wysiwyg_editor: PropTypes.string,
wysiwyg_editor_height: NUMBER_OR_NUMBER_AS_STRING,
wysiwyg_media_buttons: PropTypes.string,
wysiwyg_media_buttons: BOOLEAN_ALL_TYPES,
JoryHogeveen marked this conversation as resolved.
Show resolved Hide resolved
wysiwyg_tinymce: BOOLEAN_ALL_TYPES,
wysiwyg_quicktags: BOOLEAN_ALL_TYPES,
wysiwyg_oembed: PropTypes.string,
wysiwyg_repeatable: BOOLEAN_ALL_TYPES,
wysiwyg_wpautop: PropTypes.string,
Expand Down
4 changes: 4 additions & 0 deletions ui/js/dfv/src/fields/wysiwyg/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ const Wysiwyg = ( props ) => {
wysiwyg_editor: editor = 'tinymce',
wysiwyg_editor_height: editorHeight = 400,
wysiwyg_media_buttons: mediaButtons,
wysiwyg_tinymce: enableTinyMCE,
wysiwyg_quicktags: enableQuicktags,
} = fieldConfig;

if ( 'quill' === editor || 'cleditor' === editor ) {
Expand Down Expand Up @@ -73,6 +75,8 @@ const Wysiwyg = ( props ) => {
setValue={ setValue }
editorHeight={ parseInt( editorHeight, 10 ) }
mediaButtons={ toBool( mediaButtons ) }
enableQuicktags={ toBool( enableQuicktags ) }
enableTinyMCE={ toBool( enableTinyMCE ) }
onBlur={ () => setHasBlurred() }
/>
);
Expand Down
17 changes: 16 additions & 1 deletion ui/js/dfv/src/fields/wysiwyg/tinymce.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ const TinyMCE = ( {
setValue,
editorHeight,
mediaButtons,
enableTinyMCE,
enableQuicktags,
onBlur,
} ) => {
const fieldId = `pods-form-ui-${ name }`;
Expand Down Expand Up @@ -99,6 +101,17 @@ const TinyMCE = ( {
settings.toolbar4 = settings.toolbar4.replace( 'wp_add_media,', '' ).replace( ',wp_add_media', '' ).replace( 'wp_add_media', '' );
}

if ( ! enableTinyMCE && ! enableQuicktags ) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to address other areas like in onSetup and the first useEffect perhaps?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you elaborate?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically checking enableTinyMCE before calling other tinymce/editor specific functions elsewhere in this file

// Plain paragraph.
return;
}

if ( ! enableTinyMCE ) {
// Quicktags only.
window.quicktags( { ...wp.oldEditor.getDefaultSettings().quicktags, id: fieldId } );
return;
}

window.wp.oldEditor.initialize( fieldId, {
tinymce: {
...settings,
Expand All @@ -107,7 +120,7 @@ const TinyMCE = ( {
height: editorHeight,
},
mediaButtons,
quicktags: true,
quicktags: enableQuicktags,
} );
}

Expand Down Expand Up @@ -154,6 +167,8 @@ TinyMCE.propTypes = {
setValue: PropTypes.func.isRequired,
editorHeight: PropTypes.number,
mediaButtons: PropTypes.bool,
enableTinyMCE: PropTypes.bool,
enableQuicktags: PropTypes.bool,
onBlur: PropTypes.func.isRequired,
};

Expand Down