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: 9 months ago
JSON representation
Add, update and delete your shadcn/ui components without leaving your IDE
- Host: GitHub
- URL: https://github.com/warningimhack3r/intellij-shadcn-plugin
- Owner: WarningImHack3r
- Created: 2023-12-16T21:51:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T11:48:30.000Z (over 1 year ago)
- Last Synced: 2024-12-02T12:32:11.731Z (over 1 year ago)
- Topics: intellij-plugin, shadcn-ui
- Language: Kotlin
- Homepage:
- Size: 2.14 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# intellij-shadcn-plugin
[](https://github.com/WarningImHack3r/intellij-shadcn-plugin/actions)
[](https://plugins.jetbrains.com/plugin/23479-shadcn-ui-components-manager)
[](https://plugins.jetbrains.com/plugin/23479-shadcn-ui-components-manager)
## 1.0.0 roadmap
- Add support for Svelte/Vue's `typescript` option, as well as React/Solid's `tsx` option, by transpiling TypeScript
into JavaScript in `.svelte`, `.vue`, `.tsx`, and `.ts` files (#54)
> [!NOTE]
> shadcn 2.0 and 3.0 integrations would also be great for 1.0, but as they are not critical features, they could very
> well be postponed.
## 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