add placeholder widget option #3897
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 30, 2022
Comment on lines
+101
to
+103
| initialModal: true, | ||
| placeholder: false, | ||
| placeholderClass: 'apos-placeholder' |
There was a problem hiding this comment.
Add these by default, so a developer is aware they exist just by checking the widget-type module options
ETLaurent
commented
Sep 30, 2022
| @@ -2,7 +2,7 @@ module.exports = { | |||
| extend: '@apostrophecms/widget-type', | |||
| options: { | |||
| label: 'Placeholder Test Widget', | |||
| initialModal: false | |||
| placeholder: true | |||
There was a problem hiding this comment.
no impact on the tests because this options is used by Vue on front-end.
but does no harm to add it for clarity
ETLaurent
commented
Sep 30, 2022
| return {}; | ||
| } | ||
|
|
||
| const className = placeholderClass || 'apos-placeholder'; |
There was a problem hiding this comment.
now 'apos-placeholder' is added to the widget-type module by default
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.
Summary
Add
placeholderoption to widget modules.If truthy, it will automatically disable the initial modal (by setting
initialModalto false) and render widgets that do not have data yet with their placeholder(s).Placeholder for image, video and rich text widgets are enabled by default in core.
What are the specific steps to test this change?
In testbed, add
placeholder: trueto a widget of your choice.placeholderUrlfor image and video widgets,placeholderTextfor rich text widget, andplaceholderClassfor any other widget)initialModalcan be set tofalse, even withplaceholder: false--> the widget is inserted without having the initial modal displayed, and without placeholder(s)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: