Problem/Motivation

One of my colleagues suggested to add #description_display property to the Section element.
Currently it is not possible to set the description position (after, before, invisible) of the field.

Proposed resolution

Create a patch for it.

User interface changes

As is:
as is

To be:
to be

CommentFileSizeAuthor
#14 3218299-webform6.patch7.67 KBpaulocs
#13 Screenshot from 2021-06-11 16-27-42.png88.45 KBpaulocs
#12 3218299-12.patch7.66 KBjrockowitz
#12 interdiff-3218299-9-12.txt8.23 KBjrockowitz
#10 interdiff-3218299-9-10.txt6.51 KBjrockowitz
#10 3218299-10.patch7.13 KBjrockowitz
#9 3218299-9.patch7.94 KBpaulocs
#9 interdiff-6-9.txt3.84 KBpaulocs
#6 3218299-6.patch4.36 KBpaulocs
#2 3218299-2.patch3.8 KBpaulocs
DescriptionDisplay.png35.15 KBpaulocs
AsIs.png29.88 KBpaulocs

Comments

paulocs created an issue. See original summary.

paulocs’s picture

paulocs
Primary language Portuguese, Brazil
Location Belo Horizonte
commented
Assigned: paulocs » Unassigned
Status: Active » Needs review
StatusFileSize
new 3218299-2.patch3.8 KB

Status: Needs review » Needs work

The last submitted patch, 2: 3218299-2.patch, failed testing. View results
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

jrockowitz’s picture

jrockowitz commented
Version: 6.x-dev » 8.x-5.x-dev

Make sense to add this feature. Thank you for creating the patch. This feature should also be for 8. x-5.x

paulocs’s picture

paulocs
Primary language Portuguese, Brazil
Location Belo Horizonte
commented

I'll give another try...

paulocs’s picture

paulocs
Primary language Portuguese, Brazil
Location Belo Horizonte
commented
Status: Needs work » Needs review
StatusFileSize
new 3218299-6.patch4.36 KB

A patch for 8.x-5.x.

jrockowitz’s picture

jrockowitz commented
Status: Needs review » Needs work

Can you please add 'webform_section_description_demo' example to webform.webform.test_element_section.yml and add some test coverage to \Drupal\Tests\webform\Functional\Element\WebformElementSectionTest? This will make it much easier to review the patch.

paulocs’s picture

paulocs
Primary language Portuguese, Brazil
Location Belo Horizonte
commented
Assigned: Unassigned » paulocs

Yes

paulocs’s picture

paulocs
Primary language Portuguese, Brazil
Location Belo Horizonte
commented
Assigned: paulocs » Unassigned
Status: Needs work » Needs review
StatusFileSize
new interdiff-6-9.txt3.84 KB
new 3218299-9.patch7.94 KB

See if this is enough to cover the new feature.
I added text field element to the section elements to delimit if they are displayed after or before.
I also added a small change to the webform-section.html.twig

jrockowitz’s picture

jrockowitz commented
StatusFileSize
new 3218299-10.patch7.13 KB
new interdiff-3218299-9-10.txt6.51 KB

The patch looks great. If all the tests pass, I think it is RTBC.

Changes include

  • Minor reordering of variables in preprocessor
  • Tweaked test to use pattern assertions instead of targeting markup with spaces
  • Move alteration of section element's description display options from WebformElementBase to WebformSection

Status: Needs review » Needs work

The last submitted patch, 10: 3218299-10.patch, failed testing. View results
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

jrockowitz’s picture

jrockowitz commented
Status: Needs work » Needs review
StatusFileSize
new interdiff-3218299-9-12.txt8.23 KB
new 3218299-12.patch7.66 KB

There was a minor issue with the webform's YAML. Locally, I am did not have the PHP YAML extension installed and DrupalCI does.

paulocs’s picture

paulocs
Primary language Portuguese, Brazil
Location Belo Horizonte
commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new Screenshot from 2021-06-11 16-27-42.png88.45 KB

Thanks for the improvement @jrockowitz.
All changes in #12 make sense because the code is more organized than #9.
Attaching an image to confirm that the new feature is working.

Moving to RTBC.

paulocs’s picture

paulocs
Primary language Portuguese, Brazil
Location Belo Horizonte
commented
StatusFileSize
new 3218299-webform6.patch7.67 KB

Here is a patch for webform 6.x

jrockowitz’s picture

jrockowitz commented

Don't worry about the 6.x patch. What I have been doing is commit the 8.x-5.x patch and then merge 8.x-5.x into 6.x. This makes it easier to maintain the two branches.

  • paulocs authored b56bfb4 on 8.x-5.x 
    Issue #3218299 by paulocs, jrockowitz: Make #description_display...

  • paulocs authored b56bfb4 on 6.x 
    Issue #3218299 by paulocs, jrockowitz: Make #description_display...
jrockowitz’s picture

jrockowitz commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.