[FEATURE] Add isRemoveDisplayNoneEnabled option + tests #162
Conversation
timothyasp
force-pushed
the
add-remove-display-none-as-option
branch
2 times, most recently
from
b706250
to
f2d81ad
Compare
| * Determines whether elements with the `display: none` property are | ||
| * removed from the DOM. | ||
| */ | ||
| private $isRemoveDisplayNoneEnabled = true; |
There was a problem hiding this comment.
Actually, the option name is a bit misleading. As it is about removing/keeping nodes that are display: none (and not about removing/keeping the display: none itself), I propose the name "shouldKeepInvisibleNodes". What do you think?
There was a problem hiding this comment.
Sure, that sounds fine.
timothyasp
force-pushed
the
add-remove-display-none-as-option
branch
3 times, most recently
from
cf1a367
to
5dd7e05
Compare
|
@oliverklee I think i've made all the requested changes. Thanks for the feedback! |
| @@ -338,6 +331,16 @@ public function disableStyleBlocksParsing() | |||
| } | |||
|
|
|||
| /** | |||
| * Disables the removal of elements with `display: none` properties | |||
There was a problem hiding this comment.
Please add the period at the end of the sentence.
|
Could you also please write a short documentation for this new feature for the README? |
timothyasp
force-pushed
the
add-remove-display-none-as-option
branch
from
5dd7e05
to
569fdcd
Compare
|
Made the requested changes. The test failure looks Github related? Travis couldn't connect to github. I'm not sure how to requeue the test - @oliverklee could you do that? |
|
I've run the tests on this branch locally (as long as Travis does not play along). On your branch, I get the following failure: Do the tests run fine on your local machine? |
|
And could you please prefix the commit message subject line with [FEATURE]? |
| $nodesWithStyleDisplayNone = $xpath->query( | ||
| '//*[contains(translate(translate(@style," ",""),"NOE","noe"),"display:none")]' | ||
| ); | ||
|
|
There was a problem hiding this comment.
Please remove this blank line so that the guard clause is a single visible block.
This adds an options parameter and some tests for a `removeDisplayNone` option which specifies if the Emogrifier parser will remove elements with the style "display: none". Unfortunatly, the nice little optimization has some consiquences. When writing responsive email templates, "display: none" is used often to hide certain sections of the template for desktop email clients and show them in phone clients. I can see how it'd be nice to clean up elements that will not be displayed in some cases, so that's why I made it an options field.
timothyasp
force-pushed
the
add-remove-display-none-as-option
branch
from
569fdcd
to
b32411f
Compare
|
I address all your concerns - still looks like Travis isn't working with github. |
|
I've tested the PR locally, fixed the unit tests (the DIVs were not nested, which made the assertContains not find any potential problems reliably), merged locally, and pushed. Thanks for contributing, @timothyasp! ❤️ |
This adds an options parameter and some tests for a
isRemoveDisplayNoneEnabledoptionwhich specifies if the Emogrifier parser will remove elements with the style
"display: none".
Unfortunatly, the nice little optimization has some consiquences.
When writing responsive email templates, "display: none" is used often to hide
certain sections of the template for desktop email clients and show them in
phone clients.
I can see how it'd be nice to clean up elements that will not be displayed in
some cases, so that's why I made it an options field.