Skip to content

ChatMessageListScrollApi

Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:568

Imperative scroll API exposed by ChatMessageList via scrollApiRef.

Use this when you need to drive scroll position from outside — e.g., “scroll to message X” triggered by a search panel, or a “jump to top” action button.

Properties

isAtBottom()

isAtBottom: () => boolean

Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:576

Whether the user is currently scrolled to the bottom.

Returns

boolean


scrollTo()

scrollTo: (options) => void

Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:572

Scroll the container to an arbitrary position.

Parameters

options

ScrollToOptions

Returns

void


scrollToBottom()

scrollToBottom: (behavior?) => void

Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:570

Scroll to the bottom of the message list.

Parameters

behavior?

ScrollBehavior

Returns

void


scrollToElement()

scrollToElement: (el, options?) => void

Defined in: src/components/editor/ChatPanel/ChatPanel.types.ts:574

Scroll a specific element into view inside the container.

Parameters

el

HTMLElement

options?

ScrollIntoViewOptions

Returns

void