Repository navigation
docs(readme): document per-effect size and opacity CSS vars - #5
Merged
Merged
Conversation
Adds a "Sizing & opacity" section to README.md documenting the CSS custom properties exposed by src/styles.ts for per-effect box sizing (eyes, witch, spider-drop, tombstone), the screen-corner size, and the page-layer opacity, alongside their defaults. Follows the existing Color section's style. Closes rogulia#3
Owner
|
Thanks for the PR, Dave! Appreciate the docs contribution! |
Contributor
Author
|
I'm glad I could help. |
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
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.
Added a "Sizing & opacity" section to README.md documenting the CSS custom properties exposed by src/styles.ts for per-effect box sizing (eyes, witch, spider-drop, tombstone), the screen-corner size, and the page-layer opacity, alongside their defaults. Follows the existing Color section's style.
Closes #3
What and why
src/styles.tsexposes several user-overridable CSS custom properties for resizing individual ambient effects and dimming the page layer, but none of them were mentioned in the README — only--halloween-colorand--halloween-page-z-indexwere documented. This adds a table covering all of them (with defaults) right after the existing Color section, so they're discoverable without reading source.Checklist
npm run checkpasses locallyPageEffectNamevalue, new config option) — if checked, describe the change and its intended semver impact belowprefers-reduced-motionenabled (only applicable if this touches an ambient effect)This is a documentation-only change (README.md) — the public API, motion-testing, test, and artwork items above don't apply.