promise-portal 2.0.0 → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2022 yuanpeng
+
+Permission is hereby granted, free of
+charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice
+(including the next paragraph) shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -293,7 +293,8 @@ definePortal(Comp, {
   // Initial value for the show ref (defaults to true)
   initialShowValue: true,
 
-  // a dom element or CSS selector to append the portal element to (defaults to document.body)
+  // a dom element or CSS selector or Ref value or a function returing a dom element,
+  // append the portal element to (defaults to document.body)
   appendTo: document.body,
 })
 ```

package/dist/index.cjs

@@ -25,7 +25,6 @@ const detectPromisePortalInstance = (options = {}) => {
 //#endregion
 //#region src/portal.ts
 const promisePortalSymbol = Symbol("promise-portal");
-const version = `2.0.0`;
 let activeInstance;
 const createPromisePortal = () => {
 	const instance = {
@@ -51,7 +50,12 @@ const usePortalContext = (options = {}) => {
 	if (options.initialShowValue !== void 0) scope.show.value = options.initialShowValue;
 	return scope;
 };
-const resolveTarget = (to) => typeof to === "string" ? document.querySelector(to) : to;
+const resolveTarget = (to) => {
+	if (typeof to === "string") return document.querySelector(to);
+	else if ((0, vue.isRef)(to)) return (0, vue.unref)(to);
+	else if (typeof to === "function") return to();
+	return to;
+};
 const definePortal = (component, options = {}) => {
 	const instance = ((0, vue.getCurrentInstance)() && (0, vue.inject)(promisePortalSymbol)) ?? activeInstance;
 	if (!instance) throw new Error("[promise-portal]: no instance found. Did you forget to install promise-portal?");
@@ -110,5 +114,4 @@ exports.ContextProvider = ContextProvider;
 exports.createPromisePortal = createPromisePortal;
 exports.definePortal = definePortal;
 exports.detectPromisePortalInstance = detectPromisePortalInstance;
-exports.usePortalContext = usePortalContext;
-exports.version = version;
+exports.usePortalContext = usePortalContext;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as vue0 from "vue";
-import { App, Component, Ref, RendererElement, VNode } from "vue";
+import { App, Component, Ref, VNode } from "vue";
 
 //#region src/detector.d.ts
 interface DetectorOptions {
@@ -9,13 +9,12 @@ interface DetectorOptions {
 declare const detectPromisePortalInstance: (options?: DetectorOptions) => () => void;
 //#endregion
 //#region src/portal.d.ts
-declare const version = "2.0.0";
 interface UsePortalContextOptions {
   unmountDelay?: number;
   initialShowValue?: boolean;
 }
 interface DefinePortalOptions extends UsePortalContextOptions {
-  appendTo?: string | RendererElement | null | undefined;
+  appendTo?: string | HTMLElement | Ref<HTMLElement> | (() => HTMLElement);
 }
 type DefinePortalResult<Output, Input> = [(props?: Input, children?: unknown) => Promise<Output>, Component];
 interface Scope<R> {
@@ -35,8 +34,8 @@ interface Instance<R = any> {
 declare const createPromisePortal: () => Instance<any>;
 declare const usePortalContext: <Output = any>(options?: UsePortalContextOptions) => Scope<Output>;
 declare const definePortal: <Output = any, Input = any>(component: Component, options?: DefinePortalOptions) => DefinePortalResult<Output, Input>;
-declare const ContextProvider: vue0.DefineComponent<{}, () => VNode<vue0.RendererNode, RendererElement, {
+declare const ContextProvider: vue0.DefineComponent<{}, () => VNode<vue0.RendererNode, vue0.RendererElement, {
   [key: string]: any;
 }>[] | undefined, {}, {}, {}, vue0.ComponentOptionsMixin, vue0.ComponentOptionsMixin, {}, string, vue0.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue0.ComponentProvideOptions, true, {}, any>;
 //#endregion
-export { ContextProvider, DefinePortalOptions, DefinePortalResult, DetectorOptions, Instance, Scope, UsePortalContextOptions, createPromisePortal, definePortal, detectPromisePortalInstance, usePortalContext, version };
+export { ContextProvider, DefinePortalOptions, DefinePortalResult, DetectorOptions, Instance, Scope, UsePortalContextOptions, createPromisePortal, definePortal, detectPromisePortalInstance, usePortalContext };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as vue0 from "vue";
-import { App, Component, Ref, RendererElement, VNode } from "vue";
+import { App, Component, Ref, VNode } from "vue";
 
 //#region src/detector.d.ts
 interface DetectorOptions {
@@ -9,13 +9,12 @@ interface DetectorOptions {
 declare const detectPromisePortalInstance: (options?: DetectorOptions) => () => void;
 //#endregion
 //#region src/portal.d.ts
-declare const version = "2.0.0";
 interface UsePortalContextOptions {
   unmountDelay?: number;
   initialShowValue?: boolean;
 }
 interface DefinePortalOptions extends UsePortalContextOptions {
-  appendTo?: string | RendererElement | null | undefined;
+  appendTo?: string | HTMLElement | Ref<HTMLElement> | (() => HTMLElement);
 }
 type DefinePortalResult<Output, Input> = [(props?: Input, children?: unknown) => Promise<Output>, Component];
 interface Scope<R> {
@@ -35,8 +34,8 @@ interface Instance<R = any> {
 declare const createPromisePortal: () => Instance<any>;
 declare const usePortalContext: <Output = any>(options?: UsePortalContextOptions) => Scope<Output>;
 declare const definePortal: <Output = any, Input = any>(component: Component, options?: DefinePortalOptions) => DefinePortalResult<Output, Input>;
-declare const ContextProvider: vue0.DefineComponent<{}, () => VNode<vue0.RendererNode, RendererElement, {
+declare const ContextProvider: vue0.DefineComponent<{}, () => VNode<vue0.RendererNode, vue0.RendererElement, {
   [key: string]: any;
 }>[] | undefined, {}, {}, {}, vue0.ComponentOptionsMixin, vue0.ComponentOptionsMixin, {}, string, vue0.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue0.ComponentProvideOptions, true, {}, any>;
 //#endregion
-export { ContextProvider, DefinePortalOptions, DefinePortalResult, DetectorOptions, Instance, Scope, UsePortalContextOptions, createPromisePortal, definePortal, detectPromisePortalInstance, usePortalContext, version };
+export { ContextProvider, DefinePortalOptions, DefinePortalResult, DetectorOptions, Instance, Scope, UsePortalContextOptions, createPromisePortal, definePortal, detectPromisePortalInstance, usePortalContext };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { createVNode, defineComponent, getCurrentInstance, inject, ref, render } from "vue";
+import { createVNode, defineComponent, getCurrentInstance, inject, isRef, ref, render, unref } from "vue";
 
 //#region src/detector.ts
 function detect(options) {
@@ -25,7 +25,6 @@ const detectPromisePortalInstance = (options = {}) => {
 //#endregion
 //#region src/portal.ts
 const promisePortalSymbol = Symbol("promise-portal");
-const version = `2.0.0`;
 let activeInstance;
 const createPromisePortal = () => {
 	const instance = {
@@ -51,7 +50,12 @@ const usePortalContext = (options = {}) => {
 	if (options.initialShowValue !== void 0) scope.show.value = options.initialShowValue;
 	return scope;
 };
-const resolveTarget = (to) => typeof to === "string" ? document.querySelector(to) : to;
+const resolveTarget = (to) => {
+	if (typeof to === "string") return document.querySelector(to);
+	else if (isRef(to)) return unref(to);
+	else if (typeof to === "function") return to();
+	return to;
+};
 const definePortal = (component, options = {}) => {
 	const instance = (getCurrentInstance() && inject(promisePortalSymbol)) ?? activeInstance;
 	if (!instance) throw new Error("[promise-portal]: no instance found. Did you forget to install promise-portal?");
@@ -106,4 +110,4 @@ const ContextProvider = defineComponent({
 });
 
 //#endregion
-export { ContextProvider, createPromisePortal, definePortal, detectPromisePortalInstance, usePortalContext, version };
+export { ContextProvider, createPromisePortal, definePortal, detectPromisePortalInstance, usePortalContext };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "promise-portal",
   "type": "module",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "use component as a promisd-like function",
   "author": {
     "name": "tjyuanpeng",
@@ -35,17 +35,17 @@
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "vue": "3"
+  },
+  "devDependencies": {
+    "tsdown": "0.20.1",
+    "typescript": "~5.9.3"
+  },
   "scripts": {
     "dev": "tsdown --watch",
     "build": "tsdown",
     "typecheck": "tsc --noEmit",
     "lint": "eslint ."
-  },
-  "peerDependencies": {
-    "vue": "3"
-  },
-  "devDependencies": {
-    "tsdown": "catalog:",
-    "typescript": "catalog:"
   }
-}
+}