carlosalbertopardo v1.0.0

iúnigo UI-KIT

Welcome to the ui-kit created for iúnigo base pages. Here you can find buttons, grids, texts and more. The iúnigo iu-kit has some components based on material-ui, so you can follow the same especificacions and documentation that is in the official site.

Getting Started

To use the ui-kit components in your project you have install bit.

1. Install bit in your project:

npm install bit-bin -g

2. Login into bit with your github user:

bit login

Installing

1. Install the ui-kit:

yarn add '@bit/iunigo.ui-kit.core'

or

npm install '@bit/iunigo.ui-kit.core'

2. import the ui-kit provider and wrap your aplication in it.

import { Provider} from '@bit/iunigo.ui-kit.core';

<Provider>
  YOUR APP
</Provider>

3. Select and add the "theme" that you want to use.

import { Provider, BlueTheme } from '@bit/iunigo.ui-kit.core';

<Provider theme={BlueTheme}>
  YOUR APP
</Provider>

4. Load the iúnigo base fonts by adding the link in the header tag of your app.

<link
     rel="stylesheet"
     type="text/css"
     href="https://res.cloudinary.com/iunigo/raw/upload/v1556211399/fonts/walsheim.css"
 />

5. If you are working with styled-components, add this to your .babelrc

{
  "presets": ["next/babel"],
  "plugins": [
    [
      "styled-components",
      { "ssr": true, "displayName": true, "preprocess": false }
    ]
  ]
}

DONE!

To use the components you just need to import them from the '@bit/iunigo.ui-kit.core' and use them. Components available right now:

• Button
• Typography
• Container
• Grid
• Hidden

enjoy :)