Design resources and tools
Everything in the TRex Design System that you can use in your own work, and how to change it and test it.
The TRex Design System is the one source of the components, tokens, icons and guides for Storyarr and Starboard. It is public: you may use any of it in your own projects, under the licences on this page.
What you can use
Component gallery
Every component working, in four themes and five text sizes, with the classes to copy.
Tokens
Every colour, size, space and motion value as role names, in
tokens.css, for Light, Dark, High contrast and High contrast dark.Accent colours
Six more accent colours over Mica's greys: Teal, Indigo, Forest, Plum, Ember and Graphite. Load one after
tokens.css.Icons
Lucide icons as one SVG file,
icons.svg. Use an icon with<use href="#i-book-open">.Font
Atkinson Hyperlegible Next, made to be clear for people with low vision, in
fonts/.Storyarr design boards
Every area of Storyarr as a full page, built only from the library.
Starboard design boards
Every area of Starboard as a full page, built only from the library.
Guides
The guides are in the docs folder of the repository.
| Guide | Read it when |
|---|---|
| Content design guide | You write any words: a button, an error, a setting, release notes |
| Help writing guide | You write or check help, or ask an AI assistant to |
| Changelogs | You add a change to a changelog or release a version |
| Accessibility guide | You build or test anything; it sets the floor every page must meet |
| Meeting WCAG 2.2 | You need to know how a WCAG point is met, and what your page must still do |
| Writing text descriptions (alt text) | You add an image, an icon button, a chart or a screenshot |
| Screenshots in help | You add or replace a screenshot in help, or ask an AI tool to: when one earns its place, made-up data, the mark-up and a short version for AI tools |
| Security checks guide | You release an app: the checks to run, how to sort what they find, and how to record the results |
| Design system guide | You lay out a page: principles, tokens, the header and page templates |
| Component reference | You need a class name, or must choose between a slide-out, a dialog and a page |
On these pages
Tools in this repository
What each script does and the command that runs it: build, contrast, palettes, icons, sync and the privacy check.
Outside tools for accessibility and testing
Contrast checkers, automatic checks, screen readers, magnifiers and voice control.
Make a change
The steps from pulling the latest version to the change reaching both apps.
Get feedback
Testing with real people, automatic checks, and feedback in the product with Snaglist.
Licences
You may copy, change and share everything here, including in paid work, as long as you keep the credit and the licence.
- Code (CSS, JavaScript, HTML and the tools): MIT licence.
- Guides and documentation: CC BY 4.0. Give credit to the TRex Design System, link to the licence and say whether you made changes.
- Font: Atkinson Hyperlegible Next, SIL Open Font License 1.1.
- Icons: Lucide, ISC licence.