ScrollHandle — Kuito Documentation

Usage

Scroll after adding content

tsx

import { Button, For, ref, Scroll, signal, Text, VStack } from 'kuito';
import type { ScrollHandle } from 'kuito';

function Chat() {
  const messages = signal<string[]>([]);
  const thread = ref<ScrollHandle>();

  function send() {
    messages.value = [...messages.value, 'Message ' + (messages.value.length + 1)];
    thread.current?.scrollToEnd();
  }

  return (
    <VStack flex={1} gap={8}>
      <Scroll ref={thread} flex={1}>
        <For each={messages}>{(message) => <Text>{message}</Text>}</For>
      </Scroll>
      <Button onPress={send}>Send</Button>
    </VStack>
  );
}

Type declaration

export interface ScrollHandle extends ElementHandle {
  /**
   * Scrolls to `offset` points along the view's axis, or to `page`, a whole
   * view length each from 0, as `paging` rests; animated by default.
   */
  scrollTo(
    params: { offset: number; animated?: boolean } | { page: number; animated?: boolean },
  ): void;
  /** Scrolls to the end of the content, including what the same update added. */
  scrollToEnd(params?: { animated?: boolean }): void;
}

Members 11

Name	Type	Required	Description
`scrollTo`	`(params: { offset: number; animated?: boolean;} \| { page: number; animated?: boolean;}) => void`	Yes	Scrolls to `offset` points along the view's axis, or to `page`, a whole view length each from 0, as `paging` rests; animated by default.
`scrollToEnd`	`(params?: { animated?: boolean;}) => void`	Yes	Scrolls to the end of the content, including what the same update added.
`id`readonly	`string`	Yes	—
`parent`readonly	`ElementHandle`	Yes	—
`children`readonly	`ElementHandle[]`	Yes	—
`focus`	`() => void`	Yes	—
`blur`	`() => void`	Yes	—
`setProperty`	`<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] \| null) => void`	Yes	Sets a native prop on the view now, until its binding writes it again.
`addEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}) => void`	Yes	—
`removeEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean;}) => void`	Yes	—
`dispatchEvent`	`(event: { type: string; bubbles?: boolean; cancelable?: boolean;}) => boolean`	Yes	Sends an event through the tree, capture to bubble, as a native one travels: a `KuitoCustomEvent`, or any object with a `type`. False when a listener called `preventDefault()` on a cancelable event.

scrollTo — method signatures

Signatures

(params: { offset: number; animated?: boolean; } | { page: number; animated?: boolean; }): void

Parameters

Name	Type	Required	Description
`params`	`{ offset: number; animated?: boolean;} \| { page: number; animated?: boolean;}`	Yes	—

Returns

void

scrollToEnd — method signatures

Signatures

(params?: { animated?: boolean; }): void

Parameters

Name	Type	Required	Description
`params`	`{ animated?: boolean;}`	No	—

Returns

void

focus — method signatures

Signatures

(): void

Parameters

No parameters.

Returns

void

blur — method signatures

Signatures

(): void

Parameters

No parameters.

Returns

void

setProperty — method signatures

Signatures

<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] | null): void

Type parameters

Name	Constraint	Default
`K`	`keyof ElementProperties`	—

Parameters

Name	Type	Required	Description
`key`	`K`	Yes	—
`value`	`ElementProperties[K]`	Yes	—

Returns

void

addEventListener — method signatures

Signatures

(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; once?: boolean; signal?: AbortSignal; }): void

Parameters

Name	Type	Required	Description
`type`	`string`	Yes	—
`fn`	`(e: KuitoNativeEvent) => void`	Yes	—
`options`	`boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}`	No	—

Returns

void

removeEventListener — method signatures

Signatures

(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; }): void

Parameters

Name	Type	Required	Description
`type`	`string`	Yes	—
`fn`	`(e: KuitoNativeEvent) => void`	Yes	—
`options`	`boolean \| { capture?: boolean;}`	No	—

Returns

void

dispatchEvent — method signatures

Signatures

(event: { type: string; bubbles?: boolean; cancelable?: boolean; }): boolean

Parameters

Name	Type	Required	Description
`event`	`{ type: string; bubbles?: boolean; cancelable?: boolean;}`	Yes	—

Returns

boolean

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.