├── .browserslistrc
├── .eslintrc.js
├── .github
└── workflows
│ └── npm_publish.yaml
├── .gitignore
├── .npmignore
├── .prettierignore
├── .prettierrc
├── LICENSE
├── README.md
├── babel.config.js
├── example
├── App.vue
├── emqx-ui-variables.scss
├── main.ts
├── shims-vue.d.ts
└── upload.png
├── package.json
├── packages
├── Aside
│ ├── index.ts
│ └── src
│ │ └── aside.vue
├── Avatar
│ ├── index.ts
│ └── src
│ │ └── avatar.vue
├── Badge
│ ├── index.ts
│ └── src
│ │ └── badge.vue
├── Breadcrumb
│ ├── index.ts
│ └── src
│ │ └── breadcrumb.vue
├── BreadcrumbItem
│ ├── index.ts
│ └── src
│ │ └── breadcrumb-item.vue
├── Button
│ ├── index.ts
│ └── src
│ │ └── button.vue
├── Card
│ ├── index.ts
│ └── src
│ │ └── card.vue
├── Checkbox
│ ├── index.ts
│ └── src
│ │ └── checkbox.vue
├── Col
│ ├── index.ts
│ └── src
│ │ └── col.vue
├── Container
│ ├── index.ts
│ └── src
│ │ └── container.vue
├── DatePicker
│ ├── index.ts
│ └── src
│ │ └── date-picker.vue
├── Descriptions
│ ├── index.ts
│ └── src
│ │ └── descriptions.vue
├── DescriptionsItem
│ ├── index.ts
│ └── src
│ │ └── descriptions-item.vue
├── Dropdown
│ ├── index.ts
│ └── src
│ │ └── dropdown.vue
├── DropdownItem
│ ├── index.ts
│ └── src
│ │ └── dropdownItem.vue
├── DropdownMenu
│ ├── index.ts
│ └── src
│ │ └── dropdownMenu.vue
├── Empty
│ ├── index.ts
│ └── src
│ │ └── empty.vue
├── Footer
│ ├── index.ts
│ └── src
│ │ └── footer.vue
├── Form
│ ├── index.ts
│ └── src
│ │ └── form.vue
├── FormItem
│ ├── index.ts
│ └── src
│ │ └── form-item.vue
├── Header
│ ├── index.ts
│ └── src
│ │ └── header.vue
├── Input
│ ├── index.ts
│ └── src
│ │ └── input.vue
├── InputNumber
│ ├── index.ts
│ └── src
│ │ └── input-number.vue
├── KeyValueEditor
│ ├── index.ts
│ └── src
│ │ └── key-value-edtitor.vue
├── Loading
│ └── index.ts
├── Main
│ ├── index.ts
│ └── src
│ │ └── main.vue
├── Menu
│ ├── index.ts
│ └── src
│ │ └── menu.vue
├── MenuItem
│ ├── index.ts
│ └── src
│ │ └── menu-item.vue
├── MenuItemGroup
│ ├── index.ts
│ └── src
│ │ └── menu-item-group.vue
├── Message
│ └── index.ts
├── MessageBox
│ └── index.ts
├── Option
│ ├── index.ts
│ └── src
│ │ └── option.vue
├── Pagination
│ ├── index.ts
│ └── src
│ │ └── pagination.vue
├── Radio
│ ├── index.ts
│ └── src
│ │ └── radio.vue
├── RadioGroup
│ ├── index.ts
│ └── src
│ │ └── radio-group.vue
├── Row
│ ├── index.ts
│ └── src
│ │ └── row.vue
├── Select
│ ├── index.ts
│ └── src
│ │ └── select.vue
├── Submenu
│ ├── index.ts
│ └── src
│ │ └── submenu.vue
├── Switch
│ ├── index.ts
│ └── src
│ │ └── switch.vue
├── Table
│ ├── index.ts
│ └── src
│ │ └── table.vue
├── TableColumn
│ ├── index.ts
│ └── src
│ │ └── table-column.vue
├── Tags
│ ├── index.ts
│ └── src
│ │ └── tags.vue
├── Upload
│ ├── index.ts
│ └── src
│ │ └── upload.vue
├── index.ts
└── styles
│ ├── components
│ ├── avatar.scss
│ ├── button.scss
│ ├── card.scss
│ ├── container.scss
│ ├── date-picker.scss
│ ├── description.scss
│ ├── dropdown.scss
│ ├── form-item.scss
│ ├── header.scss
│ ├── index.scss
│ ├── input-number.scss
│ ├── input.scss
│ ├── key-value-editor.scss
│ ├── menu-item.scss
│ ├── pagination.scss
│ ├── select.scss
│ ├── table.scss
│ ├── tags.scss
│ └── upload.scss
│ ├── global.scss
│ ├── index.scss
│ └── theme.scss
├── public
├── favicon.ico
└── index.html
├── tsconfig.json
├── vue.config.js
└── yarn.lock
/.browserslistrc:
--------------------------------------------------------------------------------
1 | > 1%
2 | last 2 versions
3 | not dead
4 |
--------------------------------------------------------------------------------
/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | root: true,
3 | env: {
4 | node: true,
5 | },
6 | extends: [
7 | 'plugin:vue/vue3-essential',
8 | 'eslint:recommended',
9 | '@vue/typescript/recommended',
10 | '@vue/prettier',
11 | '@vue/prettier/@typescript-eslint',
12 | ],
13 | parserOptions: {
14 | ecmaVersion: 2020,
15 | },
16 | rules: {
17 | 'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
18 | 'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
19 | 'prettier/prettier': 'error',
20 | 'import/extensions': 0,
21 | 'vue/singleline-html-element-content-newline': 'off',
22 | 'vue/multiline-html-element-content-newline': 'off',
23 | 'vue/name-property-casing': ['error', 'PascalCase'],
24 | 'vue/no-v-html': 'off',
25 | semi: 0,
26 | 'import/no-cycle': 0,
27 | 'max-len': 0,
28 | 'no-underscore-dangle': 0,
29 | 'prefer-destructuring': [
30 | 'error',
31 | {
32 | object: true,
33 | array: false,
34 | },
35 | ],
36 | 'no-script-url': 0,
37 | 'no-param-reassign': [
38 | 'error',
39 | {
40 | props: false,
41 | },
42 | ],
43 | camelcase: 'off',
44 | },
45 | }
46 |
--------------------------------------------------------------------------------
/.github/workflows/npm_publish.yaml:
--------------------------------------------------------------------------------
1 | name: Node.js Package Publish
2 | on:
3 | push:
4 | tags:
5 | - "*"
6 | branches:
7 | - main
8 | jobs:
9 | build:
10 | runs-on: ubuntu-20.04
11 | steps:
12 | - uses: actions/checkout@v2
13 | - uses: actions/setup-node@v1
14 | with:
15 | node-version: '14.15'
16 | - name: yarn install
17 | run: yarn install
18 | - name: yarn lib
19 | run: |
20 | yarn lib
21 | zip -rq emqx-ui.zip ./lib
22 | - id: publish
23 | if: startsWith(github.ref, 'refs/tags/')
24 | uses: JS-DevTools/npm-publish@v1
25 | with:
26 | token: ${{ secrets.NPM_TOKEN }}
27 | access: publish
28 | - if: steps.publish.outputs.type != 'none'
29 | run: |
30 | echo "Version changed: ${{ steps.publish.outputs.old-version }} => ${{ steps.publish.outputs.version }}"
31 | - name: Create Release
32 | if: startsWith(github.ref, 'refs/tags/')
33 | id: create_release
34 | uses: actions/create-release@v1
35 | env:
36 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
37 | with:
38 | tag_name: ${{ github.ref }}
39 | release_name: EMQ X UI ${{ github.ref }} Released
40 | draft: false
41 | prerelease: false
42 | - name: Upload Release Asset
43 | if: startsWith(github.ref, 'refs/tags/')
44 | id: upload-release-asset
45 | uses: actions/upload-release-asset@v1
46 | env:
47 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
48 | with:
49 | upload_url: ${{ steps.create_release.outputs.upload_url }}
50 | asset_path: ./emqx-ui.zip
51 | asset_name: emqx-ui.zip
52 | asset_content_type: application/zip
53 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | node_modules
3 | /dist
4 | /lib
5 |
6 |
7 | # local env files
8 | .env.local
9 | .env.*.local
10 |
11 | # Log files
12 | npm-debug.log*
13 | yarn-debug.log*
14 | yarn-error.log*
15 | pnpm-debug.log*
16 |
17 | # Editor directories and files
18 | .idea
19 | .vscode
20 | *.suo
21 | *.ntvs*
22 | *.njsproj
23 | *.sln
24 | *.sw?
25 |
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | example/
2 | packages/
3 | public/
4 |
5 | vue.config.js
6 | babel.config.js
7 | tsconfig.json
8 | *.map
9 | *.zip
10 | .*
11 |
--------------------------------------------------------------------------------
/.prettierignore:
--------------------------------------------------------------------------------
1 | # Ignore artifacts:
2 | public
3 | dist
4 |
--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 | "singleQuote": true,
3 | "tabWidth": 2,
4 | "useTabs": false,
5 | "semi": false,
6 | "trailingComma": "all",
7 | "printWidth": 120,
8 | "bracketSpacing": true
9 | }
10 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # emqx-ui
2 |
3 | 🌌 EMQX UI Library.
4 |
5 | ## Usage
6 |
7 | ### Install package
8 |
9 | ```shell
10 | yarn add @emqx/emqx-ui
11 | ```
12 |
13 | main.js
14 |
15 | ```js
16 | import { createApp } from 'vue'
17 | import EmqxUI from '@emqx/emqx-ui'
18 | import '@emqx/emqx-ui/lib/styles/index.scss'
19 |
20 | const app = createApp(App)
21 | app.use(EmqxUI)
22 | ```
23 |
24 | component.vue
25 |
26 | ```html
27 |
28 | Test
29 |
30 |
31 |
38 |
39 |
40 | ```
41 |
42 | ### Set custom theme
43 |
44 | Create a new theme file.
45 |
46 | emqx-ui-variables.scss
47 |
48 | ```scss
49 | /* theme color */
50 | $--color-primary: $custom-color;
51 |
52 | /* icon font path, required */
53 | $--font-path: '~element-plus/lib/theme-chalk/fonts';
54 |
55 | @import '~element-plus/packages/theme-chalk/src/index';
56 | ```
57 |
58 | main.js
59 |
60 | ```js
61 | import './emqx-ui-variables.scss'
62 | ```
63 |
64 | ## Project setup
65 |
66 | ### Run server demo
67 |
68 | ```shell
69 | # Install dependencies
70 | yarn install
71 |
72 | # Compiles and hot-reloads for development
73 | yarn serve
74 | ```
75 |
76 | ### Build npm package lib
77 |
78 | ```shell
79 | # Build to lib
80 | yarn lib
81 |
82 | # Publish package
83 | npm publish
84 | ```
85 |
86 | ## Thanks
87 |
88 | Powered by [Vue.js 3.0](https://v3.vuejs.org/) and [element-plus](https://element-plus.org/#/en-US)
89 |
--------------------------------------------------------------------------------
/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | presets: ['@vue/cli-plugin-babel/preset'],
3 | plugins: [
4 | [
5 | 'import',
6 | {
7 | libraryName: 'element-plus',
8 | customStyleName: name => {
9 | return `element-plus/lib/theme-chalk/${name}.css`
10 | },
11 | },
12 | ],
13 | ],
14 | }
15 |
--------------------------------------------------------------------------------
/example/App.vue:
--------------------------------------------------------------------------------
1 |
2 |