ScrollBar Typescript API

Interface

ScrollBar

Scrollbar is a replacement of the default scroll bar with multiple UI Styling options.

Selector

smart-scroll-bar

Properties

animationAnimation

Sets or gets the animation mode. Animation is disabled when the property is set to 'none'

Default valueadvanced

disabledboolean

Enables or disables the element.

Default valuefalse

largeStepnumber

Sets or gets the scrollbar's largestep. The value is increased/decreased with this largestep when the user presses the left mouse button in the area between a scrollbar button and thumb.

Default value100

localestring

Sets or gets the language. Used in conjunction with the property messages.

Default value"en

localizeFormatFunctionany

Callback, related to localization module.

maxnumber

Sets or gets the scrollbar's maximum value.

Default value1000

mechanicalActionDragMechanicalAction

Sets or gets the type of used mechanical action. The mechanical action defines in which moment the value of the element will be updated.

Default valueswitchWhileDragging

messagesany

Sets an object with string values, related to the different states of passwords strength.

Default value


"en": {

"propertyUnknownType": "'{{name}}' property is with undefined 'type' member!",

"propertyInvalidValue": "Invalid '{{name}}' property value! Actual value: {{actualValue}}, Expected value: {{value}}!",

"propertyInvalidValueType": "Invalid '{{name}}' property value type! Actual type: {{actualType}}, Expected type: {{type}}!",

"elementNotInDOM": "Element does not exist in DOM! Please, add the element to the DOM, before invoking a method.",

"moduleUndefined": "Module is undefined.",

"missingReference": "{{elementType}}: Missing reference to {{files}}.",

"htmlTemplateNotSuported": "{{elementType}}: Browser doesn't support HTMLTemplate elements.",

"invalidTemplate": "{{elementType}}: '{{property}}' property accepts a string that must match the id of an HTMLTemplate element from the DOM."

}


minnumber

Sets or gets the scrollbar's minimum value.

Default value0

orientationOrientation

Sets or gets the scrollbar's orientation

Default valuehorizontal

readonlyboolean

If the element is readonly, users cannot interact with it.

Default valuefalse

showButtonsboolean

Sets or gets scrollbar buttons visibility.

Default valuetrue

stepnumber

Sets or gets the scrollbar's step. The value is increased/decreased with this step when the user presses a scrollbar button.

Default value10

themestring

Determines the theme. Theme defines the look of the element

Default value"

unfocusableboolean

If is set to true, the element cannot be focused.

Default valuefalse

valuenumber

Sets or gets the widget's value.

Default value0

onchange((this: Window, ev: Event) => any) | null

This event is triggered when the value is changed.

Arguments

evEvent

Methods

refresh(): void

Redraws the element.



Enums

Animation

None Simple Advanced

DragMechanicalAction

SwitchUntilReleased SwitchWhenReleased SwitchWhileDragging

Orientation

Horizontal Vertical