. . .
UserWay logo
javascript

UserWay API

To start working with the UserWay JS API, first add the UserWay script to your site: https://userway.org/get

What do these documents describe?

These documents describe the workings of the special functionality of the UserWay widget to use its functions from the browser console or from an external script on the site.

Our API provides the ability to open or close the widget menu, as well as to enable or disable any of its functions.

This may be necessary if you want to automate the call of any functions of the UserWay widget on your site.

To use the UserWay API, you need to have our widget installed on the site.

The following are the methods that you can use to work with our UserWay API:

Common

Common methods are not directly related to the operation of the UserWay widget.

getVersion

UserWay.getVersion();

Get UserWay API version.

Widget methods

Methods with which you can close or open the widget menu on the site, as well as a method by which you can reset the use of all functions of the widget.

widgetToggle

UserWay.widgetToggle();

Open or close widget menu.

widgetOpen

UserWay.widgetToggle();

Open widget menu.

widgetClose

UserWay.widgetClose();

Close widget menu.

resetAll

UserWay.resetAll();

Reset all widget features.

Keyboard navigation

Methods with which you can control the keyboard navigation function in the UserWay widget.

keyboardNavToggle

UserWay.keyboardNavToggle();

Enable or disable keyboard navigation.

keyboardNavEnable

UserWay.keyboardNavEnable();

Enable keyboard navigation.

keyboardNavDisable

UserWay.keyboardNavDisable();

Disable keyboard navigation.

Big Cursor

The methods by which you can control of a big cursor in the UserWay widget.

bigCursorToggle

UserWay.bigCursorToggle();

Enable or disable big cursor.

bigCursorEnable

UserWay.bigCursorEnable();

Enable big cursor.

bigCursorDisable

UserWay.bigCursorDisable();

Disable big cursor.

Contrast feature

The methods by which you can control the contrast in the UserWay widget.

contrastToggle

UserWay.contrastToggle();

Enable or disable contrast feature.

contrastEnable

UserWay.contrastEnable(stage);

contrastDisable

UserWay.contrastDisable();

Disable contrast feature.

Big text

Methods with which you can control the functionality of large text in the UserWay widget.

bigTextToggle

UserWay.bigTextToggle();

Enable or disable big text feature.

bigTextToggle

UserWay.bigTextEnable(stage);

bigTextToggle

UserWay.bigTextDisable();

Disable big text feature.

Desaturate feature

Methods with which you can manage "desaturate" function in the UserWay widget.

desaturateToggle

UserWay.desaturateToggle();

Enable or disable desaturate feature.

desaturateEnable

UserWay.desaturateEnable();

Enable desaturate feature.

desaturateDisable

UserWay.desaturateDisable();

Disable desaturate feature.

Highlight feature

The methods by which you can control the function of highlighting links in the UserWay widget.

highlightToggle

UserWay.highlightToggle();

Enable or disable highlight feature.

highlightEnable

UserWay.highlightEnable();

Enable highlight feature.

highlightDisable

UserWay.highlightDisable();

Disable highlight feature.

Legible fonts

The methods by which you can control the font enhancement feature in the UserWay widget.

legibleFontsToggle

UserWay.legibleFontsToggle();

Enable or disable legible fonts feature.

legibleFontsEnable

UserWay.legibleFontsEnable();

Enable legible fonts feature.

legibleFontsDisable

UserWay.legibleFontsDisable();

Disable legible fonts feature.

ReadPage

The methods by which you can control the text reading function in the UserWay widget.

readPageToggle

UserWay.readPageToggle();

Enable or disable read page feature.

readPageEnable

UserWay.readPageEnable();

Enable read page feature.

readPageDisable

UserWay.readPageDisable();

Disable read page feature.