Ckeditor4: Better name for Placeholder Text plugin?

Created on 29 May 2020  路  7Comments  路  Source: ckeditor/ckeditor4

Type of report

Task

Provide description of the task

Recently we have introduced Placeholder Text plugin (see #3793) which is the same thing as editor placeholder in CKEditor 5 and also as native placeholder attribute.

However, since we already have Placeholder plugin, the new plugin name might be confusing.

WDYT? Any ideas for different name? cc @AnnaTomanek @Comandeer @jacekbogdanski

S confirmed task

Most helpful comment

I can also add Blank Text / config.blankText, Empty Value / config.emptyValue, but:

The issue with a placeholder name is that it's the default attribute for HTML and in most cases, it's also the first name that comes to mind when searching for such feature in WYSIWYG editors. placeholder is a domain unique name - not sure if it won't be more confusing using totally different name instead of current placeholdertext. I mean, it may be confusing which one to use between Placeholder Text and Placeholder, but giving it a different name will make this plugin less discoverable. Some users may just not find the feature they are searching for, thinking it's not implemented.

All 7 comments

Maybe something like Filler Text would do.

I can also add Blank Text / config.blankText, Empty Value / config.emptyValue, but:

The issue with a placeholder name is that it's the default attribute for HTML and in most cases, it's also the first name that comes to mind when searching for such feature in WYSIWYG editors. placeholder is a domain unique name - not sure if it won't be more confusing using totally different name instead of current placeholdertext. I mean, it may be confusing which one to use between Placeholder Text and Placeholder, but giving it a different name will make this plugin less discoverable. Some users may just not find the feature they are searching for, thinking it's not implemented.

Maybe "Editor Placeholder"? It will still be a placeholder and word "editor" will indicate the purpose of it.

I agree with what @jacekbogdanski wrote in https://github.com/ckeditor/ckeditor4/issues/4086#issuecomment-635900707 as placeholder is just standard name here. And so to distinguish it from our placeholder plugin, @Comandeer proposal seems like a best option here - Editor Placeholder sounds better than Placeholder Text and should be a little less confusing. At the same time it keeps placeholder part in opposite to other proposals. WDYT?

"Editor placeholder" is something that we use in CKEditor 5 too: https://ckeditor.com/docs/ckeditor5/latest/features/editor-placeholder.html

Editor Placeholder LGTM, I suppose in that case we would have:

plugin name: Editor Placeholder
configuration option: placeholder e.g. config.placeholder = 'Foo bar baz';?

Note that by convention we name our config values [plugin_name]_[plugin_config_option], so it would be an exception - not sure if we want that because we are stealing Placeholder plugin namespace :thinking: Maybe it's just better to stick editorplaceholder? :thinking: Doesn't look very good though (not terrible, just not good as simple placeholder).

@jacekbogdanski I would stick with the convention we have - consistent API is more intuitive and easier to use/remember. It looks a little less attractive but still better to keep things consistent instead of making an exception to have one more friendly config name.

Was this page helpful?
0 / 5 - 0 ratings