quasar-ui-sellmate-ui-kit 2.3.2 → 3.0.1

package/.eslintrc.cjs

@@ -0,0 +1,73 @@
+/* eslint-disable */
+module.exports = {
+  root: false,
+  env: {
+    node: true,
+    es2021: true,
+    'vue/setup-compiler-macros': true,
+  },
+  extends: ['plugin:@typescript-eslint/recommended', 'plugin:vue/vue3-essential', 'airbnb-base'],
+  parserOptions: {
+    parser: require.resolve('@typescript-eslint/parser'),
+    ecmaVersion: 2023,
+    extraFileExtensions: ['.vue'],
+    sourceType: 'module',
+    requireConfigFile: false,
+  },
+  plugins: [
+    'import',
+    '@typescript-eslint',
+    'vue',
+  ],
+  globals: {
+    __UI_VERSION__: 'readonly',
+    process: 'readonly',
+    cy: true,
+  },
+  rules: {
+    'no-param-reassign': 'off',
+    'no-void': 'off',
+    'no-nested-ternary': 'off',
+    'max-classes-per-file': 'off',
+
+    'import/first': 'off',
+    'import/named': 'off',
+    'import/namespace': 'error',
+    'import/default': 'error',
+    'import/export': 'error',
+    'import/extensions': 'off',
+    'import/no-unresolved': 'off',
+    'import/no-extraneous-dependencies': 'off',
+    'import/prefer-default-export': 'off',
+    'prefer-promise-reject-errors': 'off',
+    indent: 'off',
+    'max-len': ['warn', {
+      code: 100,
+      tabWidth: 1,
+      ignoreUrls: true,
+      ignoreComments: true,
+      ignoreRegExpLiterals: true,
+      ignoreStrings: true,
+      ignoreTemplateLiterals: true,
+    }],
+    'no-console': [
+      process.env.NODE_ENV === 'production' ? 'error' : 'off',
+      { allow: ['error', 'info', 'warn'] },
+    ],
+    'linebreak-style': 0,
+    'arrow-parens': 'off',
+    'no-bitwise': ['error', { allow: ['>>'] }],
+    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+    'object-curly-newline': 'off',
+
+    // this rule, if on, would require explicit return type on the `render` function
+    '@typescript-eslint/explicit-function-return-type': 'off',
+
+    // in plain CommonJS modules, you can't use `import foo = require('foo')` to pass this rule, so it has to be disabled
+    '@typescript-eslint/no-var-requires': 'off',
+    'vue/no-multiple-template-root': 'off',
+    'vue/multi-word-component-names': 'off',
+    'vue/no-v-for-template-key': 'off',
+    'vue/no-v-text-v-html-on-component': 'off',
+  },
+};

package/.prettierrc

@@ -0,0 +1,25 @@
+{
+  "singleQuote": true,
+  "vueIndentScriptAndStyle": true,
+  "useTabs": false,
+  "arrowParens": "avoid",
+  "htmlWhitespaceSensitivity": "css",
+  "insertPragma": false,
+  "jsxBracketSameLine": false,
+  "jsxSingleQuote": true,
+  "printWidth": 100,
+  "proseWrap": "always",
+  "quoteProps": "as-needed",
+  "requirePragma": false,
+  "tabWidth": 2,
+  "semi": true,
+  "trailingComma": "all",
+  "vetur.format.defaultFormatterOptions": {
+    "prettier": {
+      "singleQuote": true,
+      "trailingComma": "all",
+      "tabWidth": 2,
+			"useTabs": false
+    }
+  }
+}

package/README.md

