Class

Help

Help(props)

Overview

The Help section of RuLeStudio. Contains a formatted copy of manual. The navigation drawer listens to scroll changes and highlights corresponding chapter titles. Chapter titles in scrollable container are used as a reference to their positions.
Constructor

# new Help(props)

Parameters:
Name Type Description
props Object
selected string

The id of selected chapter.

upperMargin number | string

The top-margin of the navigation drawer.

View Source Body/Help/Help.js, line 53

Methods

# static onScroll()

Callback fired when user scrolls to certain position. Function counts and updates the position of the scroll using chapter positions.

View Source Body/Help/Help.js, line 117

# static scrollTo(id)

Callback fired when user clicked on an element from navigation drawer. Function updates scroll position using the offsetTop and offsetHeight attributes of a chapter.

Parameters:
Name Type Description
id number

The numerical part of the chapter id.

View Source Body/Help/Help.js, line 143

# static updatePositions()

Updates the margin-right of the scrollable container. Then, sets timeout for 1 second with a callback to update the positions of chapter titles.

View Source Body/Help/Help.js, line 89