Home

Awesome

Fannypack

All Contributors Build Status NPM

<p align="center"><img src="./logo.png" width="500px"></img></p>

Fannypack v4 Branch

Fannypack v4 Docs

Fannypack v5 Docs

Installing Fannypack

Run the following command to install Fannypack:

yarn add fannypack

Getting set up

To start using the components, please follow these steps:

  1. Wrap your application in a <ThemeProvider> which is provided by Fannypack:
import { ThemeProvider } from 'fannypack';

const App = () => (
  <ThemeProvider>
    // ... your app
  </ThemeProvider>
);
  1. Now you can start using components like so!:
import { Button } from 'fannypack';

const MyApp = () => (
  <Button>
    Hello world!
  </Button>
);

Contributing

Feel like contributing? That's awesome! We have a Contributing guide to help you out.

Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore -->
<img src="https://avatars3.githubusercontent.com/u/7336481?v=4" width="100px;"/><br /><sub><b>Jake Moxey</b></sub><br />💻 🎨 📖 🤔 👀<img src="https://avatars3.githubusercontent.com/u/19571028?v=4" width="100px;"/><br /><sub><b>Samantha Wong</b></sub><br />💻 🤔<img src="https://avatars3.githubusercontent.com/u/10344370?v=4" width="100px;"/><br /><sub><b>Dave Olsen</b></sub><br />💻 🤔 👀<img src="https://avatars1.githubusercontent.com/u/8334897?v=4" width="100px;"/><br /><sub><b>Yiming Tan(Michael)</b></sub><br />💻<img src="https://avatars1.githubusercontent.com/u/1747517?v=4" width="100px;"/><br /><sub><b>Terence Huynh</b></sub><br />💻<img src="https://avatars2.githubusercontent.com/u/41710405?v=4" width="100px;"/><br /><sub><b>Daniela Gattoni</b></sub><br />💻<img src="https://avatars3.githubusercontent.com/u/3068563?v=4" width="100px;"/><br /><sub><b>Haz</b></sub><br />📖
<img src="https://avatars2.githubusercontent.com/u/309754?v=4" width="100px;"/><br /><sub><b>Wez Pyke</b></sub><br />💻<img src="https://media.licdn.com/dms/image/C5603AQH8xjLoHfaGfw/profile-displayphoto-shrink_800_800/0?e=1553731200&v=beta&t=4BiZeiXhdfdlo-W9gt47KgeS8AjuxQc7VlZBXMOYgS8" width="100px;"/><br /><sub><b>Robert Gilmore</b></sub><br />🎨 🤔<img src="https://avatars2.githubusercontent.com/u/40446421?v=4" width="100px;"/><br /><sub><b>Claudia</b></sub><br />💻<img src="https://avatars3.githubusercontent.com/u/496255?v=4" width="100px;"/><br /><sub><b>Benjamin Gudehus</b></sub><br />💻<img src="https://avatars2.githubusercontent.com/u/7591767?v=4" width="100px;"/><br /><sub><b>Adrian Kremer</b></sub><br />💻 🔌
<!-- ALL-CONTRIBUTORS-LIST:END -->

Acknowledgements

Thanks Luke Edwards for handing over the fannypack npm name!