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

Jump to bottom

Templates for RichTextEditor #3081

Open
VassilIordanov opened this issue Jun 22, 2020 · 0 comments · May be fixed by #3176
Open

Templates for RichTextEditor #3081

VassilIordanov opened this issue Jun 22, 2020 · 0 comments · May be fixed by #3176
Labels
feature stalled

Comments

@VassilIordanov
Copy link
Contributor

Is your feature request related to a problem? Please describe.
We would like to enforce a certain document structure in certain rich text fields.

Describe the solution you'd like
I propose to have the ability for certain rich text fields to be primed with a default structure.
We could define this structure as html with some extra attributes (i.e. a mandatory attribute).
The widget start with an empty template when first created. The user is prevented from deleting elements with the mandatory attribute.
We could start with a template such as:

<h1 mandatory placelholder="Key issue 1"/>
<h1 mandatory placelholder="Key issue 2"/>
<h1 mandatory placelholder="Key issue 3"/>

We could also apply different styling to these attributes, for example we could display placeholder text when they are empty.

Describe alternatives you've considered
We considered separate fields for each template component, but that is too cumbersome and not user-friendly.

Additional context
Similar to: https://www.slatejs.org/examples/forced-layout
maradragan added a commit that referenced this issue Jun 23, 2020
@maradragan
#3081:Add template with readonly blocks to reportText
06a38fc 
This makes sure that when creating a report, the reportText field
contains a template text. Some of the heading blocks in the template
are readonly and can't be removed.
Note: it only works now on add, after save, on edit, the headings
are no longer readonly (still to be implemented).
maradragan added a commit that referenced this issue Jun 25, 2020
@maradragan
#3081: Update richTextEditor mandatory h1
b036bb8 
This makes sure that if the richTextEditor contains h1 tags marked
with the mandatory class, they can be edited but the tags itself
can not be deleted. Also, when the content is saved, the resulting
html also still has the mandatory class for the h1 tag (this was not
the case before).
maradragan added a commit that referenced this issue Jun 25, 2020
@maradragan
#3081: Update HtmlPolicyBuilder, allow class for h1 and p
c167807 
In order to be able to save richText content containing also a class,
we need to allow this in the HtmlPolicyBuilder, which is being used to
sanitize the HTML before saving. We updated this one to allow the
class attribute for h1 and p elements.
maradragan added a commit that referenced this issue Jun 25, 2020
@maradragan
#3081: WIP: Replace mandatory elems with placeholder
bea58fa 
In the RichTextEditor, replace mandatory elements with a placeholder
when all their text is being deleted.
maradragan added a commit that referenced this issue Jul 1, 2020
@maradragan
#3081: Replace mandatory elements with placeholder
c429143 
In the RichTextEditor, replace mandatory elements with a placeholder
when trying to delete their last content character.
maradragan added a commit that referenced this issue Jul 1, 2020
@maradragan
#3081: Update styling of mandatory elements in RichTextEditor
a116a82 
Changed the style of the h1 mandatory element. Made sure the mandatory
elements are only having a specific style when in the RichTextEditor.
maradragan added a commit that referenced this issue Jul 1, 2020
@maradragan
#3081: Make htmlTemplate for rickTextEditor configurable
a4ec1ac 
It is now possible to configure within the anet.yml, through
report.reportText.placeholder the html template to be used per
default for the report text.
maradragan added a commit that referenced this issue Jul 1, 2020
@maradragan
#3081: Remove already done todo
7807258
maradragan added a commit that referenced this issue Jul 1, 2020
@maradragan
#3081: Save mandatory unstyled blocks as mandatory
ca227c1 
This makes sure that if an unstyled block has the mandatory class,
it is also being saved as a html element with the mandatory class.
maradragan added a commit that referenced this issue Jul 1, 2020
@maradragan
#3081: Make placeholder configurable for mandatory elements
ef440b6 
This makes sure that when specifying a default template for a
richTextEditor type of field, we can also define a placeholder for
the html elements having the class mandatory. This placeholder
is being used to prefill the element if this one becomes empty.
Both the class attribute and the placeholder attribute of an HTML
tag of type h1, h2, h3 or p are being persisted in the database. This
in order to be able to still know the mandatory elements and their
eventual placeholders when editing an object with rich text content.
maradragan added a commit that referenced this issue Jul 1, 2020
@maradragan
Merge branch 'candidate' into GH-3081-richt-text-editor-templates
435302b
maradragan added a commit that referenced this issue Jul 1, 2020
@maradragan
Merge branch 'GH-3081-richt-text-editor-templates' of github.com:NCI-…
e417c1b 
…Agency/anet into GH-3081-richt-text-editor-templates
maradragan added a commit that referenced this issue Jul 24, 2020
@maradragan
#3081: Make sure mandatory blocks are not merged with others
6223efa 
This makes sure that if the RichTextEditor is using a template containing
mandatory blocks, we can not merge them with next/previous blocks using
delete/backspace.
maradragan added a commit that referenced this issue Jul 29, 2020
@maradragan
#3081: Make sure mandatory blocks are not merged or deleted
f246884 
This makes sure that if the RichTextEditor is using a template containing
mandatory blocks, we can not merge them with next/previous blocks using
delete/backspace and we can not delete them.
maradragan added a commit that referenced this issue Jul 31, 2020
@maradragan
#3081: Make sure mandatory blocks remain mandatory
54c7544 
Prevent return when:
- at the beginning of a mandatory block => it would result in an empty
  mandatory block and a new non-mandatory block containing the text of
  the block which used to be mandatory.
- the selection contains at least one mandatory block => it would result
  in deleting the selection including the mandatory block
- exactly one whole mandatory block is selected, it would result in the
  contents of the mandatory block being deleted and the addition of a
  new empty block afterwards.

Prevent delete or backspace when:
- the selection contains several blocks and at least one of them is
mandatory => we don't want to lose mandatory blocks

Prevent delete when:
- at the end of a block when the next block is => we don't want to merge
  a mandatory block into a previous one

Prevent backspace when:
- at the beginning of a mandatory block => we don't want to merge a
  mandatory block into a previous one

The reason we don't want to merge a mandatory block B into a previous
block A as:
- if block A is not mandatory, block B would lose it's style and data
  (thus also the mandatory property)
- if block A is also mandatory, we would end up with only one mandatory
  block instead of two.

Prevent pasting on a selection when:
- at least one of the selection blocks is mandatory. It would result in
  the removal of mandatory blocks.
maradragan added a commit that referenced this issue Aug 6, 2020
@maradragan
Merge branch 'candidate' into GH-3081-richt-text-editor-templates
9d4dc28
maradragan added a commit that referenced this issue Aug 6, 2020
@maradragan
Merge branch 'candidate' into GH-3081-richt-text-editor-templates
5fe494d
@maradragan maradragan linked a pull request Sep 3, 2020 that will close this issue
Draft
14 tasks
@midmarch midmarch changed the title Templates for DraftJS Templates for RichTextEditor Oct 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature stalled
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rich text editor templates NCI-Agency/anet
3 participants
@gjvoosten @VassilIordanov @maradragan