Celebrate Finishing Something, Such as Confetti When a To-Do Is Done

Open
#214 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
javascript
Domain
frontend

Research direction

This is a design discussion, not a patch. Settle the open questions first: which events trigger a reaction, which reactions ship, whether prefers-reduced-motion is respected, and whether the reaction syntax is a style word like {confetti}. The issue names no files or entry points, so a newcomer would need to find the markdown-it plugin code themselves. Done means a maintainer-agreed spec, not an implementation.

Written by the indexing model from the issue text.

Description

enhancement

Finishing something could be celebrated: a burst of confetti when a to-do, a step or a whole page is done. This is a discussion issue: how should a document attach a reaction to a widget, across every widget that can be done?

Today

- [ ] Clean the office
- [ ] Buy spray bottles

Ticking the last box changes the box and the done count, and nothing else happens.

What should happen

To be decided. The direction agreed in review (2026-10-31):

  • No scripts in the file. A markdown file that runs code is a security and portability problem, and wouldn't read as plain text elsewhere.
  • Named reactions that reader plays, from a small set it ships (confetti, say), attached the way styles are:
    • on one item: - [ ] Clean the office {confetti}
    • for a whole document: on-done: confetti in the front matter, played when an item, a section or the page becomes done.
  • The same for every widget that can be done: tasks, choices, steps, staged boxes, ingredients, sections (#213), pages in Work.

Questions

  • Which events: an item done, a section done, the page done, all of them?
  • Which reactions to start with, and do they respect prefers-reduced-motion (surely yes)?
  • Is a reaction a style word ({confetti}), or something else that reads better in plain text?
Dominant language
JavaScript
Stars
0
Forks
1
Avg merge
2d 4h
Merged PRs (30d)
26

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jzheaux/reader

All issues in jzheaux/reader

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.