@cavell/kit API
    Preparing search index...

    Variable useStickToBottomConst

    useStickToBottom: (
        mode?: AutoScrollMode,
    ) => {
        atBottom: boolean;
        contentRef: Dispatch;
        scrollRef: Dispatch;
        scrollToBottom: (options?: { behavior?: ScrollBehavior }) => void;
        unpin: () => void;
    }

    Keeps a scroll container pinned to its bottom while content grows; attach scrollRef to the overflow-y:auto element and contentRef to a child that grows with content.

    Type Declaration

      • (
            mode?: AutoScrollMode,
        ): {
            atBottom: boolean;
            contentRef: Dispatch;
            scrollRef: Dispatch;
            scrollToBottom: (options?: { behavior?: ScrollBehavior }) => void;
            unpin: () => void;
        }
      • Parameters

        Returns {
            atBottom: boolean;
            contentRef: Dispatch;
            scrollRef: Dispatch;
            scrollToBottom: (options?: { behavior?: ScrollBehavior }) => void;
            unpin: () => void;
        }