Link them from a CDN
The quickest start: put these lines in the <head> of a page, the script before </body> or with defer, and write HTML.
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/trayui@0.2.0/tokens.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/trayui@0.2.0/components/bundle.css">
<script src="https://cdn.jsdelivr.net/npm/trayui@0.2.0/components/bundle.js" defer></script>jsDelivr serves every release of the trayui package on npm, and the address names the release, so a page keeps the version it was built with. For production, copy the files into your project or pin the release you tested.
Or install them from npm
In a project with a bundler, install the package and import the three files once, at the entry of the app:
npm install trayuiimport 'trayui/tokens.css';
import 'trayui/components/bundle.css';
import 'trayui/components/bundle.js';The package also holds the font, the blocks and the tokens for Tailwind and Figma. For React, see React.
Or get the files
Download trayui-0.2.0.zip and unpack it beside your pages.
trayui/
tokens.css every token as a custom property, the type classes, the font
components/bundle.css the tray- classes
components/bundle.js behaviours and the icons
fonts/ the typeface (Onest-Variable.ttf and .woff2), with its licence (OFL.txt)
blocks/ 64 screens to copy
tailwind/ the tokens as a Tailwind theme (version 4) and a preset (version 3)
figma/ the tokens as Figma variables, a mode for each themeThe last two folders are for Tailwind and Figma; a page in plain HTML needs neither.
Link them
In this order, in every page:
<!doctype html>
<html lang="en" data-theme="light">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="trayui/tokens.css">
<link rel="stylesheet" href="trayui/components/bundle.css">
</head>
<body>
…your page…
<script src="trayui/components/bundle.js"></script>
</body>
</html>The script is one classic file. It assigns window.TrayUI, adds the icon sprite to the page and wires up every element that carries a data-tray attribute. It loads nothing from the network. If you add markup after the page has loaded, call TrayUI.init(root) on it.
Write a first screen
<main class="tray-container tray-section">
<div class="tray-card tray-stack">
<h1 class="title">Order a jar</h1>
<div class="tray-field">
<label class="tray-label" for="address">Delivery address</label>
<input class="tray-input" id="address" autocomplete="street-address">
</div>
<button class="tray-btn" type="submit">Order a jar</button>
</div>
</main>That is a grey tray on the white page, a white field in it, and the one yellow button. From here, copy a block (the files in blocks/ open as they are) or look up a component.
Sizes
| File | Compressed |
|---|---|
tokens.css | 1 KB |
components/bundle.css | 36 KB |
components/bundle.js | 42 KB |
Browsers
The current versions of Chrome, Edge, Safari and Firefox. The stylesheet uses logical properties, :has(), dynamic viewport units and the native <dialog> and <details> elements; it has no fallbacks for browsers without them.
The font
Onest is a variable font by the Onest Project Authors, under the SIL Open Font License 1.1; the licence text is in fonts/OFL.txt. To use another typeface, see Theming.
Licence
Tray UI is released under the MIT licence.