api
@zw/remarklet
Remarklet is a library for visually manipulating web page content.
Author: Zachary Kendall Watkins
License: Licensed under the MIT License. See LICENSE.txt in the project root or go to
https://github.com/ZachWatkins/Remarklet/blob/main/LICENSE.txt for
full license information.
Copyright: 2014-present Zachary Kendall Watkins. All rights reserved.
- @zw/remarklet
- remarklet() ⇒
void⏏- .version :
string - .config(options) ⇒
void .options(options) ⇒void- .restore() ⇒
void - .unstore() ⇒
void - .activate() ⇒
void - .deactivate() ⇒
void
- .version :
- remarklet() ⇒
remarklet() ⇒ void ⏏
Kind: Exported function
remarklet.version : string
Get the current version of the Remarklet library.
Kind: static property of remarklet
Read only: true
Since: 1.0.2
remarklet.config(options) ⇒ void
Configures the library's features.
Kind: static method of remarklet
Since: 1.3.0
| Param | Type | Description |
|---|---|---|
| options | Object | The configuration options. |
| options.persist | boolean | Whether to persist the state of the page between sessions. |
| options.hide | boolean | Whether to hide certain elements. |
remarklet.options(options) ⇒ void
voidDeprecated
Deprecated. An alias of remarklet.config. Will be removed in v2.0.0.
Kind: static method of remarklet
Since: 1.1.0
| Param | Type | Description |
|---|---|---|
| options | Object | The configuration options. |
| options.persist | boolean | Whether to persist the state of the page between sessions. |
| options.hide | boolean | Whether to hide certain elements. |
remarklet.restore() ⇒ void
Restores the persisted changes, if any. Runs before the interactive features are initialized.
Kind: static method of remarklet
Since: 1.2.0
remarklet.unstore() ⇒ void
Deletes all Remarklet data from localStorage.
Kind: static method of remarklet
Since: 1.3.0
remarklet.activate() ⇒ void
Activates the Remarklet library, initializing all necessary components.
Kind: static method of remarklet
Since: 1.0.0
remarklet.deactivate() ⇒ void
Deactivates the Remarklet library, cleaning up any resources or event listeners.
Kind: static method of remarklet
Since: 1.0.0