Welcome. MemoryBeach usesCookiesto improve visitors experience on the beach.

Widget Info

How The Widget Works

 

Common

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

getVersion

UserWay.getVersion();

Get UserWay API version.

iconVisibilityOn

UserWay.iconVisibilityOn();

Show UserWay accessibility menu icon.

iconVisibilityOff

UserWay.iconVisibilityOff();

Hide UserWay accessibility menu icon.

iconVisibilityToggle

UserWay.iconVisibilityToggle();

Toggle UserWay accessibility icon's visibility.

 

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.widgetOpen();

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.

 

Reading Guide

The methods by which you can control of a reading guide in the UserWay widget.

readingGuideToggle

UserWay.readingGuideToggle();

Enable or disable reading guide.

readingGuideEnable

UserWay.readingGuideEnable();

Enable reading guide.

readingGuideDisable

UserWay.readingGuideDisable();

Disable reading guide.

 

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);
  • Enable contrast feature.
  • Can take an integer value from 1 to 3, which indicates the stage of the feature you want to use.
  • If you do not pass an integer value, it will work as Toggle.

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.

bigTextEnable

UserWay.bigTextEnable(stage);
  • Enable big text feature.
  • Can take an integer value from 1 to 4, which indicates the stage of the feature you want to use.
  • If you do not pass an integer value, it will work as Toggle.

bigTextDisable

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.

 

Events

UserWay events are fired at specific points of components' life progress. Each event includes UserWay instance in payload.

userway:init_completed

/* Hide UserWay accessibility icon on init */ document.addEventListener("userway:init_completed", function(event) { var instance = event.detail.userWayInstance; instance.iconVisibilityOff(); }); /* Open UserWay accessibility menu on init */ /* https://codepen.io/userway/pen/QYRGqx */ document.addEventListener("userway:init_completed", function(event) { var instance = event.detail.userWayInstance; instance.widgetOpen(); });

Event is fired at the moment all UserWay components have been initialized.

userway:render_completed

/* Edit UserWay accessibility icon's element */ /* https://codepen.io/userway/pen/YBmPZO */ document.addEventListener("userway:render_completed", function(event) { var userway = document.querySelector('div.userway'); if (userway) { userway.setAttribute('title', 'The text you prefer to have as a tip'); } });

Event is fired at the moment all UserWay DOM components have been rendered.