allow svg element #646
Merged
allow svg element #646
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
BoDonkey
requested changes
Feb 5, 2024
CHANGELOG.md
Outdated
| @@ -2,6 +2,10 @@ | |||
|
|
|||
| ## UNRELEASED | |||
|
|
|||
| - Clarified the use of SVGs with a new test and changes to documentation. | |||
There was a problem hiding this comment.
This can be moved under the other unreleased heading. We will change the 'UNRELEASED' to a version number when we publish all the changes.
README.md
Outdated
| @@ -265,6 +265,19 @@ allowedAttributes: { | |||
|
|
|||
| With `multiple: true`, several allowed values may appear in the same attribute, separated by spaces. Otherwise the attribute must exactly match one and only one of the allowed values. | |||
|
|
|||
| #### "What if I want to prevent attributes and tags from being truly lowercase?" | |||
There was a problem hiding this comment.
Suggested change
| #### "What if I want to prevent attributes and tags from being truly lowercase?" | |
| #### "What if I want to maintain the original case for SVG elements and attributes?" |
README.md
Outdated
| @@ -265,6 +265,19 @@ allowedAttributes: { | |||
|
|
|||
| With `multiple: true`, several allowed values may appear in the same attribute, separated by spaces. Otherwise the attribute must exactly match one and only one of the allowed values. | |||
|
|
|||
| #### "What if I want to prevent attributes and tags from being truly lowercase?" | |||
|
|
|||
| if you got any tag like `linearGradient` and you want to prevent that tag from being lowercased so you have to pass `lowerCaseTags: false` in `parser` option and same for if you want to prevent any attribute like `viewBox` in svg tag from being lowercased so you have to pass `lowerCaseAttributeNames: false` in parser option. | |||
There was a problem hiding this comment.
Suggested change
| if you got any tag like `linearGradient` and you want to prevent that tag from being lowercased so you have to pass `lowerCaseTags: false` in `parser` option and same for if you want to prevent any attribute like `viewBox` in svg tag from being lowercased so you have to pass `lowerCaseAttributeNames: false` in parser option. | |
| If you're incorporating SVG elements like `linearGradient` into your content and notice that they're not rendering as expected due to case sensitivity issues, it's essential to prevent `sanitize-html` from converting element and attribute names to lowercase. This situation often arises when SVGs fail to display correctly because their case-sensitive tags, such as `linearGradient` and attributes like `viewBox`, are inadvertently lowercased. | |
| To address this, ensure you set `lowerCaseTags: false` and `lowerCaseAttributeNames: false` in the parser options of your sanitize-html configuration. This adjustment stops the library from altering the case of your tags and attributes, preserving the integrity of your SVG content. |
There was a problem hiding this comment.
I did the changes.
|
Thanks for doing this! Small comments. |
BoDonkey
approved these changes
Feb 6, 2024
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.
In this PR I have added a test case for the SVG element to prevent the element from lowercased and same for the attributes.