layui-vue Documentation
repository·master·Indexed 20 days ago
https://github.com/lunar-landing/layui-vueA desktop-oriented component library designed for Vue 3.0. The ecosystem includes the core @layui/layui-vue library, as well as specialized packages such as @layui/icons-vue for iconfont components, @layui/layer-vue for web elastic layer components, and @layui/json-schema-form for high-level JSON schema forms.
What's inside layui-vue
- layui-vue is a desktop component library built specifically for Vue 3.0. It provides a suite of UI components designed for desktop applications.
Configure and initialize @layui/json-schema-form
masterTo use the component, you must register the plugin with your Vue application instance and import the required CSS styles. Ensure you have
@layui/layui-vuealready configured as this component depends on it.import App from './App'; import { createApp } from 'vue'; import LayJsonSchemaForm from "@layui/json-schema-form"; import "@layui/json-schema-form/lib/index.css"; const app = createApp(App); app.use(LayJsonSchemaForm).mount('#app');Initialize @layui/layui-vue in a Vue application
masterTo use Layui Vue, you must mount the plugin to your Vue application instance and import the required CSS styles.
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')Install @layui/json-schema-form via npm
masterInstall the
@layui/json-schema-formpackage using npm to add the high-level JSON schema form component to your project. This component is built on top of@layui/layui-vueform.npm install @layui/json-schema-form --saveConfigure Volar for TypeScript component support
masterIf you are using Volar for Vue development, you should add the Layui Vue types to your
tsconfig.jsonto ensure global component types are correctly recognized.// tsconfig.json { "compilerOptions": { "types": ["@layui/layui-vue/types"] } }{ "compilerOptions": { "types": ["@layui/layui-vue/types"] } }Install @layui/icons-vue via npm
masterInstall the
@layui/icons-vuepackage using npm to use Layui iconfont icons as Vue components.npm i @layui/icons-vueInstall @layui/layui-vue via npm
masterInstall the core library using npm to add Layui Vue components to your project.
npm i @layui/layui-vueInstall @layui/layer-vue via npm
masterInstall the
@layui/layer-vuepackage using npm to add the web elastic layer component to your project.npm i @layui/layer-vueImport icon CSS styles
masterBefore using the icon components, you must import the required font icon CSS files in your project entry point or component.
import "@layui/icons-vue/lib/index.css";Configure and mount @layui/layer-vue in a Vue application
masterTo use
@layui/layer-vue, you must mount the plugin to your Vue application instance and import the required CSS styles. Ensure you import@layui/layer-vue/lib/index.cssto apply the component styles correctly.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');Access layui-vue documentation and mirror sites
masterYou can access the official documentation and various mirror sites for layui-vue to ensure availability and speed:
- Official Website: https://www.layui-vue.com
- Mirror 1: https://layui-vue.zhixiny.cn
- Mirror 2: https://layui-vue-awesome.pages.dev
- Version 2.x Mirror: https://layui-vue-expr.pages.dev
Provide feedback and join the community
masterIf you encounter issues or want to request new features, please use the GitHub Issues page. For community discussion and real-time communication, you can join the WeChat group via the following link: WeChat Group.