0.1.3 ⢠Published 4 months ago
hb-hummingbird v0.1.3
hb-hummingbird
hb-hummingbird is a modern UI component library built with Tailwind CSS, designed to help developers quickly build beautiful and responsive user interfaces.
š Features
- Tailwind-based components for easy styling.
- Modular and lightweight design.
- Supports ESM and CJS imports.
- Optimized CSS & JS builds.
- Compatible with Astro and Vite.
š¦ Installation
Install via npm:
npm install hb-hummingbird
Or via yarn:
yarn add hb-hummingbird
š Usage
Import in JavaScript/TypeScript
ESM Import
import { ComponentName } from "hb-hummingbird";
CommonJS Import
const { ComponentName } = require("hb-hummingbird");
Include the CSS
In your index.css
or main entry file:
@import 'hb-hummingbird/dist/hummingbird.min.css';
š Scripts
Development
npm run dev # Start Astro dev server
Build
npm run build:dist # Build the library & CSS
npm run build:astro # Build the Astro documentation
npm run build:js # Compile TypeScript and JS
npm run build:css # Generate CSS
npm run build:css:min # Generate minified CSS
š Folder Structure
.
āāā src/ # Source files
āāā lib/ # Compiled JS (ESM & CJS)
āāā dist/ # Compiled CSS
āāā docs/ # Documentation
āāā README.md
š Repository
Find the source code and contribute on GitHub: GitHub Repository
š License
This project is licensed under the MIT License.