ScrollSnapshot
interface exported by @mwillbanks/tuil-scroll.
interface
Public interface exported by @mwillbanks/tuil-scroll.
export interface ScrollSnapshot {
readonly id: string;
readonly position: ScrollPosition;
readonly viewport: ScrollViewport;
readonly extent: ScrollExtent;
readonly atTop: boolean;
readonly atBottom: boolean;
readonly atLeft: boolean;
readonly atRight: boolean;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | Yes | The id member uses the string contract. | — |
position | ScrollPosition | Yes | The position member uses the ScrollPosition contract. | ScrollPosition |
viewport | ScrollViewport | Yes | The viewport member uses the ScrollViewport contract. | ScrollViewport |
extent | ScrollExtent | Yes | The extent member uses the ScrollExtent contract. | ScrollExtent |
atTop | boolean | Yes | The atTop member uses the boolean contract. | — |
atBottom | boolean | Yes | The atBottom member uses the boolean contract. | — |
atLeft | boolean | Yes | The atLeft member uses the boolean contract. | — |
atRight | boolean | Yes | The atRight member uses the boolean 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.
Related types
Source
View the secondary source reference