Skip to content

docs(readme): document per-effect size and opacity CSS vars - #5

Merged
rogulia merged 2 commits into
rogulia:mainfrom
Hennit-Dave:patch-1
Aug 31, 2026
Merged

rogulia merged 2 commits into
rogulia:mainfrom
Hennit-Dave:patch-1

Conversation

@Hennit-Dave

@Hennit-Dave Hennit-Dave commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

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.ts exposes 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-color and --halloween-page-z-index were 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 check passes locally
  • This changes the public API (new export, new PageEffectName value, new config option) — if checked, describe the change and its intended semver impact below
  • Tested in the demo with prefers-reduced-motion enabled (only applicable if this touches an ambient effect)
  • Added/updated tests
  • If this adds artwork: it's original or compatibly licensed (state the source below)

This is a documentation-only change (README.md) — the public API, motion-testing, test, and artwork items above don't apply.

Hennit-Dave and others added 2 commits August 28, 2026 07:40
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
@rogulia
rogulia merged commit 0432f43 into rogulia:main Aug 31, 2026
2 checks passed
@rogulia

rogulia commented Aug 31, 2026

Copy link
Copy Markdown
Owner

Thanks for the PR, Dave! Appreciate the docs contribution!

@Hennit-Dave

Copy link
Copy Markdown
Contributor Author

I'm glad I could help.

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.

Document the per-effect CSS size custom properties in README

2 participants