@containous/faency

Faency

Faency is the Containous React component library.

Installation

Run the following command using npm:

npm install @containous/faency --save

If you prefer Yarn, use the following command instead:

yarn add @containous/faency

Usage

• Wrap your app with the Faency provider

import React from 'react';
import { Provider as FaencyProvider } from '@containous/faency';

const Root = () => (
  <FaencyProvider>
    <App />
  </FaencyProvider>
);

• In your app you can now import and use Faency components:

import React from 'react';
import { Button } from '@containous/faency';

const App = () => (
  <>
    <Button variant="primary">Click me</Button>
  </>
);

Development

We use Storybook to create a simple, hot-reloading playground for development on these components. You can edit/create a *.story.tsx file to preview and document usage of a component.