0.0.16 • Published 5 years ago
quinn-components v0.0.16
🍃 quinn-components
A react component library for web, native and amp built using styled-components
WARNING: This is a work in progress, API is subject to change
Installation
npm install -S quinn-components
Usage
Wrap your App component with ThemeProvider and pass it the quinn-components theme (or override it with custom a theme)
// index.js
import React from 'react';
import ReactDOM from 'react-dom';
import { ThemeProvider } from 'styled-components';
import leafUiTheme, { BaseStyles } from 'quinn-components/theme/web';
import App from './App';
ReactDOM.render(
<ThemeProvider theme={leafUiTheme}>
<BaseStyles/>
<App />
</ThemeProvider>,
document.getElementById('root'),
);
Import and use the components in your App.js
// App.js
import React from 'react';
import Button from 'quinn-components/Button/web';
// for commonjs use,
// import Button from 'quinn-components/cjs/Button/web';
const App = () => (
<Button>
quinn-components
</Button>
);
export default App;
Supported Platforms
- /web
- /native
- /amp
Contribute
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to quinn-components.
Setup
Follow this quick setup guide to get quinn-components working on your local machine.