feat: creating useRegisterXModule composable

empathyco · Jan 22, 2024 · 4190d6e · 4190d6e
1 parent 9cd94f7
commit 4190d6e
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/packages/x-components/src/composables/index.ts b/packages/x-components/src/composables/index.ts
@@ -1,2 +1,3 @@
 export * from './create-use-device.composable';
 export * from './use-$x';
+export * from './use-register-x-module';
diff --git a/packages/x-components/src/composables/use-register-x-module.ts b/packages/x-components/src/composables/use-register-x-module.ts
@@ -0,0 +1,14 @@
+import { AnyXModule } from '../x-modules/x-modules.types';
+import { XPlugin } from '../plugins/x-plugin';
+/**
+ * Initializes a component as an X-Component:
+ * * Registers the module passed as parameter.
+ * * Flags the component as X-Component, so then it can be detected with the {@link isXComponent}
+ * function.
+ *
+ * @param module - The module associated to the X-Component that is being registered.
+ * @public
+ */
+export function useRegisterXModule(module: AnyXModule): void {
+  XPlugin.registerXModule(module);
+}