https://github.com/maniruzzamanakash/tailbit

A Simple But beautiful Component Library for Tailwind CSS using React and Typescript
https://github.com/maniruzzamanakash/tailbit

react react-components reactjs tailwind tailwind-components tailwindcss tailwindui typescript

Last synced: 2 months ago
JSON representation

A Simple But beautiful Component Library for Tailwind CSS using React and Typescript

• Host: GitHub
• URL: https://github.com/maniruzzamanakash/tailbit
• Owner: ManiruzzamanAkash
• Created: 2022-03-29T09:22:51.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-09T10:36:34.000Z (almost 3 years ago)
• Last Synced: 2024-03-25T03:45:42.613Z (11 months ago)
• Topics: react, react-components, reactjs, tailwind, tailwind-components, tailwindcss, tailwindui, typescript
• Language: HTML
• Homepage: https://maniruzzamanakash.github.io/tailbit/storybook-static/
• Size: 2.12 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# TailBit

TailBit - A Simple But beautiful Component Library for Tailwind CSS using React and Typescript

**Component Documentation** - https://maniruzzamanakash.github.io/tailbit/storybook-static/

**NPM Directory** - https://www.npmjs.com/package/tailbit

> Note: Not Production Ready yet.

-----

## Installation

```sh

npm i tailbit

```

## How to Use

#### Button Component

**Simple Button**

```tsx

import { Button } from 'tailbit';

```

**Button with Custom Design**

```tsx

import { Button } from 'tailbit';

 { console.log('clicked)}}

    text="Custom Button Example"

/>

```

**Button with Font Awesome Icon & Outline**

```tsx

import { Button } from 'tailbit';

import { faPlusCircle } from '@fortawesome/free-solid-svg-icons';

 {}}

    outline

    text="Icon Button Left"

    type="primary"

/>

```

## Storybook Documentation

```sh

npm run storybook

```

It will open your browser window the documentation of our library at http://localhost:6006

## Changelog

`v0.0.5` - **9 April 2022**

    - [Doc] Added documentation for `Button` Component

`v0.0.4` - **9 April 2022**

    - [Fix] Fixed tailwind style was not loading

`v0.0.3` - **9 April 2022**

    - [Fix] Fixed a `package.json` peerDependency issue

`v0.0.2` - **9 April 2022**

    - [Add] Added Storybook Documentation

`v0.0.1` - **29 March 2022**

    - [Add] Added Button Component

## Contribution

It's open to contribute in Tailbit.

Just create a `Pull Request` with your bug request, feature or new component.