Skip to content
TheMightyTRexPublic

About

Feedback for any website or app: bug reports, UX problems, suggestions and accessibility checks, tagged with the page and the part of it, without personal information. One file, no libraries.

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Snaglist

Feedback for any website or app. People report bugs and UX problems, suggest features and improvements, record a series of steps, or check a page for accessibility problems. Each report is tagged with the page and the part of it, carries the technical details needed to act on it, and keeps no personal information.

A snag list is a list of the small faults to fix before a job is finished. Snaglist adds a Send feedback button to your site. People choose what to send, show one thing on the page or record what they do, answer a few questions, check exactly what will be sent, and send it as a GitHub issue, an email or a post to your own server.

Try the demo · Set it up for your site · Help centre · Prompts for AI assistants

The Send feedback window. Report a problem lists Something is broken, Confusing to use, Display problem, Does not work with my tools or needs, Slow and Words are wrong. Make a suggestion lists A new feature, Make something better and Something else. Check the page offers Check this page for accessibility problems. What do you want to show offers One thing on the page, A series of steps, and Describe it in words.

  • One file, no libraries: about 129 KB, or 41 KB when your server compresses it. No build step.
  • One script tag to add, nothing left when removed: one script tag, or the set-up tool writes the code and one prompt for your AI assistant. Removing it leaves nothing behind.
  • Anonymous by design: never what people type, no cookies, no query strings; emails, phone numbers, addresses and keys are replaced. People are shown the whole report before it goes, and can take parts out.
  • Accessible: keyboard first, 44px targets, a visible focus ring, reduced motion, forced colours, and it follows the page's text size. Light by default, or dark, or the same as the device.
  • Any language: British or US English built in; give your own text for any other language.

What people can send

Choice Asks Records for developers
Something is broken What happened, what you expected Text on the page, script errors with stack, console errors and warnings, failed and slow requests, steps before, the part's HTML
Confusing to use What is wrong The part, text on the page, steps before
Display problem What is wrong Text on the page, styles and contrast, size and position, content cut off, what covers it, the part's HTML
Does not work with my tools or needs What is wrong, what you were using Role, name, states, focus, target size, landmark, contrast
Slow What is wrong, when Load timings, LCP, CLS and INP, long tasks, script memory, slow requests
Words are wrong What is wrong, a better wording The part and its text
A new feature What you would like, what it would help with, how you manage today The page
Make something better What could be better, your suggestion The part
Something else Your message Nothing extra
Check this page for accessibility problems Nothing: it runs an automatic check Each problem, its WCAG criterion, where it is and how to fix it

You choose what to offer and what each records. Choose what people can send and What a report holds, and what it never holds have the details.

Record a series of steps

For a problem that takes several steps, people select A series of steps, then Start recording, and use the site as normal. Pause, Start again and Stop and describe are on the bar. Snaglist notes what they select, change and send, the pages they go to, and any errors or failed requests, but never what they type. The recording carries on across pages in the same tab.

The recording bar shows a red dot and Recording: 6 steps, the last step, and the buttons Pause, Stop and describe, Start again and Cancel.

Check a page for accessibility problems

Check this page for accessibility problems runs 13 checks for the most common WCAG 2.2 failures, or axe-core if you choose. Each problem says why it matters and how to fix it, with code before and after, and can be shown on the page and reported on its own or with the rest. Fix common accessibility problems has every fix.

The Accessibility check window lists 7 problems found on the demo. The first, Pictures with no text alternative, is open, with why it matters, how to fix it, the code before and after, and the buttons Show on the page and Report this.

Add it

The quickest way is the set-up tool: choose what you want, then copy the code, or one prompt that has your AI assistant add everything. By hand:

  1. Copy snaglist.js into the folder your site serves files from.

  2. Add one line before </body>, with the GitHub repository reports should go to:

    <script src="/snaglist.js" data-github="owner/repo" defer></script>

    Or start it yourself, with any of the settings in the settings reference:

    <script src="/snaglist.js"></script>
    <script>
      Snaglist.start({
        app: "My app",
        language: "en-US",
        types: ["bug", "confusing", "feature", "check"],
        send: { github: { repo: "owner/repo" }, email: { to: "team@example.com" } },
      });
    </script>
  3. Add data-component="checkout-summary" to the main parts of your pages so reports name them, and data-snag-private to anything that shows personal details.

Activate, deactivate or remove it

  • For everyone: set enabled: false to deactivate it, or activate it only in test builds.
  • For each user: give them a switch. Snaglist.setUserEnabled(false) hides the button and remembers the choice in that browser. Read Add a switch for your users.
  • Remove it: delete the script tags and snaglist.js. Snaglist.destroy({ forget: true }) removes it from a running page, puts back anything it wrapped, and clears its saved setting.

Sending

Way How Needs
GitHub Opens a new issue with the title, report and labels filled in. The person posts it from their own account A GitHub account for the person reporting
Email Opens their mail app with the report filled in A mail app
Your server Posts the report as JSON, without cookies An address that accepts it; Send reports to your own server has an example that files GitHub issues for anyone
QR code Shows the same GitHub issue as a QR code with the link as text, for a computer that is not online. It comes first when the computer seems to be offline. A long report goes in shorter, and the view says what it holds The same as GitHub, and a phone
Copy as Markdown and Download as JSON Markdown on the clipboard, or a JSON file Nothing

No token or password is ever put in the page.

Help

The help centre has guides from start to finish and a topic for each task:

Security says how Snaglist protects people, what its security check found and fixed, and which tests pass.

Building with an AI assistant? The set-up tool writes one prompt with your choices, Prompts for AI assistants has more, and llms.txt is a short summary written for AI tools.

Part of a family

Snaglist began as the UX notes tool in the design system shared by Storyarr and Starboard, and uses its design tokens when a page has them.

Licence

MIT. Read the licence. The flag and close icons are from Lucide (ISC). The optional axe-core engine is Deque's, under the Mozilla Public License 2.0, and is loaded only when chosen.

About

Feedback for any website or app: bug reports, UX problems, suggestions and accessibility checks, tagged with the page and the part of it, without personal information. One file, no libraries.

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages