Skip to content

radeqq007/ripple-ui

Repository files navigation

ripple-ui

NPM Version License downloads CI Last commit GitHub stars

A shadcn/ui inspired component library for Ripple TS.

Getting started

1. Initialize

npx rippleui-cli init

This will:

  • Detect your tailwind setup and import alias defined in the vite configuration
  • Ask you to choose a base color and an accent theme
  • Write a components.json config file
  • Inject CSS variables and theme tokens into your main CSS file

2. Add components

npx rippleui-cli add <components...>

Components and their dependencies are copied into your src/components/ directory.

3. Browse available components

npx rippleui-cli list

4. See what's installed

npx rippleui-cli installed

Available components

  • button
  • checkbox
  • input
  • select
  • label
  • utils

Theming

Base colors:

  • stone
  • zinc
  • slate

Accent themes:

  • neutral
  • blue
  • violet
  • rose
  • orange

components.json

Generated during initialization:

{
  "aliases": {
    "components": "@/components",
    "utils": "@/utils"
  },
  "directories": {
    "components": "src/components",
    "utils": "src/utils"
  },
  "css": "src/index.css",
  "installed": []
}

About

shadcn/ui inspired component library for Ripple TS

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

 
 
 

Contributors