@amberflo/uikit
TypeScript icon, indicating that this package has built-in type declarations

1.18.1 • Public • Published

UI Kit | Amberflo

Installation

To install Amberflo UI Kit in your React project run:

// yarn
yarn add @amberflo/uikit

// npm
npm install @amberflo/uikit

Usage

To import a single Amberflo UI Kit component into your application (Recommended):

import { CostExplorerBarGraph } from "@amberflo/uikit/components/organisms/CostExplorerBarGraph";
import { InvoicesList } from '@amberflo/uikit/components/organisms/InvoiceList'

This will allow to perform tree-shaking so unused components will be dropped from the final bundle that will weight less and load faster. Note: to make this possible the bundler needs to allow tree shaking

To import multiple components from the root:

import { CostExplorerBarGraph, InvoicesList } from "@amberflo/ui-kit/components";

Note: Notice tree shaking won’t be effective if you use this approach. Also some unexpected behavior may occur, for example, importing all this components will prepare for rendering, meaning for instance stripe component will call some endpoints, even if this is not rendered.


Documentation

Check out our documentation website to see all available React.js components and hooks

Minimum requirements:

You should have installed Node (version v16.13.1 or later) and Yarn (version v1.22.17 or later).

Package Sidebar

Install

npm i @amberflo/uikit

Weekly Downloads

2,086

Version

1.18.1

License

ISC

Unpacked Size

5.57 MB

Total Files

523

Last publish

Collaborators

  • paula_amberflo
  • amberflo.io