VScroll

12 Sep 20253 minutes to read

VScroll module is introduces vertical scroller when content exceeds the current viewing area.
It can be useful for the components like Toolbar, Tab which needs vertical scrolling alone.
Hidden content can be view by touch moving or icon click.

<div id="scroll"/>
<script>
  var scrollObj = new VScroll();
  scrollObj.appendTo("#scroll");
</script>

Properties

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl boolean

Enable or disable rendering component in right to left direction.

Defaults to false

locale string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ’’

scrollStep number

Specifies the up or down scrolling distance of the vertical scrollbar moving.

Defaults to null

Methods

addEventListener

Adds the handler to the given event listener.

Parameter Type Description
eventName string A String that specifies the name of the event
handler Function Specifies the call to run when the event occurs.

Returns void

appendTo

Appends the control within the given HTML element

Parameter Type Description
selector (optional) string | HTMLElement Target element where control needs to be appended

Returns void

attachUnloadEvent

Adding unload event to persist data when enable persistence true

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

Removes the control from the DOM and also removes all its related events.

Returns void

detachUnloadEvent

Removing unload event to persist data when enable persistence true

Returns void

disable

Specifies the value to disable/enable the VScroll component.
When set to true , the component will be disabled.

Parameter Type Description
value boolean Based on this Boolean value, VScroll will be enabled (false) or disabled (true).

Returns void

getLocalData

Returns the persistence data for component

Returns any

getRootElement

Returns the route element of the component

Returns HTMLElement

handleUnload

Handling unload event to persist data when enable persistence true

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Parameter Type Description
eventName string A String that specifies the name of the event to remove
handler Function Specifies the function to remove

Returns void

Inject

Dynamically injects the required modules to the component.

Parameter Type Description
moduleList Function[] ?

Returns void