feat(components): create useStore composable (#1401)

empathyco · Feb 1, 2024 · b4e42b9 · b4e42b9
1 parent 7784302
commit b4e42b9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/packages/x-components/src/composables/index.ts b/packages/x-components/src/composables/index.ts
@@ -2,3 +2,4 @@ export * from './create-use-device.composable';
 export * from './use-$x';
 export * from './use-register-x-module';
 export * from './use-on-display';
+export * from './use-store';
diff --git a/packages/x-components/src/composables/use-store.ts b/packages/x-components/src/composables/use-store.ts
@@ -0,0 +1,13 @@
+import { getCurrentInstance } from 'vue';
+import { Store } from 'vuex';
+
+/**
+ * Function which returns the `$store` object from the current component instance.
+ *
+ * @returns The `$store` object from the current component instance.
+ *
+ * @public
+ */
+export function useStore(): Store<any> {
+  return (getCurrentInstance()?.proxy as { $store: Store<any> }).$store;
+}