feat(streak): add hide_background parameter to make SVG background transparent#205
Open
Subhooo5 wants to merge 2 commits into
Open
feat(streak): add hide_background parameter to make SVG background transparent#205Subhooo5 wants to merge 2 commits into
Subhooo5 wants to merge 2 commits into
Conversation
Contributor
|
@Subhooo5 is attempting to deploy a commit to the jhasourav07's projects Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
Author
|
@JhaSourav07 All done. Working seamlessly, passing all tests. Whenever possible please add the necessary tags and feel free to review and merge 🚀🫂 |
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Owner
|
Can you keep the commits focused to 1 for the PR? |
JhaSourav07
added
GSSoC 2026
level:intermediate
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Fixes #131
Adds a
hide_background=trueURL parameter that makes the base of the SVG transparent, allowing the monolith to float naturally on a README page without a solid background box.Changes made:
lib/validations.ts— Addedhide_backgroundfield tostreakParamsSchemaas an optional boolean-transformed stringapp/api/streak/route.ts— Destructuredhide_backgroundfrom parsed params and passed it intoBadgeParamsashideBackgroundtypes/index.ts— addedhideBackground?:boolean to theBadgeParamsinterfacelib/svg/generator.ts— updated bothgenerateSVGandgenerateAutoThemeSVGto conditionally set the background fill to transparent whenhideBackgroundis trueREADME.md— addedhide_backgroundto the Parameter Reference tablePillar
Visual Preview
https://collection.cloudinary.com/dqvm8dce2/ce54209a1a00e816516d85178dbd53c7
Hitting
/api/streak?user=YOUR_USERNAME&hide_background=truereturns a valid SVG with a transparent background, letting the monolith float on the page.Checklist
CONTRIBUTING.mdfile.localhost:3000/api/streak?user=YOUR_USERNAME&hide_background=true).npm run formatandnpm run lintlocally and resolved all errors.README.mdif I added a new theme or URL parameter.