chore: add README.md
This commit is contained in:
就眠儀式
parent
7f88337182
commit
8a94ba4511
78
package/component/README.md
Normal file
78
package/component/README.md
Normal file
@ -0,0 +1,78 @@
|
||||
## Introduction
|
||||
|
||||
<p>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
</p>
|
||||
|
||||
**[🔶 Explore the docs »](http://www.layui-vue.com)** **[Join us](https://jq.qq.com/?_wv=1027&k=ffiUQgnE)**
|
||||
|
||||
An enterprise-class UI components based on Layui and Vue.
|
||||
|
||||
**Run with code Sandbox.**
|
||||
|
||||
[](https://codesandbox.io/s/11mvy)
|
||||
|
||||
## Features
|
||||
|
||||
A few of the things you can do with layui vue:
|
||||
|
||||
* Writing components using setup script
|
||||
* Up to 60 high quality components
|
||||
* Provide Axure design resources
|
||||
* Support theme customization
|
||||
* Support internationalization
|
||||
|
||||
## Get Started
|
||||
|
||||
Use npm to install.
|
||||
|
||||
```bash
|
||||
npm i @layui/layui-vue
|
||||
```
|
||||
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')
|
||||
```
|
||||
|
||||
We have several examples on the [website](http://layui-vue.pearadmin.com). Here is the first one to get you started:
|
||||
|
||||
```
|
||||
<template>
|
||||
<lay-button-container>
|
||||
<lay-button>Hello Word</lay-button>
|
||||
</lay-button-container>
|
||||
</template>
|
||||
```
|
||||
|
||||
## Feedback
|
||||
|
||||
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)!
|
||||
|
||||
## Build Process
|
||||
|
||||
- `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.
|
||||
|
||||
## Contributors
|
||||
|
||||
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).
|
||||
|
||||
<a href="https://github.com/layui-vue/layui-vue/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=layui-vue/layui-vue" />
|
||||
</a>
|
||||
|
||||
## Licence
|
||||
|
||||
Layui vue is licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
79
package/icons/README.md
Normal file
79
package/icons/README.md
Normal file
@ -0,0 +1,79 @@
|
||||
## Introduction
|
||||
|
||||
<p>
|
||||
<a href="https://www.npmjs.com/package/@layui/icons-vue"><img src="https://img.shields.io/npm/v/@layui/icons-vue.svg?sanitize=true" alt="Version"></a>
|
||||
<a href="https://www.npmjs.com/package/@layui/icon-vue"><img src="https://img.shields.io/npm/l/@layui/icons-vue.svg?sanitize=true" alt="License"></a>
|
||||
<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>
|
||||
</p>
|
||||
|
||||
**[🔶 Explore the docs »](http://www.layui-vue.com)** **[Join us](https://jq.qq.com/?_wv=1027&k=ffiUQgnE)**
|
||||
|
||||
The abstract trees of the layui iconfont icons.
|
||||
|
||||
## Get Started
|
||||
|
||||
Use npm to install.
|
||||
|
||||
```bash
|
||||
npm i @layui/icons-vue
|
||||
```
|
||||
Font icon files need to be introduced before use
|
||||
|
||||
```
|
||||
import "@layui/icons-vue/lib/index.css"
|
||||
```
|
||||
|
||||
Componentization, using the class of iconfont as the component name.
|
||||
|
||||
```
|
||||
<template>
|
||||
<AlignCenterIcon></AlignCenterIcon>
|
||||
<DiamondIcon></DiamondIcon>
|
||||
</template>
|
||||
|
||||
<script lang="ts" setup>
|
||||
import { AlignCenterIcon, DiamondIcon } from '@layui/icons-vue';
|
||||
</script>
|
||||
```
|
||||
|
||||
Traditionally, components are rendered by passing class through type.
|
||||
|
||||
```
|
||||
<template>
|
||||
<!-- 动态图标 -->
|
||||
<LayIcon type="layui-icon-not-found"></LayIcon>
|
||||
<LayIcon type="layui-icon-diamond"></LayIcon>
|
||||
</template>
|
||||
|
||||
<script lang="ts" setup>
|
||||
import { LayIcon } from '@layui/icons-vue';
|
||||
</script>
|
||||
```
|
||||
|
||||
## Open Source Licence
|
||||
|
||||
layui vue is licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
|
||||
```
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright 2021 就眠儀式
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
```
|
||||
97
package/layer/README.md
Normal file
97
package/layer/README.md
Normal file
@ -0,0 +1,97 @@
|
||||
## Introduction
|
||||
|
||||
<p>
|
||||
<a href="https://www.npmjs.com/package/@layui/layer-vue"><img src="https://img.shields.io/npm/v/@layui/layer-vue.svg?sanitize=true"></a>
|
||||
<a href="https://www.npmjs.com/package/@layui/layer-vue"><img src="https://img.shields.io/npm/l/@layui/layer-vue.svg?sanitize=true"></a>
|
||||
<a href="https://travis-ci.org/sentsin/layui"><img src="https://img.shields.io/travis/sentsin/layui/master.svg"></a>
|
||||
<a href="https://coveralls.io/r/sentsin/layui?branch=master"><img src="https://img.shields.io/coveralls/sentsin/layui/master.svg"></a>
|
||||
</p>
|
||||
|
||||
**[🔶 Explore the docs »](http://layer.layui-vue.com)** **[Join us](https://jq.qq.com/?_wv=1027&k=ffiUQgnE)**
|
||||
|
||||
Layer vue is a web elastic layer component.
|
||||
|
||||
## Get Started
|
||||
|
||||
Use npm to install.
|
||||
|
||||
```bash
|
||||
npm i @layui/layer-vue
|
||||
```
|
||||
|
||||
Before using, you need to mount layui Vue to Vue and introduce index.css style file.
|
||||
|
||||
```
|
||||
import App from './App';
|
||||
import { createApp } from 'vue';
|
||||
import layer from '@layui/layer-vue';
|
||||
import '@layui/layer-vue/lib/index.css';
|
||||
|
||||
const app = createApp(App);
|
||||
|
||||
app.use(layer).mount('#app');
|
||||
```
|
||||
|
||||
We support functional invocation:
|
||||
|
||||
```
|
||||
<template>
|
||||
<button type="button" @click="openSuccess">提示消息</button>
|
||||
</template>
|
||||
|
||||
<script setup>
|
||||
import { ref } from "vue";
|
||||
import { layer } from "@layui/layer-vue";
|
||||
|
||||
const openSuccess = function () {
|
||||
layer.msg("成功消息", {icon:1, time:1000});
|
||||
};
|
||||
</script>
|
||||
```
|
||||
Componentized calls are also supported:
|
||||
|
||||
```
|
||||
<template>
|
||||
<button @click="changeVisible">显示/隐藏</button>
|
||||
<lay-layer v-model="visible">
|
||||
content
|
||||
</lay-layer>
|
||||
</template>
|
||||
|
||||
<script setup>
|
||||
import { ref } from "vue";
|
||||
|
||||
const visible = ref(false);
|
||||
|
||||
const changeVisible = () => {
|
||||
visible.value = !visible.value;
|
||||
}
|
||||
</script>
|
||||
```
|
||||
|
||||
## Open Source Licence
|
||||
|
||||
layui vue is licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
||||
|
||||
```
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright 2021 就眠儀式
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user