From e7258840cb34d2b717c948dfa06de0c4cee529ae Mon Sep 17 00:00:00 2001 From: Hennit Date: Fri, 28 Aug 2026 07:40:30 -0500 Subject: [PATCH] docs(readme): document per-effect size and opacity CSS vars 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 #3 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 11817da..16ce783 100644 --- a/README.md +++ b/README.md @@ -193,6 +193,19 @@ Ambient effects render in a fixed full-page layer at `z-index: var(--halloween-p } ``` +## Sizing & opacity + +Each ambient effect's box size can be overridden independently via CSS custom properties, and the whole effects layer can be dimmed as a unit. Like `--halloween-color` above, a value you set here always wins over whatever the active `halloween-intensity-*` preset would otherwise use. + +| Property | Controls | Default | +| --- | --- | --- | +| `--halloween-eyes-width` / `--halloween-eyes-height` | Size of the blinking-eyes decoration | `64px` / `26px` | +| `--halloween-witch-width` / `--halloween-witch-height` | Size of the flying witch | `104px` / `130px` | +| `--halloween-spider-drop-width` / `--halloween-spider-drop-height` | Size of the dropping spider | `90px` / `90px` | +| `--halloween-tombstone-width` / `--halloween-tombstone-height` | Size of the rising tombstone | `76px` / `96px` | +| `--halloween-screen-corner-size` | Width and height of each screen-corner web (square) | `120px` | +| `--halloween-page-opacity` | Opacity of the whole effects layer (ambient nodes and screen corners together) | `1` | + ## Advanced: JS API The library already auto-syncs itself against ``'s classes (on load, and on every class change), so most sites never need to call anything directly. These two exports are for the cases where that's not enough. If you're using the plain script tag, the same functions are available as `Halloween.halloween` and `Halloween.pageEffects`.