tuil
ReferencePackages@mwillbanks/tuil-scrollAPI

scrollbar

function exported by @mwillbanks/tuil-scroll.

View rawEdit

function

Public function exported by @mwillbanks/tuil-scroll.

export function scrollbar(
  viewportSize: number,
  extentSize: number,
  offset: number,
): { readonly start: number; readonly size: number };

Members

This declaration has no public members.

Parameters

MemberTypeRequiredDescriptionRelated types
viewportSizenumberYesSupplies the viewportSize value as number.
extentSizenumberYesSupplies the extentSize value as number.
offsetnumberYesSupplies the offset value as number.

Returns

{ readonly start: number; readonly size: number } — Returns a value that satisfies { readonly start: number; readonly size: number }.

Related types: —

Throws

No thrown errors are documented for this declaration.

No package-local related types.

Source

View the secondary source reference

Package

@mwillbanks/tuil-scroll

On this page