Skip to content

marom99/QDSV2

 
 

Repository files navigation

QW Design System

A design system and React component library for building modern web applications.

QW provides accessible, design-system-compliant UI components built on Base UI. It handles keyboard navigation, focus management, and ARIA attributes so you can build accessible applications without thinking through every detail.

image

Installation

pnpm add @qw/design-system

Peer Dependencies

pnpm add react react-dom @phosphor-icons/react

Usage

import { Button, Input, Dialog } from "@qw/design-system";
import "@qw/design-system/styles";

Granular Imports (Tree-Shaking)

import { Button } from "@qw/design-system/components/button";

Base UI Primitives

QW re-exports all Base UI primitives for advanced use cases:

import { Popover } from "@qw/design-system/primitives/popover";

CLI

Query component documentation from the command line:

npx @qw/design-system ls          # List all components
npx @qw/design-system doc Button  # Get component docs
npx @qw/design-system docs        # Get all docs

Development

See AGENTS.md for comprehensive development documentation including:

  • Component patterns and styling system
  • Semantic color tokens
  • Development workflows
  • CI/CD pipeline
  • Figma plugin

Quick Start

pnpm install
pnpm dev                    # Start docs site at localhost:4321
pnpm --filter @qw/design-system test

Figma Plugin

# Optional: enable token sync during build
# cp packages/qw-figma/scripts/.env.example packages/qw-figma/scripts/.env
# $EDITOR packages/qw-figma/scripts/.env  # set FIGMA_TOKEN (and optionally FIGMA_FILE_KEY)

pnpm --filter @qw/design-system-figma build
# In Figma: Plugins > Development > Import plugin from manifest...
# Select: packages/qw-figma/src/manifest.json

Creating Components

pnpm --filter @qw/design-system new-component

Documentation

About

QDS based on kumo

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 85.3%
  • MDX 7.9%
  • JavaScript 3.3%
  • Astro 1.8%
  • CSS 1.3%
  • Shell 0.3%
  • Other 0.1%