tibui

A React UI component library built with TypeScript, Tailwind CSS, and Radix UI.

Installation

From GitHub

# Install version 1.0.0, select any version here
npm install github:tiberius-grail/tibui#v1.0.0

Local Development

1. Clone and run the dev server:

git clone https://github.com/tiberius-grail/tibui.git
cd tibui
npm install
npm run dev

2. In your consuming project's package.json, reference the local path:

{
  "dependencies": {
    "tibui": "file:/path/to/tibui"
  }
}

Then run npm install in your project. Changes to tibui will be picked up automatically.

Usage

Import Components

import { Button, Tabs, Toggle, TextField, DataTable } from 'tibui'

Import Styles

In your CSS or main entry file:

@import 'tibui/theme.css';

Or in JavaScript/TypeScript:

import 'tibui/theme.css'

Development

# Install dependencies
npm install

# Build
npm run build

# Watch mode
npm run dev

# Type check
npm run typecheck

Storybook

This library uses Storybook for component development and documentation.

Running Storybook

Start the Storybook development server:

npm run storybook

This will start Storybook at http://localhost:6006 where you can browse and interact with all components.

Building Storybook

Build a static version of Storybook for deployment:

npm run build-storybook

This outputs a static site to the storybook-static directory, which can be deployed to any static hosting service.

Releasing

Install a specific version

# Install by tag
npm install github:tiberius-grail/tibui#v1.0.0

# Install by commit hash
npm install github:tiberius-grail/tibui#abc1234

# Install latest from main
npm install github:tiberius-grail/tibui#main

Creating a new release

The easiest way to create a release is using the release script:

npm run release

This will:

1. Check for uncommitted changes
2. Prompt you to choose a version bump (patch, minor, major)
3. Update package.json
4. Create a git tag
5. Push everything to GitHub

Manual release

If you prefer to release manually:

1. Make sure all changes are committed and pushed:

git add .
git commit -m "your commit message"
git push

2. Create a tag:

git tag v1.0.0

3. Push the tag to GitHub:

git push origin v1.0.0

Tag management

# List all tags
git tag

# Delete a local tag
git tag -d v1.0.0

# Delete a remote tag
git push origin --delete v1.0.0

# Create annotated tag with message
git tag -a v1.0.0 -m "Release v1.0.0"