amis-ui 3.6.2 → 6.0.0

package/esm/components/OverflowTpl.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @file OverflowTpl
+ * @desc 文字提示组件，会基于内部文字是否触发ellipsis，动态展示tooltip提示, 默认使用子节点文本作为tooltip内容
+ */
+/// <reference types="hoist-non-react-statics" />
+import React from 'react';
+import type { ThemeProps } from 'amis-core';
+import type { TooltipWrapperProps } from './TooltipWrapper';
+export interface OverflowTplProps extends ThemeProps {
+    className?: string;
+    /**
+     * tooltip相关配置
+     */
+    tooltip?: TooltipWrapperProps['tooltip'];
+    /**
+     * 是否使用行内标签，默认为 true，使用 span 标签，否则使用 div 标签
+     */
+    inline?: boolean;
+    /**
+     * 目标元素的selector，通常不需要指定
+     */
+    targetSelector?: string;
+    /**
+     * 内部节点
+     */
+    children?: React.ReactNode | React.ReactNode[];
+}
+declare const _default: {
+    new (props: Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps): {
+        ref: any;
+        childRef(ref: any): void;
+        getWrappedInstance(): any;
+        render(): React.JSX.Element;
+        context: unknown;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidMount?(): void;
+        shouldComponentUpdate?(nextProps: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        /** 监听目标元素的DOM变化 */
+        getSnapshotBeforeUpdate?(prevProps: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<Omit<OverflowTplProps, keyof ThemeProps> & import("packages/amis-core/lib/theme").ThemeOuterProps>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    displayName: string;
+    contextType: React.Context<string>;
+    ComposedComponent: React.ComponentType<React.FC<OverflowTplProps>>;
+} & import("hoist-non-react-statics").NonReactStatics<React.FC<OverflowTplProps>, {}> & {
+    ComposedComponent: React.FC<OverflowTplProps>;
+};
+export default _default;

package/esm/components/OverflowTpl.js

@@ -0,0 +1,101 @@
+/**
+ * amis-ui v6.0.0
+ * Copyright 2018-2023 fex
+ */
+
+import { __read, __assign } from 'tslib';
+import React__default, { useState, useRef, useCallback, useEffect } from 'react';
+import { findDOMNode } from 'react-dom';
+import omit from 'lodash/omit';
+import { themeable, isObject } from 'amis-core';
+import TooltipWrapper from './TooltipWrapper.js';
+
+/**
+ * @file OverflowTpl
+ * @desc 文字提示组件，会基于内部文字是否触发ellipsis，动态展示tooltip提示, 默认使用子节点文本作为tooltip内容
+ */
+var OverflowTpl = function (props) {
+    var cx = props.classnames, children = props.children, className = props.className, targetSelector = props.targetSelector, tooltip = props.tooltip, _a = props.inline, inline = _a === void 0 ? true : _a;
+    var _b = __read(useState(false), 2), ellipsisAvtived = _b[0], setEllipsisAvtived = _b[1];
+    var _c = __read(useState(''), 2), innerText = _c[0], setInnerText = _c[1];
+    var innerRef = useRef(null);
+    var defaultTooltip = tooltip
+        ? typeof tooltip === 'string'
+            ? { content: tooltip }
+            : isObject(tooltip)
+                ? tooltip
+                : undefined
+        : typeof children === 'string'
+            ? { content: children }
+            : undefined; /** 默认使用子节点文本 */
+    var normalizedTooltip = innerText && (!defaultTooltip || (defaultTooltip === null || defaultTooltip === void 0 ? void 0 : defaultTooltip.content) == null)
+        ? __assign(__assign({}, defaultTooltip), { content: innerText }) : defaultTooltip;
+    var updateEllipsisActivation = useCallback(function (el) {
+        setEllipsisAvtived(el
+            ? el.scrollWidth > el.clientWidth || el.scrollHeight > el.scrollHeight
+            : false);
+    }, [innerRef.current]);
+    var onMutation = useCallback(function (mutations) {
+        var dom = (targetSelector
+            ? document.querySelector(targetSelector)
+            : mutations === null || mutations === void 0 ? void 0 : mutations[0].target);
+        updateEllipsisActivation(dom);
+        if ((dom === null || dom === void 0 ? void 0 : dom.textContent) &&
+            typeof dom.textContent === 'string' &&
+            (!defaultTooltip || (defaultTooltip === null || defaultTooltip === void 0 ? void 0 : defaultTooltip.content) == null)) {
+            setInnerText(dom.textContent);
+        }
+    }, [targetSelector]);
+    var onResize = useCallback(function (entries) {
+        var dom = (targetSelector
+            ? document.querySelector(targetSelector)
+            : entries === null || entries === void 0 ? void 0 : entries[0].target);
+        updateEllipsisActivation(dom);
+        if ((dom === null || dom === void 0 ? void 0 : dom.textContent) &&
+            typeof dom.textContent === 'string' &&
+            (!defaultTooltip || !(defaultTooltip === null || defaultTooltip === void 0 ? void 0 : defaultTooltip.content) == null)) {
+            setInnerText(dom.textContent);
+        }
+    }, [targetSelector]);
+    /** 监听目标元素的DOM变化 */
+    useEffect(function () {
+        var element = innerRef.current instanceof React__default.Component
+            ? findDOMNode(innerRef.current)
+            : innerRef.current;
+        if (element) {
+            var observer_1 = new MutationObserver(onMutation);
+            observer_1.observe(element, {
+                childList: true,
+                subtree: true,
+                characterDataOldValue: true,
+                characterData: true
+            });
+            return function () { return observer_1.disconnect(); };
+        }
+        return;
+    }, [innerRef.current]);
+    /** 监听目标元素的尺寸变化 */
+    useEffect(function () {
+        var element = innerRef.current instanceof React__default.Component
+            ? findDOMNode(innerRef.current)
+            : innerRef.current;
+        if (element) {
+            var observer_2 = new ResizeObserver(onResize);
+            observer_2.observe(element);
+            return function () { return observer_2.disconnect(); };
+        }
+        return;
+    }, [innerRef.current]);
+    var WrapComponent = inline !== false ? 'span' : 'div';
+    var showTooltip = ellipsisAvtived && normalizedTooltip;
+    var Body = React__default.isValidElement(children) ? (React__default.cloneElement(children, { ref: innerRef })) : (React__default.createElement(WrapComponent, { ref: innerRef, className: cx('OverflowTpl', className, {
+            'OverflowTpl--with-tooltip': showTooltip
+        }) }, children));
+    return showTooltip ? (React__default.createElement(TooltipWrapper, __assign({}, omit(props, ['className', 'inline', 'targetSelector', 'children']), { tooltip: normalizedTooltip }), Body)) : (Body);
+};
+OverflowTpl.defaultProps = {
+    inline: true
+};
+var OverflowTpl$1 = themeable(OverflowTpl);
+
+export { OverflowTpl$1 as default };