Brand
Logo
One component, a handful of asset slots, and a logo that drops in by swapping files.
The wordmark you see in the header is a typeset stand-in: sideby in Space Grotesk. The final logo arrives later. When it does, it replaces files, not code.
Using it
Import Logo from @sideby/ui/logo. With no props it draws the wordmark, named “sideby” for assistive technology.
<script>
import { Logo } from "@sideby/ui/logo";
</script>
<Logo />
<Logo variant="mark" class="h-10" />
<Logo class="h-10" />
<Logo class="h-6 text-muted-foreground" /> - Wordmark or mark.
variant="wordmark"(the default) orvariant="mark", a single glyph in a square, for tight spots like small badges and app icons. - Size with a height. Set a height utility (
h-6,h-10); the width follows the logo’s own proportions. The default height ish-6. - Colour comes from the text colour. The artwork draws in
currentColor. It’s the foreground colour by default; pass a neutral text class to quiet it. It is never the accent. - Inside a link, make it decorative. The link carries the name, and the logo hides from assistive technology so the name isn’t read twice.
<a href="/" aria-label="sideby design system, home">
<Logo decorative class="h-8" />
</a> Props
| Prop | Type | Default | What it does |
|---|---|---|---|
variant | "wordmark" or "mark" | "wordmark" | Which asset slot to draw |
label | text | "sideby" | The accessible name. Ignored when decorative |
decorative | boolean | false | Hides the logo from assistive technology. Use it when something around the logo already names it |
class | classes | Merged onto the root; use it for height and text colour |
Asset slots
Every brand file sits in packages/ui/src/lib/brand/assets/ and ships as @sideby/ui/brand/assets/<file>.
| File | Format | Pixel size | Used by |
|---|---|---|---|
wordmark.svg | SVG, viewBox only | scales | Logo, inlined into the page |
mark.svg | SVG, square viewBox | scales | Logo variant="mark", inlined into the page |
favicon.svg | SVG, standalone | 64 x 64 viewBox | The browser tab icon |
favicon-32.png | PNG | 32 x 32 | Tab icon for browsers without SVG favicons |
apple-touch-icon.png | PNG | 180 x 180 | The home-screen icon on iPhone and iPad |
og.png | PNG | 1200 x 630 | The preview image when a link is shared |
Swapping in the real logo
- Replace the file in
packages/ui/src/lib/brand/assets/. Keep the exact name and format. - Keep the pixel sizes for the PNGs. Keep the inline SVGs
viewBox-only, with nowidthorheight. - Rebuild with
pnpm build. That’s it: no code changes anywhere.
The inline SVGs should keep fill="currentColor" so the logo follows the theme. A logo that needs fixed colours can carry them; it will just look the same in both themes. The favicon and PNGs render outside the page, so they always carry fixed colours.
Tokens never depend on the logo. The stand-in assets take their colours from the tokens, never the other way round. A new logo must never need a token change.
Do
- Use the
Logocomponent, never a copied SVG or an image tag. - Let it take the text colour: foreground, or a quieter neutral.
- Give it room. Keep at least its own height of empty space around it.
Don’t
- Recolour it with the accent. The accent is for actions and the current item, not for the brand mark.
- Stretch or squash it. Set a height and let the width follow.
- Add effects: no shadows, glows, outlines or gradients.
- Put it on busy imagery, like a video frame or a photo. Give it a flat surface.