HashtagCMS Admin UI Kit

Welcome to the official HashtagCMS Admin UI Kit monorepo. This repository houses the core modular logic, UI components, and utility libraries that power the HashtagCMS ecosystem.

📦 Package

Everything is bundled into a single NPM package for easier consumption.

| Package | Description | Version | | :------------------------------------------ | :---------------------------------------------------------- | :------ | | @hashtagcms/admin-ui-kit | Unified Library containing Themes (Neo/Modern) and Helpers. | 1.0.9 |

Note: The package is structured as a monorepo with specialized themes in packages/themes and shared logic in packages/helpers.

🚀 Getting Started

Installation

npm install @hashtagcms/admin-ui-kit

Usage

Components & Helpers:

import {
  ActionBar, // Components
  AdminConfig,
  Toast, // Helpers
} from "@hashtagcms/admin-ui-kit";

Styles:

// Option 1: Modern Theme (Tailwind v4 based - Lean)
@import "~@hashtagcms/admin-ui-kit/dist/modern/admin-ui-kit.min.css";

// Option 2: Neo Theme (Bootstrap 5 based - Legacy)
@import "~@hashtagcms/admin-ui-kit/dist/neo/admin-ui-kit.min.css";

// Option 3: Source SCSS (For deep customization)
@import "~@hashtagcms/theme-modern/src/scss/app";

Documentation

Detailed guides for every part of the library:

• Getting Started: Installation, setup and usage.
• Components Guide: Component API and examples.
• Helpers Guide: Utilities and helpers documentation.
• API Reference: Technical overview of exports and architecture.
• Theme Development: Guide for contributing to themes or creating new ones.

🛠️ Development

This project uses NPM Workspaces to manage dependencies.

• Linting: Ensure code quality standards are met.
• Testing: Run unit tests with npm run test.
• Playground: Interactive dev environment. Run npm run playground and visit http://localhost:3000.

🤝 Contributing

We welcome contributions! Please see our Contribution Guide for details.

📄 License

This project is licensed under the MIT License.

Built with ❤️ by HashtagCMS.