@clayui/tooltip 3.141.2-alpha.0 → 3.143.0

package/lib/Tooltip.d.ts

@@ -0,0 +1,18 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import React from 'react';
+export declare const ALIGN_POSITIONS: readonly ["top", "top-left", "top-right", "bottom", "bottom-left", "bottom-right", "left", "right"];
+interface IProps extends React.HTMLAttributes<HTMLDivElement> {
+    /**
+     * Position in which the tooltip will be aligned to the element.
+     */
+    alignPosition?: typeof ALIGN_POSITIONS[number];
+    /**
+     * Flag to indicate if tooltip is displayed.
+     */
+    show?: boolean;
+}
+export declare const Tooltip: React.ForwardRefExoticComponent<IProps & React.RefAttributes<HTMLElement>>;
+export {};

package/lib/TooltipProvider.d.ts

@@ -0,0 +1,37 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { IPortalBaseProps } from '@clayui/shared';
+import React from 'react';
+declare type TContentRenderer = (props: {
+    targetNode?: HTMLElement | null;
+    title: string;
+}) => React.ReactElement | React.ReactNode;
+declare type Props = {
+    /**
+     * Flag to indicate if tooltip should automatically align based on the window
+     */
+    autoAlign?: boolean;
+    /**
+     * Props to add to the `<ClayPortal/>`.
+     */
+    containerProps?: IPortalBaseProps;
+    /**
+     * Custom function for rendering the contents of the tooltip
+     */
+    contentRenderer?: TContentRenderer;
+    /**
+     * Delay in miliseconds before showing tooltip
+     */
+    delay?: number;
+    children?: React.ReactElement;
+    /**
+     * CSS selector to scope provider to. All titles within this scope will be
+     * rendered in the tooltip. Titles outside of this scope will be styled
+     * as with the default browser.
+     */
+    scope?: string;
+};
+export declare const ClayTooltipProvider: ({ autoAlign, children, containerProps, contentRenderer, delay, scope, }: Props) => JSX.Element;
+export {};

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { Tooltip } from './Tooltip';
+import { ClayTooltipProvider } from './TooltipProvider';
+export { Tooltip, ClayTooltipProvider };
+export default Tooltip;

package/lib/useAlign.d.ts

@@ -0,0 +1,19 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import React from 'react';
+declare const ALIGNMENTS: readonly ["top", "top-right", "right", "bottom-right", "bottom", "bottom-left", "left", "top-left"];
+export declare type Align = typeof ALIGNMENTS[number];
+declare type Props = {
+    align: Align;
+    autoAlign: boolean;
+    floating: boolean;
+    isOpen: boolean;
+    onAlign: (align: Align) => void;
+    sourceElement: React.MutableRefObject<HTMLElement | null>;
+    targetElement: React.MutableRefObject<HTMLElement | null>;
+    title: string;
+};
+export declare function useAlign({ align, autoAlign, floating, isOpen, onAlign, sourceElement, targetElement, title, }: Props): void;
+export {};

package/lib/useClosestTitle.d.ts

@@ -0,0 +1,25 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import React from 'react';
+declare type Props = {
+    forceHide: () => void;
+    onHide: () => void;
+    onClick: () => void;
+    tooltipRef: React.MutableRefObject<HTMLElement | null>;
+};
+export declare function useClosestTitle(props: Props): {
+    forceHide: () => void;
+    getProps: (event: React.MouseEvent<HTMLElement, MouseEvent>, hideBrowserTitle: boolean) => {
+        align: string | null;
+        delay: string | null;
+        floating: boolean;
+        setAsHTML: boolean;
+        title: string;
+    } | undefined;
+    onHide: (event?: any) => null | undefined;
+    target: React.MutableRefObject<HTMLElement | null>;
+    titleNode: React.MutableRefObject<HTMLElement | null>;
+};
+export {};

package/lib/useTooltipState.d.ts

@@ -0,0 +1,13 @@
+/**
+ * SPDX-FileCopyrightText: © 2019 Liferay, Inc. <https://liferay.com>
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+declare type Props = {
+    delay?: number;
+};
+export declare function useTooltipState({ delay }: Props): {
+    close: () => void;
+    isOpen: boolean;
+    open: (immediate: boolean, customDelay?: number) => void;
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@clayui/tooltip",
-	"version": "3.141.2-alpha.0",
+	"version": "3.143.0",
 	"description": "ClayTooltip component",
 	"license": "BSD-3-Clause",
 	"repository": "https://github.com/liferay/clay",
@@ -28,18 +28,18 @@
 		"react"
 	],
 	"dependencies": {
-		"@clayui/shared": "^3.141.2-alpha.0",
+		"@clayui/shared": "^3.143.0",
 		"classnames": "^2.2.6",
 		"dom-align": "^1.12.2",
 		"warning": "^4.0.3"
 	},
 	"peerDependencies": {
 		"@clayui/css": "3.x",
-		"react": "^16.12.0",
-		"react-dom": "^16.12.0"
+		"react": "^18.2.0",
+		"react-dom": "^18.2.0"
 	},
 	"browserslist": [
 		"extends browserslist-config-clay"
 	],
-	"gitHead": "aea6ecdaee62ccc374009982f934e1b193785668"
+	"gitHead": "aacf20646cc7fb25c4d60e865ec77d2d503d23e9"
 }