Contents

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.

sideby s sideby sideby
<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) or variant="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 is h-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

PropTypeDefaultWhat it does
variant"wordmark" or "mark""wordmark"Which asset slot to draw
labeltext"sideby"The accessible name. Ignored when decorative
decorativebooleanfalseHides the logo from assistive technology. Use it when something around the logo already names it
classclassesMerged 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>.

FileFormatPixel sizeUsed by
wordmark.svgSVG, viewBox onlyscalesLogo, inlined into the page
mark.svgSVG, square viewBoxscalesLogo variant="mark", inlined into the page
favicon.svgSVG, standalone64 x 64 viewBoxThe browser tab icon
favicon-32.pngPNG32 x 32Tab icon for browsers without SVG favicons
apple-touch-icon.pngPNG180 x 180The home-screen icon on iPhone and iPad
og.pngPNG1200 x 630The preview image when a link is shared

Swapping in the real logo

  1. Replace the file in packages/ui/src/lib/brand/assets/. Keep the exact name and format.
  2. Keep the pixel sizes for the PNGs. Keep the inline SVGs viewBox-only, with no width or height.
  3. 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 Logo component, 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.