Marked.API

Namespace: docProgress

Marked. docProgress

DEPRECATED Display of document progress indicator

Properties:
Name Type Description
bar object

DOM element for progress bar
Source:
docprogress.js

Requires

Methods

init()

DEPRECATED Generate the progress bar DOM element and bind scroll event

Deprecated:
  • Yes
Source:
docprogress.js

start(updateConfig)

DEPRECATED Bind scroll event to update handler

Parameters:
Name Type Description
updateConfig boolean

Flag to update config object
Deprecated:
  • Yes
Source:
docprogress.js

stop(updateConfig)

DEPRECATED Unbind scroll event from update handler

Parameters:
Name Type Description
updateConfig boolean

Flag to update config object
Deprecated:
  • Yes
Source:
docprogress.js

update()

Deprecated:
  • DEPRECATED Update the document progress indicator
Source:
docprogress.js