Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/warningimhack3r/intellij-shadcn-plugin

Add, update and delete your shadcn/ui components without leaving your IDE
https://github.com/warningimhack3r/intellij-shadcn-plugin

intellij-plugin shadcn-ui

Last synced: 23 days ago
JSON representation

Add, update and delete your shadcn/ui components without leaving your IDE

Awesome Lists containing this project

README

        

# intellij-shadcn-plugin

![Build](https://github.com/WarningImHack3r/intellij-shadcn-plugin/workflows/Build/badge.svg)
[![Version](https://img.shields.io/jetbrains/plugin/v/com.github.warningimhack3r.intellijshadcnplugin.svg)](https://plugins.jetbrains.com/plugin/com.github.warningimhack3r.intellijshadcnplugin)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/com.github.warningimhack3r.intellijshadcnplugin.svg)](https://plugins.jetbrains.com/plugin/com.github.warningimhack3r.intellijshadcnplugin)

## 1.0.0 roadmap

- Add support for Vue `typescript` option (transpiling TypeScript to JavaScript as well as in `*.vue` files)
- See https://github.com/radix-vue/shadcn-vue/issues/378
- Add support for React/Solid (UI) `tsx` option (transpiling TypeScript to JavaScript)

## Description

Manage your shadcn/ui components in your project. Supports Svelte, React, Vue, and Solid.

This plugin will help you manage your shadcn/ui components through a simple tool window. Add, remove, update them with a
single click.
**This plugin will only work with an existing `components.json` (or `ui.config.json` for Solid UI) file. Manually copied components will not be detected
otherwise.**

## Features

- Automatically detect shadcn/ui components in your project
- Instantly add, remove, update them with a single click
- Refreshes on opening the tool window
- Supports _all_ shadcn/ui implementations: Svelte, React, Vue, and Solid
- Browse available components
- Easily search for remote or existing components
- ...and more!

## Planned Features

- Support monorepos with multiple `components.json` files
- Allow initializing a shadcn/ui implementation within an existing project
- Add/improve support for the horizontal tool window layout

## Usage

Simply open the `shadcn/ui` tool window and start managing your components.
If you don't see the tool window, you can open it from `View > Tool Windows > shadcn/ui`.
**When adding or removing components, the tool window won't refresh automatically yet. You can refresh it by closing and
reopening it.**

## Planned Features

- Add a button to open the docs of a component in the `Add component` panel
- Initialize the CLI if not existing yet?
- Add diff mechanism to components (remove spaces, \n, \t, \r, etc.?)
- Parse `vite.config.(js|ts)` (and others like `nuxt.config.ts`) to resolve aliases as a fallback of `tsconfig.json`
- Figure out a clean way to refresh the tool window automatically after adding or removing components
- Refresh/recreate the tool window automatically when the project finishes indexing
- Add support for monorepos

## Installation

- Using the IDE built-in plugin system:

Settings/Preferences > Plugins > Marketplace > Search for "
intellij-shadcn-plugin"
>
Install

- Manually:

Download the [latest release](https://github.com/WarningImHack3r/intellij-shadcn-plugin/releases/latest) and install
it manually using
Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

---
Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template