ScrollAreaOptions

interface

Public interface exported by @mwillbanks/tuil-scroll.

export interface ScrollAreaOptions {
  readonly id: string;
  readonly viewport: ScrollViewport;
  readonly extent: ScrollExtent;
  readonly parentId?: string;
  readonly sticky?: Partial<
    Record<"top" | "bottom" | "left" | "right", boolean>
  >;
  readonly followFocus?: boolean;
}

Members

Member	Type	Required	Description	Related types
`id`	`string`	Yes	The `id` member uses the `string` contract.	—
`viewport`	`ScrollViewport`	Yes	The `viewport` member uses the `ScrollViewport` contract.	`ScrollViewport`
`extent`	`ScrollExtent`	Yes	The `extent` member uses the `ScrollExtent` contract.	`ScrollExtent`
`parentId`	`string \| undefined`	No	The `parentId` member uses the `string \| undefined` contract.	—
`sticky`	`Partial<Record<"top" \| "bottom" \| "left" \| "right", boolean>> \| undefined`	No	The `sticky` member uses the `Partial<Record<"top" \| "bottom" \| "left" \| "right", boolean>> \| undefined` contract.	—
`followFocus`	`boolean \| undefined`	No	The `followFocus` member uses the `boolean \| undefined` contract.	—

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-scroll

ScrollAreaOptions

On this page