Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

An options object for initializing a widget. An options object for creating a scroll bar.

Hierarchy

  • IOptions

Index

Properties

Optional maximum

maximum: undefined | number

The maximum value for the scroll bar.

The default is 100.

Optional node

node: HTMLElement

The optional node to use for the widget.

If a node is provided, the widget will assume full ownership and control of the node, as if it had created the node itself.

The default is a new <div>.

Optional orientation

orientation: Orientation

The orientation of the scroll bar.

The default is 'vertical'.

Optional page

page: undefined | number

The page size for the scroll bar.

The default is 10.

Optional tag

tag: keyof HTMLElementTagNameMap

The optional element tag, used for constructing the widget's node.

If a pre-constructed node is provided via the node arg, this value is ignored.

Optional value

value: undefined | number

The value for the scroll bar.

The default is 0.

Generated using TypeDoc