@tamagui/portal 1.0.1-beta.21 → 1.0.1-beta.211

package/types/GorhomPortal.d.ts

@@ -0,0 +1,106 @@
+import { ReactNode } from 'react';
+import React from 'react';
+declare enum ACTIONS {
+    REGISTER_HOST = 0,
+    DEREGISTER_HOST = 1,
+    ADD_UPDATE_PORTAL = 2,
+    REMOVE_PORTAL = 3
+}
+declare const INITIAL_STATE: {};
+export { ACTIONS, INITIAL_STATE };
+export interface AddUpdatePortalAction {
+    type: ACTIONS;
+    hostName: string;
+    portalName: string;
+    node: ReactNode;
+}
+export interface RemovePortalAction {
+    type: ACTIONS;
+    hostName: string;
+    portalName: string;
+}
+export interface RegisterHostAction {
+    type: ACTIONS;
+    hostName: string;
+}
+export interface UnregisterHostAction {
+    type: ACTIONS;
+    hostName: string;
+}
+export declare type ActionTypes = AddUpdatePortalAction | RemovePortalAction | RegisterHostAction | UnregisterHostAction;
+export declare const usePortal: (hostName?: string) => {
+    registerHost: () => void;
+    deregisterHost: () => void;
+    addPortal: (name: string, node: ReactNode) => void;
+    updatePortal: (name: string, node: ReactNode) => void;
+    removePortal: (name: string) => void;
+};
+export interface PortalProviderProps {
+    /**
+     * Defines whether to add a default root host or not.
+     *
+     * @default true
+     * @type boolean
+     */
+    shouldAddRootHost?: boolean;
+    /**
+     * Defines the root portal host name.
+     *
+     * @default "root"
+     * @type string
+     */
+    rootHostName?: string;
+    children: ReactNode | ReactNode[];
+}
+export declare const PortalProvider: React.MemoExoticComponent<({ rootHostName, shouldAddRootHost, children, }: PortalProviderProps) => JSX.Element>;
+export interface PortalHostProps {
+    /**
+     * Host's key or name to be used as an identifier.
+     * @type string
+     */
+    name: string;
+}
+export declare const PortalHost: React.MemoExoticComponent<({ name }: PortalHostProps) => JSX.Element>;
+export interface PortalItemProps {
+    /**
+     * Portal's key or name to be used as an identifier.
+     * @type string
+     * @default nanoid generated unique key.
+     */
+    name?: string;
+    /**
+     * Host's name to teleport the portal content to.
+     * @type string
+     * @default 'root'
+     */
+    hostName?: string;
+    /**
+     * Override internal mounting functionality, this is useful
+     * if you want to trigger any action before mounting the portal content.
+     * @type (mount?: () => void) => void
+     * @default undefined
+     */
+    handleOnMount?: (mount: () => void) => void;
+    /**
+     * Override internal un-mounting functionality, this is useful
+     * if you want to trigger any action before un-mounting the portal content.
+     * @type (unmount?: () => void) => void
+     * @default undefined
+     */
+    handleOnUnmount?: (unmount: () => void) => void;
+    /**
+     * Override internal updating functionality, this is useful
+     * if you want to trigger any action before updating the portal content.
+     * @type (update?: () => void) => void
+     * @default undefined
+     */
+    handleOnUpdate?: (update: () => void) => void;
+    /**
+     * Portal's content.
+     * @type ReactNode
+     * @default undefined
+     */
+    children?: ReactNode | ReactNode[];
+}
+export declare const PortalItem: React.MemoExoticComponent<({ name, hostName, handleOnMount, handleOnUnmount, handleOnUpdate, children, }: PortalItemProps) => null>;
+//# sourceMappingURL=GorhomPortal.d.ts.map

package/types/Portal.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="react" />
 import '@tamagui/polyfill-dev';
-import { YStackProps } from '@tamagui/stacks';
-export declare const Portal: (props: YStackProps) => JSX.Element | null;
+import * as React from 'react';
+import { PortalProps } from './PortalProps';
+export declare const Portal: ({ host, ...props }: PortalProps) => React.ReactPortal | null;
 //# sourceMappingURL=Portal.d.ts.map

package/types/Portal.native.d.ts

@@ -0,0 +1,3 @@
+import { PortalProps } from './PortalProps';
+export declare const Portal: (props: PortalProps) => any;
+//# sourceMappingURL=Portal.native.d.ts.map

package/types/PortalProps.d.ts

@@ -0,0 +1,6 @@
+import { YStackProps } from '@tamagui/stacks';
+export declare type PortalProps = YStackProps & {
+    host?: any;
+    inactive?: boolean;
+};
+//# sourceMappingURL=PortalProps.d.ts.map

package/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './Portal';
+export * from './GorhomPortal';
 //# sourceMappingURL=index.d.ts.map

package/types/Portal.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Portal.d.ts","sourceRoot":"","sources":["../src/Portal.tsx"],"names":[],"mappings":";AAAA,OAAO,uBAAuB,CAAA;AAG9B,OAAO,EAAU,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAMrD,eAAO,MAAM,MAAM,UAAW,WAAW,uBAgBxC,CAAA"}

package/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}