Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.24 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.24 KB

commercetools UIKit 💅

Design System component library

🚧 Under construction 🚧

Install

$ npm install --save @commercetools-frontend/ui-kit

$ yarn add @commercetools-frontend/ui-kit

The package main exports contains all the UI components.

import {
  Text,
  TextInput,
  PrimaryButton,
  // etc.
} from '@commercetools-frontend/ui-kit';

Exports for backwards compatibility

Previously the library was consumed by reaching into the folders structure like

import PrimaryButton from '@commercetools-frontend/ui-kit/buttons/primary-button';

In order to keep those imports backwards compatible, we provide the same old file structure in the proxy-exports folder, which then gets copied into dist at build time. Each folder only contains an index.js that points to the main export of the generated bundle.

The proxy-exports folder will be removed in the future.

Motivation

  • Declarative components serving as a design guide
  • Shared independently from the application's code base
  • Used across different apps consumed by different teams
  • Shared language between developers and designers

Documentation

coming soon