https://github.com/stevenfitzpatrick/fitzy

🤘 React UI Components Library
https://github.com/stevenfitzpatrick/fitzy

component-library css-in-js emotion es6 react

Last synced: 3 days ago
JSON representation

🤘 React UI Components Library

• Host: GitHub
• URL: https://github.com/stevenfitzpatrick/fitzy
• Owner: stevenfitzpatrick
• License: mit
• Created: 2017-11-18T23:38:15.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-15T22:55:04.000Z (over 6 years ago)
• Last Synced: 2024-04-28T22:20:56.573Z (8 months ago)
• Topics: component-library, css-in-js, emotion, es6, react
• Language: JavaScript
• Homepage: https://fitzy-ui.com
• Size: 1.29 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fitzy

[![npm](https://img.shields.io/npm/v/fitzy.svg)](http://npm.im/fitzy)

[![CircleCI](https://circleci.com/gh/stevenfitzpatrick/fitzy/tree/master.svg?style=shield)](https://circleci.com/gh/stevenfitzpatrick/fitzy/tree/master)

[![coveralls](https://img.shields.io/coveralls/stevenfitzpatrick/fitzy/master.svg)](https://coveralls.io/github/stevenfitzpatrick/fitzy)

![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)

Library of common React UI Components, ready to plug into your website. Uses Emotion CSS-in-JS Library for styles.

## Table of content

* [Getting Started](#getting-started)

* [Usage](#usage)

* [Components](#components)

  * [Tabs](#tabs)

* [Build With](#build-with)

* [Author](#author)

* [Licence](#licence)

* [Links](#links)

## 💻 Getting Started

Follow these instructions to include the Fitzy Library to your website.

First include the dependency in your project.

Fitzy is available as an [npm package](https://www.npmjs.com/package/fitzy).

```bash

$ npm install fitzy --save

```

> This library depends on `react`,`prop-types` and `Emotion`. Please make sure you

> have those installed as well.

## 📦 Usage

The `fitzy` library provides both named and default exports, so you can import everything or just what you need. I would recommend just to import what you need for smaller bundle sizes.

##### Named:

```js

import { Input, Tabs } from 'fitzy';

```

##### Default:

```js

import Fitzy from 'fitzy';

```

## 🎁 Components

### Tabs

## Built With

* [React](https://github.com/emotion-js/emotion) - The javascript library used.

* [Emotion](https://github.com/facebook/react) - CSS-in-JS Library for styling.

* [Jest](https://github.com/facebook/jest) - Test Framework.

* [Styleguidist](https://github.com/styleguidist/react-styleguidist) - React component development library.

## 👊 Author

* Steven Fitzpatrick [@Fitzy_longhorn](https://twitter.com/Fitzy_longhorn)

## 📃 License

This project is licensed under the MIT License - see the [Licence.md](Licence.md) file for details.

## 📜 Change log

The change log can found on the [releases](https://github.com/stevenfitzpatrick/fitzy/releases) page.

## ✍️ Contributions

Feel free to contribute and submit pull requests.test

## 🔗 Links

* [Website](https://fitzy-ui.com)

* [Author Website](https://stevenfitzpatrick.io)