@minkminks/mink-ui-components

MinkminkUI Component Library

Quick Start

1. Install

yarn add @minkminks/mink-ui-components

2. Import Global CSS

@import '@minkminks/mink-ui-components/dist/css/utilities.css'; // Utility classes -- REQUIRED
@import '@minkminks/mink-ui-components/dist/css/variables.css'; // CSS Variables -- REQUIRED
@import '@minkminks/mink-ui-components/dist/css/index.css'; // Component CSS -- REQUIRED
@import '@minkminks/mink-ui-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 '@minkminks/mink-ui-components/dist/css/reset.css' // A Basic CSS Reset -- OPTIONAL BUT ENCOURAGED.

3. Usage

import React from 'react';
import ReactDOM from 'react-dom';
import { Button } from '@minkminks/mink-ui-components';

function App() {
  return <Button>Hello World</Button>;
}

ReactDOM.render(<App />, document.querySelector('#app'));