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.

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

feat: add CLI option to allow transparent pngs #1797

Merged
merged 7 commits into from
Aug 15, 2024

Conversation

flwst
Copy link
Contributor

@flwst flwst commented Aug 3, 2024

PNGs are generated by taking a screenshot of the page as if it were running in a browser using Playwright. Currently, PNG exports will never be transparent and will always have the default, white, browser background regardless of if the user has removed all backgrounds using css. Playwright has an omitBackground property that can be added to the .screenshot method to remove this final browser background.

https://playwright.dev/docs/api/class-page#page-screenshot-option-omit-background

This PR adds the --omit-background CLI option to control the visibility of the default browser background and allow for the possibility of transparent png exports. It also adds docs for this feature

Users will still need to apply additional css styling to remove the css backgrounds from their slides in order to reveal the transparency in their exports.

Copy link

netlify bot commented Aug 3, 2024

Deploy Preview for slidev ready!

Name Link
🔨 Latest commit 4b7aece
🔍 Latest deploy log https://app.netlify.com/sites/slidev/deploys/66b039f740f2470007585a57
😎 Deploy Preview https://deploy-preview-1797--slidev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@KermanX KermanX left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

I think it's better to name this option --omit-background for clarity.

@antfu
Copy link
Member

antfu commented Aug 4, 2024

Yeah --omit-background or --no-background sounds better to me as well

@flwst
Copy link
Contributor Author

flwst commented Aug 4, 2024

@KermanX @antfu makes sense. changed it to omit-background

@antfu antfu merged commit 85322ae into slidevjs:main Aug 15, 2024
18 checks passed
AlbertBrand pushed a commit to AlbertBrand/slidev that referenced this pull request Aug 16, 2024
Co-authored-by: mo91dev <>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: _Kerman <kermanx@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants