README-en_US.md

ZF Design

A React Components Library

简体中文 | English

✨ Features

• An enterprise-class UI design system for web applications
• A set of high-quality React components out of the box
• Written in TypeScript with predictable static types
• The whole package of development and desing resources and tools

🖥 Environment Support

• Modern browsers and Internet Explorer 9+ (with polyfills)

📦 Install

npm install --save zfd

or 

yarn add zfd

🔨 Usage

import { Alert } from 'zfd';
ReactDOM.render(<Alert message='Success Text' type='success' />, mountNode);

And import style manually:

import 'zfd/dist/zfd.css'; // or 'zfd/dist/zfd.less'

Import components on demand:

import Alert from 'zfd/es/alert';
import 'zfd/es/alert/style';

⌨️ Development

Or clone locally:

$ git clone https://github.com/Fea-Sin/zfd.git
$ cd zfd
$ npm install
$ npm start