Function TruncatedText

TruncatedText(__namedParameters: TruncatedTextProps): Element
Truncates text to a specific number of lines. For toggling functionality, se TruncatedText.useTruncatedText.
Parameters
- __namedParameters: TruncatedTextProps
Returns Element
Note
Children must have inline display to work properly with a single line. For example, FormattedText is not compatible with a single line (but is with multiple lines).

Note
Setting the overflows value does not work if the value of isExpanded is true initially (but it will update) if the value of isExpanded changes.

Index

Methods

useTruncatedText

Methods

useTruncatedText

useTruncatedText(
    initialIsExpanded?: TypeOrFunction<boolean>,
): {
    collapse: () => void;
    expand: () => void;
    isExpanded: boolean;
    overflows: boolean;
    setIsExpanded: Dispatch<SetStateAction<boolean>>;
    setOverflows: Dispatch<SetStateAction<boolean>>;
    toggleIsExpanded: () => void;
}
Wraps useToggle and renames return values for convenience.
Parameters
- OptionalinitialIsExpanded: TypeOrFunction<boolean>
Returns {
    collapse: () => void;
    expand: () => void;
    isExpanded: boolean;
    overflows: boolean;
    setIsExpanded: Dispatch<SetStateAction<boolean>>;
    setOverflows: Dispatch<SetStateAction<boolean>>;
    toggleIsExpanded: () => void;
}