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.

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

Editable: Rename the Editable component, RichText component for clarity #4779

Merged
merged 1 commit into from Feb 1, 2018

Conversation

youknowriad
Copy link
Contributor

refs #4776

This PR renames the Editable component RichText to clarify that it's meant to be used for Rich Content exclusively and not as a replacement to inputs/textareas.

We still export an Editable component for backwards compatibility with a warning asking people to use RichText instead.

Next step will be to implement a PlainText component and use it in one/two blocks. The blocks where we're currently using TextareaAutosize.

Testing instructions

  • Open the editor
  • Insert different content blocks (paragraph, list, quotes, image with captions...)
  • Check that they still work and look as expected.

@youknowriad youknowriad added [Feature] Rich Text Related to the Rich Text component that allows developers to render a contenteditable Backwards Compatibility Issues or PRs that impact backwards compatability labels Jan 31, 2018
@youknowriad youknowriad self-assigned this Jan 31, 2018
constructor() {
super( ...arguments );
// eslint-disable-next-line no-console
console.warn( 'Editable is deprecated use wp.blocks.RichText instead.' );
Copy link
Member

Choose a reason for hiding this comment

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

Minor: this sentence could use a period. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It already use a period?

Edit: Oh! maybe you meant something like that:

"Editable is deprecated, use wp.blocks.RichText instead."

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I did. :) Sorry, should have been more specific :)

Copy link
Member

@ellatrix ellatrix left a comment

Choose a reason for hiding this comment

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

Catching some "editable" mentions in README.md, but nothing that doesn't make sense as it's still an editable field. :)

@aduth
Copy link
Member

aduth commented Jan 31, 2018

I'd be in favor of this change.

@youknowriad youknowriad mentioned this pull request Jan 31, 2018
@youknowriad youknowriad force-pushed the update/rename-editable-rich-text branch from 8b5df6c to 0282eb6 Compare February 1, 2018 08:38
@youknowriad youknowriad force-pushed the update/rename-editable-rich-text branch from 0282eb6 to 4069064 Compare February 1, 2018 08:39
@youknowriad youknowriad merged commit f889d27 into master Feb 1, 2018
@youknowriad youknowriad deleted the update/rename-editable-rich-text branch February 1, 2018 08:55
@gziolo
Copy link
Member

gziolo commented Feb 1, 2018

This change is important enough to make sure is noticed, cc @mtias @karmatosed.

@ellatrix
Copy link
Member

ellatrix commented Feb 1, 2018

I updated the "Editable" label to "Rich Text".

@zgordon
Copy link

zgordon commented Feb 20, 2018

Is Editable still available as a name for backwards compatibility? Or do folks need to switch to RichText right away? Thanks!!!

@youknowriad
Copy link
Contributor Author

Is Editable still available as a name for backwards compatibility? Or do folks need to switch to RichText right away? Thanks!!!

It's available and will be removed in like two or three releases ;)

@zgordon
Copy link

zgordon commented Feb 20, 2018

👌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backwards Compatibility Issues or PRs that impact backwards compatability [Feature] Rich Text Related to the Rich Text component that allows developers to render a contenteditable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants