html-to-image icon indicating copy to clipboard operation
html-to-image copied to clipboard

feat: allow user to provide custom pseudo elements to be captured

Open SUCHMOKUO opened this issue 2 years ago • 2 comments

Hi! Thanks for maintaining this great library!

I've tried it and just found that it might be great if we can control what pseudo elements will be included in the captured image rather than just ::before and ::after, sometimes we might want to include some non-standard but useful ones, like ::-webkit-scrollbar and ::-webkit-scrollbar-thumb, so I created this PR to add a new option includedPseudoElements to allow user to customize the rule of the included pseudo elements.

Hope this can be helpful :)

Description

  1. Add new option includedPseudoElements.
  2. Refactor clonePseudoElements to receive the includedPseudoElements list and clone all the pseudo elements in the list.
  3. Add test for this option.
  4. Update README.

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [x] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [ ] Enhancement (changes that improvement of current feature or performance)
  • [ ] Refactoring (changes that neither fixes a bug nor adds a feature)
  • [ ] Test Case (changes that add missing tests or correct existing tests)
  • [ ] Code style optimization (changes that do not affect the meaning of the code)
  • [ ] Docs (changes that only update documentation)
  • [ ] Chore (changes that don't modify src or test files)

Self Check before Merge

  • [x] My code follows the code style of this project.
  • [x] My change requires a change to the documentation.
  • [x] I have updated the documentation accordingly.
  • [x] I have read the CONTRIBUTING document.
  • [x] I have added tests to cover my changes.
  • [x] All new and existing tests passed.

SUCHMOKUO avatar Feb 24 '23 21:02 SUCHMOKUO

👋 @SUCHMOKUO

💖 Thanks for opening this pull request! 💖

Please follow the contributing guidelines. And we use semantic commit messages to streamline the release process.

Examples of commit messages with semantic prefixes:

  • fix: don't overwrite prevent_default if default wasn't prevented
  • feat: add graph.scale() method
  • docs: graph.getShortestPath is now available

Things that will help get your PR across the finish line:

  • Follow the TypeScript coding style.
  • Run npm run lint locally to catch formatting errors earlier.
  • Document any user-facing changes you've made.
  • Include tests when adding/changing behavior.
  • Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

biiibooo[bot] avatar Feb 24 '23 21:02 biiibooo[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 62.93%. Comparing base (b751cbf) to head (f6363fc). Report is 13 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #376   +/-   ##
=======================================
  Coverage   62.93%   62.93%           
=======================================
  Files          10       10           
  Lines         580      580           
  Branches      143      143           
=======================================
  Hits          365      365           
  Misses        151      151           
  Partials       64       64           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Feb 24 '23 21:02 codecov[bot]