display placeholder for rich-text-widget #3888
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ETLaurent
commented
Sep 22, 2022
| @@ -35,6 +35,7 @@ | |||
| "@opentelemetry/semantic-conventions": "^1.0.1", | |||
| "@tiptap/extension-highlight": "^2.0.0-beta.33", | |||
| "@tiptap/extension-link": "^2.0.0-beta.38", | |||
| "@tiptap/extension-placeholder": "^2.0.0-beta.196", | |||
There was a problem hiding this comment.
鈩癸笍 just this one added, the rest is re-ordering
ETLaurent
force-pushed
the
3146-placeholder-tiptap
branch
from
fe6d63e
to
2ef2723
Compare
ETLaurent
commented
Sep 23, 2022
Comment on lines
357
to
399
| .apos-rich-text-editor__editor ::v-deep .ProseMirror p.is-empty:first-child::before { | ||
| content: attr(data-placeholder); | ||
| float: left; | ||
| color: #adb5bd; | ||
| pointer-events: none; | ||
| height: 0; | ||
| margin-left: 5px; | ||
| } |
There was a problem hiding this comment.
ETLaurent
force-pushed
the
3146-placeholder-tiptap
branch
from
2ef2723
to
b348341
Compare
ETLaurent
commented
Sep 23, 2022
| @@ -9,6 +9,7 @@ module.exports = { | |||
| icon: 'format-text-icon', | |||
| label: 'apostrophe:richText', | |||
| contextual: true, | |||
| placeholderText: 'apostrophe:richTextPlaceholder', | |||
There was a problem hiding this comment.
@stuartromanek this sets a default placeholder value, and it looks like this:
It is overridable on project side, so if a project sets placeholderText: false or any falsy value, it'll go back to the previous behavior:
Do you want to keep that default value? Or would you prefer not to have one, and only add the placeholder on project side?
There was a problem hiding this comment.
I think we should keep a default in core.
'Start typing here...' is fine
stuartromanek
requested changes
Sep 23, 2022
There was a problem hiding this comment.
Two things standing out to me:
- A rich text widget should be able to override the module defaults and provide its own placeholder text via the RT options object.
placeholderis probably a fine key - The placeholder text should only be displayed when the widget is active and focused. This would happen when first adding the RT widget to the area or clicking in to focus an existing, empty RT widget. When the RT widget is empty and unfocused it should return to the previous A3 empty state.
stuartromanek
approved these changes
Sep 26, 2022
boutell
requested changes
Sep 28, 2022
| Underline, | ||
|
|
||
| // For this contextual widget, no need to check `widget.aposPlaceholder` value | ||
| // since `placeholderText` option is enough to decide whether to display it ot not. |
| // - after it, once the page is loaded and we interact with the editors | ||
| // To solve this issue, use another `this.showPlaceholder` variable | ||
| // and toggle it after the placeholder configuration function is called, | ||
| // thanks to textTick. |
Base automatically changed from
pro-3131-placeholder-wrapper
to
feature-widget-placeholders
September 28, 2022 13:03
ETLaurent
force-pushed
the
3146-placeholder-tiptap
branch
from
8948879
to
d3c6e24
Compare
boutell
approved these changes
Sep 28, 2022
ETLaurent
added a commit
that referenced
this pull request
Oct 11, 2022
ETLaurent
added a commit
that referenced
this pull request
Oct 24, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Depends on #3882
Closes PRO-3146
Summary
Set a default placeholder value for rich text widget:
The placeholder disappears as soon as we start typing in.
It's overridable on project side, so if it's overridden with a falsy value, it will display the normal/previous behaviour.
What are the specific steps to test this change?
On testbed:
馃憞
馃憞
What kind of change does this PR introduce?
(Check at least one)
Make sure the PR fulfills these requirements:
If adding a new feature without an already open issue, it's best to open a feature request issue first and wait for approval before working on it.
Other information: