vuetify-pro-tiptap - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

CHANGELOG.md

@@ -0,1 +1,13 @@
+# [1.1.0](https://github.com/yikoyu/vuetify-pro-tiptap/compare/v1.0.1...v1.1.0) (2022-06-14)
+
+
+### Bug Fixes
+
+* **TipTapToolbar:** tooltip文本在dialog下无法显示 ([908c1b3](https://github.com/yikoyu/vuetify-pro-tiptap/commit/908c1b393ed35b8252541edee8bf91513581915b))
+
+
+### Features
+
+* 编辑器可进行全局配置 ([1ab3299](https://github.com/yikoyu/vuetify-pro-tiptap/commit/1ab329991a5ade7897452f4b5200bea4de257c33))
+
 ## [1.0.1](https://github.com/yikoyu/vuetify-pro-tiptap/compare/v1.0.0...v1.0.1) (2022-06-12)
@@ -2,0 +14,0 @@

lib/index.d.ts

@@ -1,13 +0,25 @@
-import type { PluginFunction } from 'vue';
+import type { VueConstructor, PluginFunction } from 'vue';
 import type { default as Vuetify } from 'vuetify/lib';
 import VuetifyTiptap from './components/VuetifyTiptap.vue';
 import VuetifyViewer from './components/VuetifyViewer.vue';
-export type { ToolbarType } from './constants/toolbar-definitions';
-export type { StarterKitOptions } from './core/tiptap-kit';
+import type { ToolbarType } from './constants/toolbar-definitions';
+import type { StarterKitOptions } from './core/tiptap-kit';
 import locale, { zhHans, en } from './locales';
-export interface InstallationOptions {
+interface InstallationOptions {
     vuetify: Vuetify;
     lang?: string;
+    components?: Record<string, VueConstructor>;
+    config?: Partial<StarterKitOptions>;
 }
+declare module 'vue/types/vue' {
+    interface Vue {
+        $vuetifyProTiptap: {
+            defaultLang?: string;
+            config?: Partial<StarterKitOptions>;
+        };
+    }
+}
 declare const createVuetifyProTipTap: (opts: InstallationOptions) => PluginFunction<InstallationOptions>;
-export { createVuetifyProTipTap, VuetifyTiptap, VuetifyViewer, locale, zhHans, en };
+export { createVuetifyProTipTap, VuetifyTiptap, VuetifyViewer };
+export { locale, zhHans, en };
+export type { ToolbarType, StarterKitOptions, InstallationOptions };

package.json

 {
   "name": "vuetify-pro-tiptap",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "license": "MIT",
@@ -94,16 +94,16 @@ "description": "tiptap text editor on vuejs and vuetify",
     "@types/lodash.throttle": "^4.1.7",
-    "@types/node": "^16.11.8",
+    "@types/node": "^17.0.42",
     "@vitejs/plugin-vue": "^2.3.3",
-    "@vue/composition-api": "^1.4.0",
+    "@vue/composition-api": "^1.6.2",
     "@vue/eslint-config-prettier": "^7.0.0",
-    "@vue/eslint-config-typescript": "^10.0.0",
+    "@vue/eslint-config-typescript": "^11.0.0",
     "@vue/runtime-dom": "^3.2.37",
     "commitizen": "^4.2.4",
-    "eslint": "^8.16.0",
+    "eslint": "^8.17.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-define-config": "^1.5.0",
+    "eslint-define-config": "^1.5.1",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-vue": "^9.1.0",
+    "eslint-plugin-vue": "^9.1.1",
     "husky": "^8.0.1",
-    "lint-staged": "^13.0.0",
+    "lint-staged": "^13.0.1",
     "lodash.merge": "^4.6.2",
@@ -114,11 +114,11 @@ "lodash.throttle": "^4.1.1",
     "semantic-release": "^19.0.3",
-    "typescript": "^4.7.2",
+    "typescript": "^4.7.3",
     "unplugin-vue-components": "^0.19.6",
-    "vite": "^2.9.9",
+    "vite": "^2.9.12",
     "vite-plugin-dts": "^1.2.0",
-    "vite-plugin-eslint": "^1.3.0",
+    "vite-plugin-eslint": "^1.6.1",
     "vite-plugin-vue2": "^2.0.1",
     "vue": "^2.6.14",
     "vue-template-compiler": "^2.6.14",
-    "vue-tsc": "0.37.3",
+    "vue-tsc": "0.37.7",
     "vue-types": "^4.1.1",
@@ -125,0 +125,0 @@ "vuetify": "^2.6.6",

README.md

@@ -77,3 +77,29 @@ # Vuetify Pro Tiptap
 ```
+## 全局设置
+```TypeScript
+import { VuetifyTiptap, VuetifyViewer, createVuetifyProTipTap } from 'vuetify-pro-tiptap'
+import 'vuetify-pro-tiptap/style.css'
 
+const VuetifyProTipTap = createVuetifyProTipTap({
+  vuetify,
+  lang: 'zhHans',
+  components: {
+    VuetifyTiptap,
+    VuetifyViewer
+  },
+  // 编辑器全局配置
+  config: {
+    image: {
+      imageTabs: [{ name: 'SELECT', component: SelectImage }],
+      hiddenTabs: ['upload'],
+      upload(file: File) {
+        return Promise.resolve(/** image url */)
+      }
+    }
+  }
+})
+
+Vue.use(VuetifyProTipTap)
+```
+
 ## 国际化
@@ -80,0 +106,0 @@

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1328247

0.9%

Lines of code

26879

0.22%

Number of lines in readme file

287

9.96%

Worsened metrics

Number of low supply chain risk alerts

3

50%

No dependency changes