@douyinfe/semi-ui/lib/es/typography/title.d.ts

A modern, comprehensive, flexible design system and UI library. Connect DesignOps & DevOps. Quickly build beautiful React apps. Maintained by Douyin-fe team.

import React, { PureComponent } from 'react';
import PropTypes from 'prop-types';
import { strings } from '@douyinfe/semi-foundation/lib/es/typography/constants';
import { Ellipsis, TypographyBaseType, OmitTypographyProps } from './interface';
import { ArrayElement } from '@douyinfe/semi-foundation/lib/es/utils/type';
type OmitTitleProps = OmitTypographyProps;
export interface CopyableConfig {
    content?: string;
    copyTip?: React.ReactNode;
    successTip?: React.ReactNode;
    icon?: React.ReactNode;
    onCopy?(e: React.MouseEvent, content: string, res: boolean): void;
}
export type LinkType = React.AnchorHTMLAttributes<HTMLAnchorElement> | boolean;
export interface TitleProps extends Omit<React.HTMLAttributes<HTMLHeadingElement>, OmitTitleProps> {
    className?: string;
    component?: React.ElementType;
    copyable?: CopyableConfig | boolean;
    delete?: boolean;
    disabled?: boolean;
    /**
     * ellipsis 用于设置截断相关参数.
     * Ellipsis is used to set ellipsis related parameters.
     * ellipsis 仅支持纯文本的截断，不支持 reactNode 等复杂类型，请确保 children 传入内容类型为 string.
     * Ellipsis only supports ellipsis of plain text, and does not support complex types such as reactNode.
     * Please ensure that the content type of children is string.
     * Semi 截断有两种策略， CSS 截断和 JS 截断。
     * Semi ellipsis has two strategies, CSS ellipsis and JS ellipsis.
     *  - 当设置中间截断（pos='middle')、可展开（expandable)、有后缀（suffix 非空）、可复制（copyable），启用 JS 截断策略
     *  - When setting middle ellipsis (pos='middle')、expandable、suffix is not empty string、copyable,
     * the JS ellipsis strategy is enabled
     *  - 非以上场景，启用 CSS 截断策略
     *  - Otherwise, enable the CSS ellipsis strategy
     *
     * 通常来说 CSS 截断的性能优于 JS 截断。在 children 不变， 容器尺寸不变的情况下，CSS 截断只涉及 1-2 次计算，js 截断基于二分法，可能涉及多次计算。
     * In general CSS ellipsis performs better than JS ellipsis. when the children and container size remain unchanged,
     * CSS ellipsis only involves 1-2 calculations, while JS ellipsis is based on dichotomy and may require multiple calculations.
     * 同时使用大量带有截断功能的 Typography 需注意性能消耗，如在 Table 中，可通过设置合理的页容量进行分页减少性能损耗
     * Pay attention to performance consumption when using a large number of Typography with ellipsis. For example, in Table,
     * you can reduce performance loss by setting a reasonable pageSize for paging
     */
    ellipsis?: Ellipsis | boolean;
    heading?: ArrayElement<typeof strings.HEADING>;
    link?: LinkType;
    mark?: boolean;
    strong?: boolean;
    style?: React.CSSProperties;
    type?: TypographyBaseType;
    underline?: boolean;
    weight?: ArrayElement<typeof strings.WEIGHT> | number;
}
export default class Title extends PureComponent<TitleProps> {
    static propTypes: {
        copyable: PropTypes.Requireable<NonNullable<boolean | object>>;
        delete: PropTypes.Requireable<boolean>;
        disabled: PropTypes.Requireable<boolean>;
        ellipsis: PropTypes.Requireable<NonNullable<boolean | object>>;
        mark: PropTypes.Requireable<boolean>;
        link: PropTypes.Requireable<NonNullable<boolean | object>>;
        underline: PropTypes.Requireable<boolean>;
        strong: PropTypes.Requireable<boolean>;
        type: PropTypes.Requireable<"warning" | "success" | "primary" | "secondary" | "danger" | "tertiary" | "quaternary">;
        heading: PropTypes.Requireable<1 | 2 | 3 | 4 | 5 | 6>;
        style: PropTypes.Requireable<object>;
        className: PropTypes.Requireable<string>;
        component: PropTypes.Requireable<string>;
        weight: PropTypes.Requireable<NonNullable<number | "default" | "bold" | "medium" | "light" | "regular" | "semibold">>;
    };
    static defaultProps: {
        copyable: boolean;
        delete: boolean;
        disabled: boolean;
        ellipsis: boolean;
        mark: boolean;
        underline: boolean;
        strong: boolean;
        link: boolean;
        type: string;
        heading: number;
        style: {};
        className: string;
    };
    render(): React.JSX.Element;
}
export {};