diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0914bda..a3f91c6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 6.3.0
+
+* Injected values can now be wrapped in an object so that they can be reactive in Vue 2.
+
## 6.2.4
* Fixed that attributes were not outputted onto the chart root element for Vue 2 (#670).
diff --git a/README.md b/README.md
index f7fb383..6d4a5c1 100644
--- a/README.md
+++ b/README.md
@@ -399,16 +399,16 @@ Vue-ECharts provides provide/inject API for `theme`, `init-options`, `update-opt
Vue 3
```js
-import { INIT_OPTIONS_KEY } from 'vue-echarts'
+import { THEME_KEY } from 'vue-echarts'
import { provide } from 'vue'
// composition API
-provide(INIT_OPTIONS_KEY, ...)
+provide(THEME_KEY, 'dark')
// options API
{
provide: {
- [INIT_OPTIONS_KEY]: { ... }
+ [THEME_KEY]: 'dark'
}
}
```
@@ -419,16 +419,35 @@ provide(INIT_OPTIONS_KEY, ...)
Vue 2
```js
-import { INIT_OPTIONS_KEY } from 'vue-echarts'
+import { THEME_KEY } from 'vue-echarts'
// in component options
{
provide: {
- [INIT_OPTIONS_KEY]: { ... }
+ [THEME_KEY]: 'dark'
}
}
```
+> **Note**
+>
+> You need to provide an object for Vue 2 if you want to change it dynamically.
+>
+> ```js
+> // in component options
+> {
+> data () {
+> return {
+> theme: { value: 'dark' }
+> }
+> },
+> provide () {
+> return {
+> [THEME_KEY]: this.theme
+> }
+> }
+> }
+> ```
### Methods
@@ -464,6 +483,8 @@ You can bind events with Vue's `v-on` directive.
```
+> **Note**
+>
> Only the `.once` event modifier is supported as other modifiers are tightly coupled with the DOM event system.
Vue-ECharts support the following events:
diff --git a/README.zh-Hans.md b/README.zh-Hans.md
index dcdc1dc..47537ad 100644
--- a/README.zh-Hans.md
+++ b/README.zh-Hans.md
@@ -400,6 +400,8 @@ Vue.component("v-chart", VueECharts);
```
+> **Note**
+>
> 仅支持 `.once` 修饰符,因为其它修饰符都与 DOM 事件机制强耦合。
Vue-ECharts 支持如下事件:
@@ -458,16 +460,16 @@ Vue-ECharts 为 `theme`、`init-options`、`update-options` 和 `loading-options
Vue 3
```js
-import { INIT_OPTIONS_KEY } from 'vue-echarts'
+import { THEME_KEY } from 'vue-echarts'
import { provide } from 'vue'
-// composition API
-provide(INIT_OPTIONS_KEY, ...)
+// 组合式 API
+provide(THEME_KEY, 'dark')
-// options API
+// 选项式 API
{
provide: {
- [INIT_OPTIONS_KEY]: { ... }
+ [THEME_KEY]: 'dark'
}
}
```
@@ -478,16 +480,35 @@ provide(INIT_OPTIONS_KEY, ...)
Vue 2
```js
-import { INIT_OPTIONS_KEY } from 'vue-echarts'
+import { THEME_KEY } from 'vue-echarts'
-// in component options
+// 组件选项中
{
provide: {
- [INIT_OPTIONS_KEY]: { ... }
+ [THEME_KEY]: 'dark'
}
}
```
+> **Note**
+>
+> 在 Vue 2 中,如果你想动态地改变这些选项,那么你需要提供一个对象。
+>
+> ```js
+> // 组件选项中
+> {
+> data () {
+> return {
+> theme: { value: 'dark' }
+> }
+> },
+> provide () {
+> return {
+> [THEME_KEY]: this.theme
+> }
+> }
+> }
+> ```
### 方法
diff --git a/package.json b/package.json
index 606d9cb..e2f7961 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "vue-echarts",
- "version": "6.2.4",
+ "version": "6.3.0",
"description": "Vue.js component for Apache ECharts.",
"author": "GU Yiling ",
"scripts": {
@@ -62,7 +62,7 @@
"tslib": "^2.4.0",
"typescript": "4.6.4",
"vue": "^3.2.33",
- "vue2": "npm:vue@^2.7.4",
+ "vue2": "npm:vue@^2.7.14",
"webpack": "^5.72.1"
},
"peerDependencies": {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 1745d69..6652243 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -38,7 +38,7 @@ specifiers:
typescript: 4.6.4
vue: ^3.2.33
vue-demi: ^0.13.2
- vue2: npm:vue@^2.7.4
+ vue2: npm:vue@^2.7.14
webpack: ^5.72.1
dependencies:
@@ -81,7 +81,7 @@ devDependencies:
tslib: 2.4.0
typescript: 4.6.4
vue: 3.2.37
- vue2: /vue/2.7.4
+ vue2: /vue/2.7.14
webpack: 5.73.0
packages:
@@ -2340,8 +2340,8 @@ packages:
'@vue/compiler-core': 3.2.37
'@vue/shared': 3.2.37
- /@vue/compiler-sfc/2.7.4:
- resolution: {integrity: sha512-WCaF33mlKLSvHDKvOD6FzTa5CI2FlMTeJf3MxJsNP0KDgRoI6RdXhHo9dtvCqV4Sywf9Owm17wTLT1Ymu/WsOQ==}
+ /@vue/compiler-sfc/2.7.14:
+ resolution: {integrity: sha512-aNmNHyLPsw+sVvlQFQ2/8sjNuLtK54TC6cuKnVzAY93ks4ZBrvwQSnkkIh7bsbNhum5hJBS00wSDipQ937f5DA==}
dependencies:
'@babel/parser': 7.18.6
postcss: 8.4.14
@@ -7502,10 +7502,10 @@ packages:
resolution: {integrity: sha512-4gDntzrifFnCEvyoO8PqyJDmguXgVPxKiIxrBKjIowvL9l+N66196+72XVYR8BBf1Uv1Fgt3bGevJ+sEmxfZzw==}
dev: true
- /vue/2.7.4:
- resolution: {integrity: sha512-8KGyyzFSj/FrKj1y7jyEpv8J4osgZx6Lk1lVzh1aP4BqsXZhATH1r0gdJNz00MMyBhK0/m2cNoPuOZ1NzeiUEw==}
+ /vue/2.7.14:
+ resolution: {integrity: sha512-b2qkFyOM0kwqWFuQmgd4o+uHGU7T+2z3T+WQp8UBjADfEv2n4FEMffzBmCKNP0IGzOEEfYjvtcC62xaSKeQDrQ==}
dependencies:
- '@vue/compiler-sfc': 2.7.4
+ '@vue/compiler-sfc': 2.7.14
csstype: 3.1.0
dev: true
diff --git a/src/ECharts.ts b/src/ECharts.ts
index 3321b52..d1c62e4 100644
--- a/src/ECharts.ts
+++ b/src/ECharts.ts
@@ -2,7 +2,6 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import {
defineComponent,
- unref,
shallowRef,
toRefs,
watch,
@@ -37,7 +36,7 @@ import {
useLoading,
loadingProps
} from "./composables";
-import { omitOn } from "./utils";
+import { omitOn, unwrapInjected } from "./utils";
import "./style.css";
const TAG_NAME = "x-vue-echarts";
@@ -81,12 +80,14 @@ export default defineComponent({
const realOption = computed(
() => manualOption.value || props.option || null
);
- const realTheme = computed(() => props.theme || unref(defaultTheme) || {});
+ const realTheme = computed(
+ () => props.theme || unwrapInjected(defaultTheme, {})
+ );
const realInitOptions = computed(
- () => props.initOptions || unref(defaultInitOptions) || {}
+ () => props.initOptions || unwrapInjected(defaultInitOptions, {})
);
const realUpdateOptions = computed(
- () => props.updateOptions || unref(defaultUpdateOptions) || {}
+ () => props.updateOptions || unwrapInjected(defaultUpdateOptions, {})
);
const nonEventAttrs = computed(() => omitOn(attrs));
diff --git a/src/composables/loading.ts b/src/composables/loading.ts
index 3b1be74..1d7ec4b 100644
--- a/src/composables/loading.ts
+++ b/src/composables/loading.ts
@@ -1,10 +1,11 @@
+import { unwrapInjected } from "src/utils";
import {
inject,
unref,
computed,
- Ref,
watchEffect,
- InjectionKey
+ type Ref,
+ type InjectionKey
} from "vue-demi";
import { EChartsType } from "../types";
@@ -22,7 +23,7 @@ export function useLoading(
): void {
const defaultLoadingOptions = inject(LOADING_OPTIONS_KEY, {});
const realLoadingOptions = computed(() => ({
- ...unref(defaultLoadingOptions),
+ ...unwrapInjected(defaultLoadingOptions, {}),
...loadingOptions?.value
}));
diff --git a/src/index.vue2.d.ts b/src/index.vue2.d.ts
index eacb404..d6da152 100644
--- a/src/index.vue2.d.ts
+++ b/src/index.vue2.d.ts
@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/ban-types */
-import { Ref, DefineComponent } from "vue-demi";
-import { Option, InitOptions, UpdateOptions, EChartsType } from "./types";
+import type { Ref, DefineComponent } from "vue-demi";
+import type { Option, InitOptions, UpdateOptions, EChartsType } from "./types";
declare const LOADING_OPTIONS_KEY = "ecLoadingOptions";
declare const THEME_KEY = "ecTheme";
diff --git a/src/types.ts b/src/types.ts
index 31f6070..a242d16 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -1,21 +1,21 @@
-import { init, SetOptionOpts } from "echarts/core";
-import { Ref } from "vue";
+import { init, type SetOptionOpts } from "echarts/core";
+import type { Ref } from "vue";
+
+export type Injection = T | null | Ref | { value: T | null };
type InitType = typeof init;
export type InitParameters = Parameters;
export type Theme = NonNullable;
-export type ThemeInjection = Theme | null | Ref;
+export type ThemeInjection = Injection;
export type InitOptions = NonNullable;
-export type InitOptionsInjection = InitOptions | null | Ref;
+
+export type InitOptionsInjection = Injection;
+
+export type UpdateOptions = SetOptionOpts;
+export type UpdateOptionsInjection = Injection;
export type EChartsType = ReturnType;
type ZRenderType = ReturnType;
export type EventTarget = EChartsType | ZRenderType;
type SetOptionType = EChartsType["setOption"];
export type Option = Parameters[0];
-
-export type UpdateOptions = SetOptionOpts;
-export type UpdateOptionsInjection =
- | UpdateOptions
- | null
- | Ref;
diff --git a/src/utils.ts b/src/utils.ts
index 8ac89ee..a0e7e71 100644
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -1,3 +1,6 @@
+import { unref } from "vue-demi";
+import type { Injection } from "./types";
+
type Attrs = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
[key: string]: any;
@@ -18,3 +21,16 @@ export function omitOn(attrs: Attrs): Attrs {
return result;
}
+
+export function unwrapInjected(
+ injection: Injection,
+ defaultValue: V
+): T | V {
+ const value = unref(injection);
+
+ if (value && typeof value === "object" && "value" in value) {
+ return value.value || defaultValue;
+ }
+
+ return value || defaultValue;
+}