layui/README.md

78 lines
2.7 KiB
Markdown
Raw Normal View History

2022-02-28 00:01:02 +08:00
## Introduction
2022-02-10 17:23:08 +08:00
2022-02-10 23:48:21 +08:00
<p>
2021-10-07 02:12:16 +08:00
<a href="https://www.npmjs.com/package/@layui/layui-vue"><img src="https://img.shields.io/npm/v/@layui/layui-vue.svg?sanitize=true" alt="Version"></a>
2022-02-10 23:48:21 +08:00
<a href="https://www.npmjs.com/package/@layui/layui-vue"><img src="https://img.shields.io/npm/l/@layui/layui-vue.svg?sanitize=true" alt="License"></a>
2021-09-27 11:27:36 +08:00
<a href="https://travis-ci.org/sentsin/layui"><img alt="Build Status" src="https://img.shields.io/travis/sentsin/layui/master.svg"></a>
<a href="https://coveralls.io/r/sentsin/layui?branch=master"><img alt="Test Coverage" src="https://img.shields.io/coveralls/sentsin/layui/master.svg"></a>
2022-02-10 23:48:21 +08:00
</p>
2021-09-27 11:27:36 +08:00
2022-03-07 11:10:09 +08:00
**[🔶 Explore the docs »](http://www.layui-vue.com)**
2021-09-27 11:27:36 +08:00
2022-02-28 00:01:02 +08:00
An enterprise-class UI components based on Layui and Vue.
2021-09-29 14:21:47 +08:00
2022-02-10 23:48:21 +08:00
**Run with code Sandbox.**
2021-09-27 11:27:36 +08:00
2022-02-21 01:31:13 +08:00
[![Edit layui-vue](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/11mvy)
2022-02-10 16:38:17 +08:00
2022-02-28 00:01:02 +08:00
## Features
2021-09-29 14:21:47 +08:00
2022-02-10 23:48:21 +08:00
A few of the things you can do with layui vue:
2021-12-23 00:37:57 +08:00
2022-02-10 23:48:21 +08:00
* Writing components using setup script
2022-02-22 13:46:50 +08:00
* Up to 60 high quality components
2022-02-10 23:48:21 +08:00
* Provide Axure design resources
* Support theme customization
* Support internationalization
2021-09-27 11:27:36 +08:00
2022-02-28 00:01:02 +08:00
## Get Started
2022-02-10 23:48:21 +08:00
2022-02-28 00:01:02 +08:00
Use npm to install.
2022-02-10 23:48:21 +08:00
```bash
npm i @layui/layui-vue
```
2022-02-21 01:36:44 +08:00
Before using, you need to mount layui Vue to Vue and introduce index.css style file
```
import App from './App.vue'
import { createApp } from 'vue'
import layui from '@layui/layui-vue'
import '@layui/layui-vue/lib/index.css'
createApp(App).use(layui).mount('#app')
```
2022-02-13 17:00:22 +08:00
2022-02-28 00:01:02 +08:00
We have several examples on the [website](http://layui-vue.pearadmin.com). Here is the first one to get you started:
2022-02-10 17:23:08 +08:00
2022-02-10 23:48:21 +08:00
```
2022-02-10 17:23:08 +08:00
<template>
2022-02-10 23:48:21 +08:00
<lay-button-container>
<lay-button>Hello Word</lay-button>
</lay-button-container>
2022-02-10 17:23:08 +08:00
</template>
```
2022-02-10 14:07:34 +08:00
2022-02-28 00:01:02 +08:00
## Feedback
2022-02-10 23:48:21 +08:00
Feel free to send us feedback on [file an issue](https://github.com/layui-vue/layui-vue/issues/new). Feature requests are always welcome. If you wish to contribute, please take a quick look at the [guidelines](./CONTRIBUTING.md)!
If there's anything you'd like to chat about, please feel free to join our [Gitter chat](https://gitter.im/layui-vue/community)!
2022-02-28 00:01:02 +08:00
## Build Process
2022-02-13 23:50:44 +08:00
- `build` Packaged component library
Please take a look at the [contributing guidelines](./CONTRIBUTING.md) for a detailed process on how to build your application as well as troubleshooting information.
2022-02-28 00:01:02 +08:00
## Contributors
2022-02-10 23:48:21 +08:00
This project follows the [all-contributors](https://github.com/layui-vue/layui-vue/graphs/contributors) specification and is brought to you by these [awesome contributors](https://github.com/layui-vue/layui-vue/graphs/contributors).
2022-02-10 14:07:34 +08:00
2022-02-10 23:48:21 +08:00
<a href="https://github.com/layui-vue/layui-vue/graphs/contributors">
<img src="https://contrib.rocks/image?repo=layui-vue/layui-vue" />
</a>
2021-12-23 00:37:57 +08:00
2022-02-28 00:01:02 +08:00
## Licence
2022-02-22 11:53:59 +08:00
Layui vue is licensed under the [MIT license](https://opensource.org/licenses/MIT).