sagan-ui v0.1.3

Sagan UI

A UI component library for Farfetch for test purpose

Install

npm install --save sagan-ui

Usage

• Wrap your application with ThemeProvider if you want a custom library configuration
• Create a themeConfig.js anywhere you want in your application and pass it as theme prop to ThemeProvider
• Check each Component Readme tab to see available props to your themeConfig

import React from 'react';
import ReactDOM from 'react-dom';
import { ThemeProvider, Button } from 'sagan-ui';
//import themeConfig from 'path-to-your-themeConfig-file';

// Theme configuration to change default values
const themeConfig = {
    // Override default buttonSize [12] and changes global buttonSize to 18
    buttonSize: 18
}

ReactDOM.render(
    <ThemeProvider theme={themeConfig}>
        <Button/>
    </ThemeProvider>,
    mountNode
);

Developing

1 - Install all dependencies

yarn

2 - Start development build

yarn start

3 - Test your changes using Docz

yarn docz:dev

3.1 - Create a .mdx doc inside your component and import your component inside this file

---
name: Alert
---

import { Playground, PropsTable } from 'docz'
import Alert from './Alert'

<Playground>
  <Alert text="secondary"/>
</Playground>

4 - Test your changes using using link (Check Usage guide to inject custom props)

// Use npm link inside sagan folder
npm link

// Then use npm link sagan-ui inside your project
npm link sagan-ui

Documentation

• Check out components documentation