https://github.com/cipchk/ngx-weui

WeUI for angular
https://github.com/cipchk/ngx-weui

angular angular-components angular-library angular-weui angular9 lvy weui weui2

Last synced: 12 months ago
JSON representation

WeUI for angular

• Host: GitHub
• URL: https://github.com/cipchk/ngx-weui
• Owner: cipchk
• License: mit
• Created: 2017-04-27T04:50:27.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-08-20T02:44:57.000Z (over 5 years ago)
• Last Synced: 2024-10-12T06:11:55.262Z (over 1 year ago)
• Topics: angular, angular-components, angular-library, angular-weui, angular9, lvy, weui, weui2
• Language: TypeScript
• Homepage: https://cipchk.github.io/ngx-weui/
• Size: 13.2 MB
• Stars: 426
• Watchers: 39
• Forks: 102
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          



NGX-WEUI





[WeUI](https://github.com/weui/weui) Components build with [Angular](https://angular.io/).

[![Build Status](https://img.shields.io/travis/cipchk/ngx-weui/master.svg?style=flat-square)](https://travis-ci.org/cipchk/ngx-weui)

[![NPM version](https://img.shields.io/npm/v/ngx-weui.svg?style=flat-square)](https://www.npmjs.com/package/ngx-weui)

[![npm downloads](https://img.shields.io/npm/dm/ngx-weui.svg?style=flat-square)](https://npmjs.org/ngx-weui)

[![Codecov](https://img.shields.io/codecov/c/github/cipchk/ngx-weui.svg?style=flat-square)](https://codecov.io/gh/cipchk/ngx-weui)

[![GitHub license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://github.com/cipchk/ngx-weui/blob/master/LICENSE)

[![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io/)



[![](https://cdn-images-1.medium.com/max/1600/1*ceWDQUy3-MQgEchW6SuSRA.png)](https://cipchk.github.io/ngx-weui/)

## Version

- WeUI `1.x` using `7.0.x`

- WeUI `<= 2.2` using `8.x` & Angular 8

- WeUI `>= 2.3` using `9.x` & Angular 9, 10, Support dark & light theme

## Table of Contents

1. [Usage & Demo](#usage--demo)

2. [Installation instructions](#installation-instructions)

3. [API Docs](https://cipchk.github.io/ngx-weui/)

4. [Customize Theme](https://cipchk.github.io/ngx-weui/#/docs/style)

5. [Global Config](https://cipchk.github.io/ngx-weui/#/docs/config)

6. [Troubleshooting](#troubleshooting)

7. [License](#license)

## Usage & Demo

- [Documentation](https://cipchk.github.io/ngx-weui/) - [国内镜像](https://cipchk.gitee.io/ngx-weui/)

- [Live Demo](https://cipchk.github.io/ngx-weui/) - [国内镜像](https://cipchk.gitee.io/ngx-weui/)

- [Stackblitz](https://stackblitz.com/edit/ngx-weui), [Codesandbox](https://codesandbox.io/s/ngx-weui-wki41?file=/src/app/app.component.ts)

## Create project

1. Install global `angular-cli`:

```bash

npm install -g @angular/cli

```

2. New a empty angular project

```bash

# Specify less style

ng new demo --style less

cd demo

```

3. add `ngx-weui`

```bash

ng add ngx-weui

```

> please refer to more [details](https://github.com/cipchk/ngx-weui/blob/master/docs/how.md).

### How to use it with:

+ `angular-cli` please refer to [how](https://github.com/cipchk/ngx-weui/blob/master/docs/how.md).

+ `stackblitz` sample available [here](https://stackblitz.com/edit/ngx-weui).

## Troubleshooting

Please follow this guidelines when reporting bugs and feature requests:

1. Use [GitHub Issues](https://github.com/cipchk/ngx-weui/issues) board to report bugs and feature requests (not our email address)

2. Please **always** write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it.

Thanks for understanding!

### License

The MIT License (see the [LICENSE](https://github.com/cipchk/ngx-weui/blob/master/LICENSE) file for the full text)