Skip to content

programming-with-ia/shadcn-theme-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

34b931b Β· Feb 9, 2025

History

61 Commits
Nov 8, 2024
Sep 27, 2024
Nov 15, 2024
Jan 20, 2025
Nov 9, 2024
Aug 23, 2024
Feb 9, 2025
Aug 22, 2024
Dec 10, 2024
Nov 15, 2024
Nov 12, 2024
Feb 9, 2025
Feb 9, 2025
Nov 10, 2024
Aug 17, 2024
Aug 13, 2024
Sep 16, 2024
Nov 15, 2024

Repository files navigation

Shadcn Theme Editor

Effortless Shadcn Theme Customization Made Simple.

β—¦ Manage Shadcn theme colors with an intuitive UI.

Next.js React TypeScript

git-last-commit GitHub commit activity GitHub top language

minified size

NPM Version GitHub


πŸ“ Overview

Shadcn Theme Editor is a user-friendly component designed to simplify the process of managing and customizing theme colors in Shadcn-based projects. This package provides an intuitive UI with buttons for different color properties, allowing developers to easily adjust and preview theme colors in real-time. Although the package is optimized for ease of use, its build size is substantial, so it is recommended to install it as a development dependency. This tool empowers developers to create consistent, visually appealing themes without diving into complex CSS, making it an essential addition to your Shadcn toolkit.


πŸš€ Getting Started

Installation

To install the package as a development dependency, use one of the following commands:

npm:

npm install shadcn-theme-editor --save-dev
yarn add shadcn-theme-editor --dev
pnpm add shadcn-theme-editor --save-dev

πŸ“– Usage

import default and add in app/layout.tsx file

import ShadcnThemeEditor from "shadcn-theme-editor";

or (in this way, it doesn't include the component in the production build)

let ShadcnThemeEditor: any;
if (process.env.NODE_ENV === 'development') {
  import('shadcn-theme-editor').then(module => {
    ShadcnThemeEditor = module.default; // or module, depending on the module's export
  });
} else {
  // eslint-disable-next-line react/display-name
  ShadcnThemeEditor = ()=>null
}

and use

<ShadcnThemeEditor />

Screenshots

logo

usage.md

Upcoming Features

Special Thanks

I would like to extend my heartfelt thanks to the following individuals and projects:

πŸ“„ License

This project is licensed under the ℹ️ MIT License.