Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 1.92 KB

README.md

File metadata and controls

73 lines (48 loc) · 1.92 KB
Raw

UI Components

This library contains Dashlane's reusable ui components built with React 🎉

Getting Started

These instructions will get you the latest version of the ui-components lib installed in your project, so you start integrating ans using the components.

Compatibility

Your project needs to use React 16 or later.

Prerequisites

You need to install on your machine :

  • a recent version of Node.js
  • Yarn as a dependency manager

Installing

Add ui-components to your project by executing :

yarn add @dashlane/ui-components@latest

Usage

Here's an example of basic usage:

import * as React from 'react';
import { Button } from '@dashlane/ui-components';

const App: React.FC = () => {
  return (
    <div className='App'>
      <header className='App-header'>
        <img className='App-logo' alt='logo' />
        <p>
          Edit <code>src/App.tsx</code> and save to reload.
        </p>
      </header>
      <Button title={'Click me'} primary={true} />
    </div>
  );
};

export default App;

Usage guide

All the available components offered by this library are described here. Feel free to navigate through them and to live test the behaviour of each.

Built With

  • React - The javascript library
  • Styled-Components - Used to create styled React components with an improved experience for developers
  • Yarn - Dependency Management

Contributing

Please read CONTRIBUTING.md for details on contributing on this project and the process for submitting pull requests.

Versioning

We use SemVer for versioning. To see all available versions, you can run

yarn info @dashlane/ui-components versions