@hyphen/hyphen-components
v4.3.1
Published
A React component library to power all Hyphen UI.
Downloads
1,206
Keywords
Readme
A React component library to power all Hyphen UI
Quick Start
1. Install
npm install @hyphen/hyphen-components
2. Import Global CSS
import '@hyphen/hyphen-components/dist/css/utilities.css'; // Utility classes -- REQUIRED
import '@hyphen/hyphen-components/dist/css/variables.css'; // CSS Variables -- REQUIRED
import '@hyphen/hyphen-components/dist/css/index.css'; // Component CSS -- REQUIRED
import '@hyphen/hyphen-components/dist/css/fonts.css'; // Included Font files -- OPTIONAL BUT ENCOURAGED
We recommend importing our global reset in order to maintain a consistent look of all components across applications.
import '@hyphen/hyphen-components/dist/css/reset.css' // A Basic CSS Reset -- OPTIONAL BUT ENCOURAGED.
3. Usage
import React from 'react';
import ReactDOM from 'react-dom';
import { Box } from '@hyphen/hyphen-components';
function App() {
return <Box>Hello World</Box>;
}
ReactDOM.render(<App />, document.querySelector('#app'));
Documentation
Contributing
Issues and PRs welcome! See HERE for our Contribution Guide.
Raising an Issue
When raising an issue:
- Make sure the issue hasn't been raised yet.
- Tag issue accordingly using your best judgement. Do NOT create new tags. If you feel a new one is needed, raise it in your issue.
- If your issue is a bug, include screenshots or animated GIFs in your issue whenever needed (if issue is visual in nature).
- If your issue is a bug, include steps to reproduce, or link to reproducible issue, e.g.: Code Sandbox or similar. Please also provide any additional details including device, OS, browser, browser version etc.
License
This project is licensed under the terms of the MIT license.