Skip to content
Star on GitHub
DocsInstallation
Style
Accent
Sound

Built by DesignMe, free to use under the MIT licence.

Expert design and dev support for startups and enterprises.

Book a call

Installation

Add components with the designme CLI. It copies their source into your project, so you own it.

Before you start

  • Node 18 or later

    To run the CLI.

  • React 19

    For the React components.

Find a component's install name on its page, or list them all:

Terminal
npx designme list

Add components

  1. Add them

    Terminal
    npx designme add status-pill thinking composer

    Each component lands in its own folder in ./designme, with its .html, .css and .js. The shared core, core/core.css and core/core.js, is added once. Every component also gets a demo.html you can open straight away.

    Your project
    • designme/
      • core/
        • core.css
        • core.js
      • status-pill/
        • status-pill.html
        • status-pill.css
        • status-pill.js
        • demo.html
      • thinking/
        • thinking.html
        • thinking.css
        • thinking.js
        • demo.html
      • composer/
        • composer.html
        • composer.css
        • composer.js
        • demo.html
  2. Load them in a page

    Load the core and the component's files, and copy in the markup from its .html:

    HTML
    <link rel="stylesheet" href="designme/core/core.css">
    <link rel="stylesheet" href="designme/status-pill/status-pill.css">
    
    <!-- the markup from designme/status-pill/status-pill.html -->
    
    <script src="designme/core/core.js"></script>
    <script src="designme/status-pill/status-pill.js"></script>
  3. Give them your data

    The core renders each component when it scrolls into view and plays its demo. To feed one your own data, change its .js, or use the React version, which takes props.

Every class, CSS variable and animation name starts with dm-, so the components sit beside Tailwind, shadcn/ui or your own CSS without clashing.

Frameworks

  • Next.js

    App Router: every component file starts with 'use client', so you can render them from server components.

    Pages Router: import designme.css and each component's .css in pages/_app.tsx, and delete the two CSS imports at the top of those components.

  • React with Vite

    Nothing extra to set up.

  • Astro

    Add the React integration with npx astro add react. Hydrate the components that change over time, for example with client:visible.

Options

OptionWhat it does
--reactReact components instead of HTML, CSS and JavaScript
--examplesWith --react, an example beside each component that replays its demo from designme.dev
--dir <path>Put the files somewhere else
--forceReplace files you already have

The CLI downloads each component from designme.dev and skips files that are already there. --force replaces them with the current version, including any changes you made.

This page as Markdown: installation.md