https://github.com/mistakenelf/tails-ui

:monkey: Clean UI based on tailwindcss
https://github.com/mistakenelf/tails-ui

react rollup styled-components tailwindcss

Last synced: 3 months ago
JSON representation

:monkey: Clean UI based on tailwindcss

• Host: GitHub
• URL: https://github.com/mistakenelf/tails-ui
• Owner: mistakenelf
• License: mit
• Created: 2017-06-13T20:43:11.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-26T16:40:18.000Z (almost 7 years ago)
• Last Synced: 2024-05-21T00:58:50.392Z (8 months ago)
• Topics: react, rollup, styled-components, tailwindcss
• Language: OCaml
• Homepage:
• Size: 1.52 MB
• Stars: 197
• Watchers: 8
• Forks: 11
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Tails-UI

React UI components using **tailwindcss**

## Components:

- Alert

- Article

- Box

- Breadcrumbs

- Button

- Card

- CodeBlock

- DangerousHTML

- Dropdown

- Flex

- ImageCarousel

- Loader

- MegaFooter

- Modal

- Navbar

- Panel

- Portal

- ProgressBar

- RenderIf

- Select

- Space

- Tab

- Table

- Tabs

- Text

- TextArea

- TextField

- TruncateText

## Installation:

`npm i tails-ui`

## Usage:

- Make sure to import the tails-ui css file `import 'tails-ui/dist/index.css'`

- Documentation site is coming soon with all the component api's

``` js

import React from 'react'

import { Button } from 'tails-ui'

const Button = () => (

  

    Submit

  

)

export default Button

```

## Running Locally:

- You can run `npm link` inside **tails-ui** and then `npm link tails-ui` inside a project you have created to test the components locally.

- You can run `npm start` to start **tails-ui** in watch mode and it will compile any new components you add.

- `npm test` will run jest