Heddy UI Library

A modern React UI component library built with TypeScript, Vite, and Storybook. Easily import and use pre-built, production-ready components in your React applications.

Features

• 🚀 Pre-built Components: Ready-to-use React components
• 📘 TypeScript Support: Full type safety and IDE autocomplete
• 🎨 Customizable: Easy to style and extend
• 📚 Storybook Integration: Interactive component documentation
• 🧪 Tested: Comprehensive test coverage
• 📦 ESM & UMD: Works with modern and legacy build systems

Installation

npm install @heddy/ui-library
# or
yarn add @heddy/ui-library
# or
pnpm add @heddy/ui-library

Quick Start

import { Button } from '@heddy/ui-library';

export default function App() {
  return (
    <Button onClick={() => console.log('Clicked!')}>
      Click me
    </Button>
  );
}

Available Components

• Button: A versatile button component
• (More components coming soon...)

Documentation

Visit the Storybook documentation for interactive component examples and API reference.

npm run storybook

Development

Setup

npm install

Run Storybook

npm run storybook

Build

npm run build

Lint

npm run lint

Publishing to NPM

Prerequisites

1. Create an npm account at npmjs.com
2. Update the package.json with your information:
   • Change the author field
   • Update the repository URL
   • Update the bugs URL
   • Update the homepage URL

Steps to Publish

1. Build the library:

   npm run build

2. Test locally (optional):

   npm link
   # In another project:
   npm link @heddy/ui-library

3. Login to npm (first time only):

   npm login

4. Update version in package.json:

   npm version patch  # or minor, major

5. Publish:

   npm publish

   Or use the shortcut script:

   npm run pub

Versioning

• patch (0.0.X): Bug fixes, backward compatible
• minor (0.X.0): New features, backward compatible
• major (X.0.0): Breaking changes

Using in Other Projects

After publishing, use your components in other projects:

npm install @heddy/ui-library

Or if using a specific version:

npm install @heddy/[email protected]

License

MIT

Support

For issues and feature requests, please use the GitHub Issues page.