Function Expandable

Expandable(__namedParameters: ExpandableProps): Element
Renders content as expanded/collapsed. When collapsed, content is partially hidden (controlled by the collapsedHeight property).

Use with Expandable.useExpandable to control the expanded and overflows state.
Parameters
- __namedParameters: ExpandableProps
Returns Element

Index

Methods

Methods

useExpandable

useExpandable(
    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;
}