sybz-components 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 刘力豪
+
+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.

package/README.md

@@ -0,0 +1,48 @@
+# element-plus二次封装
+
+使用vue3+element-plus封装前端组件。以利于前端组件化和工程化开发
+
+## 1. 组件的使用
+
+### 在vue3项目的main.js里引入
+
+```js
+import 'sybz-components/style.css'
+import SybzComponents from 'sybz-components'
+app.use(SybzComponents)
+```
+
+### 在任何一个.vue文件下, 可直接引入组件
+
+```js
+<s-button>这是s-button</s-button>
+<s-title title="这是s-title"></s-title>
+```
+
+## 2. 在vue3项目中使用公共函数, 安装@sybz-components/utils
+
+```js
+// 如果想将所有函数挂载至全局使用
+import * as utils from '@sybz-components/utils'
+// 将sybz-components下的公共函数赋值到全局
+Object.keys(utils).forEach((v) => {
+  app.config.globalProperties[v] = utils[v]
+})
+然后通过`proxy.$toast('哈哈')`, 这种方式去使用函数
+
+// 如果想单独的引用某个函数
+import { $toast } from '@sybz-components/utils'
+$toast('嘿嘿')
+```
+
+## 3. 在vue3项目中使用自定义指令
+
+当前项目支持的自定义指令有以下
+
+```
+v-copy
+v-number
+v-focus
+```
+
+更多内容请查看[文档](https://liulihao88.github.io/sybz-components/)