@@ -1,142 +1,156 @@
-# Component SellmateUI and Directive v-sellmate
-
-[![npm](https://img.shields.io/npm/v/quasar-ui-sellmate-ui-kit.svg?label=quasar-ui-sellmate-ui-kit)](https://www.npmjs.com/package/quasar-ui-sellmate-ui-kit)
-[![npm](https://img.shields.io/npm/dt/quasar-ui-sellmate-ui-kit.svg)](https://www.npmjs.com/package/quasar-ui-sellmate-ui-kit)
-
-**Compatible with Quasar UI v2 and Vue 3**.
-
-# Component SellmateUI
-> Short description of the component
-
-# Directive v-sellmate
-> Short description of the directive
-
-# Usage
-
-## Quasar CLI project
-
-Install the [App Extension](../app-extension).
-
-**OR**:
-
-Create and register a boot file:
-
-```js
-import Vue from 'vue'
-import Plugin from 'quasar-ui-sellmate-ui-kit'
-import 'quasar-ui-sellmate-ui-kit/dist/index.css'
-
-Vue.use(Plugin)
-```
-
-**OR**:
-
-```html
-<style src="quasar-ui-sellmate-ui-kit/dist/index.css"></style>
-
-<script>
-import { Component as SellmateUI, Directive } from 'quasar-ui-sellmate-ui-kit'
-
-export default {
-  components: {
-    SellmateUI
-  },
-  directives: {
-    Directive
-  }
-}
-</script>
-```
-
-## Vue CLI project
-
-```js
-import Vue from 'vue'
-import Plugin from 'quasar-ui-sellmate-ui-kit'
-import 'quasar-ui-sellmate-ui-kit/dist/index.css'
-
-Vue.use(Plugin)
-```
-
-**OR**:
-
-```html
-<style src="quasar-ui-sellmate-ui-kit/dist/index.css"></style>
-
-<script>
-import { Component as SellmateUI, Directive } from 'quasar-ui-sellmate-ui-kit'
-
-export default {
-  components: {
-    SellmateUI
-  },
-  directives: {
-    Directive
-  }
-}
-</script>
-```
-
-## UMD variant
-
-Exports `window.sellmateUI`.
-
-Add the following tag(s) after the Quasar ones:
-
-```html
-<head>
-  <!-- AFTER the Quasar stylesheet tags: -->
-  <link href="https://cdn.jsdelivr.net/npm/quasar-ui-sellmate-ui-kit/dist/index.min.css" rel="stylesheet" type="text/css">
-</head>
-<body>
-  <!-- at end of body, AFTER Quasar script(s): -->
-  <script src="https://cdn.jsdelivr.net/npm/quasar-ui-sellmate-ui-kit/dist/index.umd.min.js"></script>
-</body>
-```
-If you need the RTL variant of the CSS, then go for the following (instead of the above stylesheet link):
-```html
-<link href="https://cdn.jsdelivr.net/npm/quasar-ui-sellmate-ui-kit/dist/index.rtl.min.css" rel="stylesheet" type="text/css">
-```
-
-# Setup
-```bash
-$ yarn
-```
-
-# Developing
-```bash
-# start dev in SPA mode
-$ yarn dev
-
-# start dev in UMD mode
-$ yarn dev:umd
-
-# start dev in SSR mode
-$ yarn dev:ssr
-
-# start dev in Cordova iOS mode
-$ yarn dev:ios
-
-# start dev in Cordova Android mode
-$ yarn dev:android
-
-# start dev in Electron mode
-$ yarn dev:electron
-```
-
-# Building package
-```bash
-$ yarn build
-```
-
-# Adding Testing Components
-in the `ui/dev/src/pages` you can add Vue files to test your component/directive. When using `yarn dev` to build the UI, any pages in that location will automatically be picked up by dynamic routing and added to the test page.
-
-# Adding Assets
-If you have a component that has assets, like language or icon-sets, you will need to provide these for UMD. In the `ui/build/script.javascript.js` file, you will find a couple of commented out commands that call `addAssets`. Uncomment what you need and add your assets to have them be built and put into the `ui/dist` folder.
-
-# Donate
-If you appreciate the work that went into this, please consider [donating to Quasar](https://donate.quasar.dev).
-
-# License
-MIT (c) Sellmate Dev Team <dev@sellmate.co.kr>
+# Component MyComponent and Directive v-my-directive
+
+[![npm](https://img.shields.io/npm/v/quasar-ui-quasar-ui.svg?label=quasar-ui-quasar-ui)](https://www.npmjs.com/package/quasar-ui-quasar-ui)
+[![npm](https://img.shields.io/npm/dt/quasar-ui-quasar-ui.svg)](https://www.npmjs.com/package/quasar-ui-quasar-ui)
+
+**Compatible with Quasar UI v2 and Vue 3**.
+
+
+# Component MyComponent
+> Short description of the component
+
+
+
+# Directive v-my-directive
+> Short description of the directive
+
+
+# Usage
+
+## Quasar CLI project
+
+
+Install the [App Extension](../app-extension).
+
+**OR**:
+
+
+Create and register a boot file:
+
+```js
+import Vue from 'vue'
+import Plugin from 'quasar-ui-quasar-ui'
+import 'quasar-ui-quasar-ui/dist/index.css'
+
+Vue.use(Plugin)
+```
+
+**OR**:
+
+```html
+<style src="quasar-ui-quasar-ui/dist/index.css"></style>
+
+<script>
+import { Component as MyComponent, Directive } from 'quasar-ui-quasar-ui'
+
+export default {
+  
+  components: {
+    MyComponent
+  },
+  
+  
+  directives: {
+    Directive
+  }
+  
+}
+</script>
+```
+
+## Vue CLI project
+
+```js
+import Vue from 'vue'
+import Plugin from 'quasar-ui-quasar-ui'
+import 'quasar-ui-quasar-ui/dist/index.css'
+
+Vue.use(Plugin)
+```
+
+**OR**:
+
+```html
+<style src="quasar-ui-quasar-ui/dist/index.css"></style>
+
+<script>
+import { Component as MyComponent, Directive } from 'quasar-ui-quasar-ui'
+
+export default {
+  
+  components: {
+    MyComponent
+  },
+  
+  
+  directives: {
+    Directive
+  }
+  
+}
+</script>
+```
+
+## UMD variant
+
+Exports `window.quasarUi`.
+
+Add the following tag(s) after the Quasar ones:
+
+```html
+<head>
+  <!-- AFTER the Quasar stylesheet tags: -->
+  <link href="https://cdn.jsdelivr.net/npm/quasar-ui-quasar-ui/dist/index.min.css" rel="stylesheet" type="text/css">
+</head>
+<body>
+  <!-- at end of body, AFTER Quasar script(s): -->
+  <script src="https://cdn.jsdelivr.net/npm/quasar-ui-quasar-ui/dist/index.umd.min.js"></script>
+</body>
+```
+If you need the RTL variant of the CSS, then go for the following (instead of the above stylesheet link):
+```html
+<link href="https://cdn.jsdelivr.net/npm/quasar-ui-quasar-ui/dist/index.rtl.min.css" rel="stylesheet" type="text/css">
+```
+
+# Setup
+```bash
+$ yarn
+```
+
+# Developing
+```bash
+# start dev in SPA mode
+$ yarn dev
+
+# start dev in UMD mode
+$ yarn dev:umd
+
+# start dev in SSR mode
+$ yarn dev:ssr
+
+# start dev in Cordova iOS mode
+$ yarn dev:ios
+
+# start dev in Cordova Android mode
+$ yarn dev:android
+
+# start dev in Electron mode
+$ yarn dev:electron
+```
+
+# Building package
+```bash
+$ yarn build
+```
+
+# Adding Testing Components
+in the `ui/dev/src/pages` you can add Vue files to test your component/directive. When using `yarn dev` to build the UI, any pages in that location will automatically be picked up by dynamic routing and added to the test page.
+
+# Adding Assets
+If you have a component that has assets, like language or icon-sets, you will need to provide these for UMD. In the `ui/build/script.javascript.js` file, you will find a couple of commented out commands that call `addAssets`. Uncomment what you need and add your assets to have them be built and put into the `ui/dist` folder.
+
+# Donate
+If you appreciate the work that went into this, please consider [donating to Quasar](https://donate.quasar.dev).
+
+# License
+MIT (c) eunjin0212 <eunjin9639@gmail.com>