Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 2.64 KB

README.md

File metadata and controls

90 lines (61 loc) · 2.64 KB

logo

FNX-UI

Lightweight Mobile UI Components built in React

npm version downloads Jsdelivr Hits Gzip Size

Website(GitHub)   文档网站(国内)   中文版介绍


Introduction

Lightweight Mobile UI Components built in React.

Features

  • There are more than 30 components, Hope they can help you write less code
  • 1kb Component average size (min+gzip)
  • 90%+ Unit test coverage
  • All the staff in FNX UI is written in TypeScript, It can work with your TypeScript project seamlessly
  • Support i18n
  • Support dark mode and custom theme

Install

Use npm or yarn to install.

# npm
$ npm i fnx-ui -S

# yarn
$ yarn add fnx-ui

Quick Start

import ReactDOM from 'react-dom';
import { Button } from 'fnx-ui';

import 'fnx-ui/dist/fnx.css';

// light mode
import 'fnx-ui/dist/fnx-theme-light.css';

// dark mode
// import 'fnx-ui/dist/fnx-theme-dark.css';

function App() {
  return <Button>Default Button</Button>;
}

ReactDOM.render(<App />, mountNode);

Browser Support

Supports modern browsers and Chrome >= 51、Android >= 5.0、iOS >= 10.0.

Contributing

We welcome all contributions. You can submit any ideas as pull requests or as GitHub issues.

Preview

You can scan the following QR code to access the demo:

LICENSE

MIT