1<!doctype html> 2<html lang="en-US"> 3 <head> 4 <meta charset="utf-8"> 5 <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0"> 7 <title> Learn about UserWay's JavaScript API in these Reference Docs </title> 8 <meta name="description" content="Add scripts to your site to use the UserWay API, so you can open or close the widget menu and control the accessibility widgetâs features and capabilities."> 9 <link href="/docs/stylesheets/screen.css" rel="stylesheet" type="text/css" media="screen" /> 10 <link href="/docs/stylesheets/print.css" rel="stylesheet" type="text/css" media="print" /> 11 <link href="/docs/stylesheets/highlight-monokai.css" rel="stylesheet" type="text/css" media="screen, print" /> 12
12<script src="/docs/javascripts/all.js" type="text/javascript"></script>
12 13 <link rel="canonical" href="https://userway.org/docs/"> 14 <meta name="image" content="https://userway.org/open-graph/docs/og.docs.jpg" /> 15 <meta name="twitter:card" content="summary" /> 16 <meta name="twitter:title" content="Learn about UserWay's JavaScript API in these Reference Docs" /> 17 <meta name="twitter:url" content="https://userway.org/docs/" /> 18 <meta name="twitter:description" content="Add scripts to your site to use the UserWay API, so you can open or close the widget menu and control the accessibility widgetâs features and capabilities." /> 19 <meta name="twitter:image" content="https://userway.org/open-graph/docs/og.docs.jpg" /> 20 <meta name="twitter:creator" content="@userwayorg" /> 21 <meta property="og:image:width" content="1200" /> 22 <meta property="og:image:height" content="630" /> 23 <meta property="og:title" content="Learn about UserWay's JavaScript API in these Reference Docs" /> 24 <meta property="og:description" content="Add scripts to your site to use the UserWay API, so you can open or close the widget menu and control the accessibility widgetâs features and capabilities." /> 25 <meta property="og:image" content="https://userway.org/open-graph/docs/og.docs.jpg" /> 26 <meta property="og:url" content="https://userway.org/docs/" /> 27 <meta property="og:type" content="website" /> 28 <meta property="og:image:type" content="jpg" /> 29 <!-- Google Tag Manager --> 30
30<script>
vendor: 497 bytes, lines 30-45
30 31 (function(w, d, s, l, i) 32 { 33 w[l] = w[l] || []; 34 w[l].push( 35 { 36 'gtm.start': new Date().getTime(), 37 event: 'gtm.js' 38 }); 39 var f = d.getElementsByTagName(s)[0], 40 j = d.createElement(s), 41 dl = l != 'dataLayer' ? '&l=' + l : ''; 42 j.async = true; 43 j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl; 44 f.parentNode.insertBefore(j, f); 45 })(window, document, 'script', 'dataLayer', '
45GTM-WMW6857
vendor: 8 bytes, lines 45-46
45'); 46
46</script>
46 47 <!-- End Google Tag Manager --> 48 </head> 49 <body class="" data-languages="["javascript"]"> 50 <!-- Google Tag Manager (noscript) -->
vendor: 72 bytes, lines 50-51
50 51 <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=
51GTM-WMW6857
vendor: 87 bytes, lines 51-52
51" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> 52
52<!-- End Google Tag Manager (noscript) --> 53 <a href="#" id="nav-button"> 54 <span> . . . </span> 55 </a> 56 <div class="tocify-wrapper"> 57 <div class="logo-cont"> 58 <a href="https://userway.org"> 59 <img alt="UserWay logo" class="logo-img" src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iMTUwcHgiIGhlaWdodD0iMjhweCIgdmlld0JveD0iMCAwIDE1MCAyOCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIj4KICAgIDx0aXRsZT5sb2dvPC90aXRsZT4KICAgIDxkZWZzPgogICAgICAgIDxsaW5lYXJHcmFkaWVudCB4MT0iNi4yNjMzOTkxMyUiIHkxPSIxMC4wNjQzMDA3JSIgeDI9IjcyLjc1MTAyOTYlIiB5Mj0iMTAwLjk5MTI5OSUiIGlkPSJsaW5lYXJHcmFkaWVudC0xIj4KICAgICAgICAgICAgPHN0b3Agc3RvcC1jb2xvcj0iIzI1QzVGRiIgb2Zmc2V0PSIwJSI+PC9zdG9wPgogICAgICAgICAgICA8c3RvcCBzdG9wLWNvbG9yPSIjMDA0OEZGIiBvZmZzZXQ9IjQ0Ljc0MDkwMDElIj48L3N0b3A+CiAgICAgICAgICAgIDxzdG9wIHN0b3AtY29sb3I9IiNDNTAwRjMiIG9mZnNldD0iMTAwJSI+PC9zdG9wPgogICAgICAgIDwvbGluZWFyR3JhZGllbnQ+CiAgICAgICAgPHBvbHlnb24gaWQ9InBhdGgtMiIgcG9pbnRzPSIwLjg5IDAuMTUgMTUuMDk0IDAuMTUgMTUuMDk0IDE1LjUxOCAwLjg5IDE1LjUxOCI+PC9wb2x5Z29uPgogICAgPC9kZWZzPgogICAgPGcgaWQ9IlBhZ2UtMSIgc3Ryb2tlPSJub25lIiBzdHJva2Utd2lkdGg9IjEiIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCI+CiAgICAgICAgPGcgaWQ9ImxvZ28iIHRyYW5zZm9ybT0idHJhbnNsYXRlKDAuMDAwMDAwLCAyLjAwMDAwMCkiPgogICAgICAgICAgICA8cGF0aCBkPSJNMTIuMDAwMTA2NywxOS43MzMzMzMzIEM3LjczNTYxMTI0LDE5LjczMzMzMzMgNC4yNjY4NDIwNywxNi4yNjQ1MzMzIDQuMjY2ODQyMDcsMTIgTDQuMjY2ODQyMDcsNS42IEM0LjI2Njg0MjA3LDMuOTgyOTMzMzMgMi45NTA1ODcxMSwyLjY2NjY2NjY3IDEuMzMzNTM0ODEsMi42NjY2NjY2NyBMMC4wMDAyMTMzMzE0MzYsMi42NjY2NjY2NyBMMC4wMDAyMTMzMzE0MzYsMCBMMS4zMzM1MzQ4MSwwIEM0LjQyMDQ0MDcxLDAgNi45MzM0ODUwNCwyLjUxMzA2NjY3IDYuOTMzNDg1MDQsNS42IEw2LjkzMzQ4NTA0LDEyIEM2LjkzMzQ4NTA0LDE0Ljc5NDY2NjcgOS4yMDU0NjQ4NCwxNy4wNjY2NjY3IDEyLjAwMDEwNjcsMTcuMDY2NjY2NyBDMTQuNzk0NzQ4NSwxNy4wNjY2NjY3IDE3LjA2NjcyODMsMTQuNzk0NjY2NyAxNy4wNjY3MjgzLDEyIEwxNy4wNjY3MjgzLDUuNiBDMTcuMDY2NzI4MywyLjUxMzA2NjY3IDE5LjU3OTc3MjYsMCAyMi42NjY2Nzg1LDAgTDI0LDAgTDI0LDIuNjY2NjY2NjcgTDIyLjY2NjY3ODUsMi42NjY2NjY2NyBDMjEuMDQ5NjI2MiwyLjY2NjY2NjY3IDE5LjczMzM3MTMsMy45ODI5MzMzMyAxOS43MzMzNzEzLDUuNiBMMTkuNzMzMzcxMywxMiBDMTkuNzMzMzcxMywxNi4yNjQ1MzMzIDE2LjI2NDYwMjEsMTkuNzMzMzMzMyAxMi4wMDAxMDY3LDE5LjczMzMzMzMgWiBNMjMuMDcxNzk0OSw0LjI2NjY2NjY3IEwyMy45OTk3ODY3LDQuMjY2NjY2NjcgTDIzLjk5OTc4NjcsNy40NDUzMzMzMyBMMjMuOTk5Nzg2NywxMiBDMjMuOTk5Nzg2NywxOC42MTc2IDE4LjYxNzQzNDUsMjQgMTEuOTk5ODkzMywyNCBDNS4zODIzNTIxNiwyNCAwLDE4LjYxNzYgMCwxMiBMMCw3LjQ0NTMzMzMzIEwwLDYuNzAwOCBMMCw0LjI2NjY2NjY3IEwwLjkyNzk5MTc1MSw0LjI2NjY2NjY3IEMxLjg5ODY0OTc5LDQuMjY2NjY2NjcgMi42ODM3MDk0OCw1LjA1MTczMzMzIDIuNjgzNzA5NDgsNi4wMjI0IEwyLjY4MzcwOTQ4LDcuNDQ1MzMzMzMgTDIuNjY2NjQyOTYsNy40NDUzMzMzMyBMMi42NjY2NDI5NiwxMiBDMi42NjY2NDI5NiwxNy4xNDc3MzMzIDYuODUyMjA1NzYsMjEuMzMzMzMzMyAxMS45OTk4OTMzLDIxLjMzMzMzMzMgQzE3LjE0NzU4MDksMjEuMzMzMzMzMyAyMS4zMzMxNDM3LDE3LjE0NzczMzMgMjEuMzMzMTQzNywxMiBMMjEuMzMzMTQzNyw3LjQ0NTMzMzMzIEwyMS4zMTYwNzcyLDcuNDQ1MzMzMzMgTDIxLjMxNjA3NzIsNi4wMjI0IEMyMS4zMTYwNzcyLDUuMDUxNzMzMzMgMjIuMTAxMTM2OSw0LjI2NjY2NjY3IDIzLjA3MTc5NDksNC4yNjY2NjY2NyBaIiBpZD0iQ29tYmluZWQtU2hhcGUiIGZpbGw9InVybCgjbGluZWFyR3JhZGllbnQtMSkiIGZpbGwtcnVsZT0ibm9uemVybyI+PC9wYXRoPgogICAgICAgICAgICA8cGF0aCBkPSJNMzQuNzA3LDEyLjE5NTQgTDM0LjcwNywzLjY0OTQgTDM5LjA0NywzLjY0OTQgTDM5LjA0NywxMS45NzE0IEMzOS4wNDcsMTMuOTM5NCA0MC4yNzcsMTUuMzQ5NCA0Mi4wMjEsMTUuMzQ5NCBDNDMuNzY3LDE1LjM0OTQgNDQuOTk3LDEzLjkzOTQgNDQuOTk3LDExLjk3MTQgTDQ0Ljk5NywzLjY0OTQgTDQ5LjMzNywzLjY0OTQgTDQ5LjMzNywxMi4xOTU0IEM0OS4zMzcsMTYuMzU1NCA0Ni4zMTcsMTkuMjg1NCA0Mi4wMjEsMTkuMjg1NCBDMzcuNzI3LDE5LjI4NTQgMzQuNzA3LDE2LjM1NTQgMzQuNzA3LDEyLjE5NTQiIGlkPSJGaWxsLTMiIGZpbGw9IiMyMzE0NDkiIGZpbGwtcnVsZT0ibm9uemVybyI+PC9wYXRoPgogICAgICAgICAgICA8cGF0aCBkPSJNNTAuNjk1NCwxNi42OTE0IEw1My4xMTE0LDEzLjgwNTQgQzU0LjY3NzQsMTUuMDM1NCA1Ni4zNzc0LDE1LjY4NTQgNTguMTg5NCwxNS42ODU0IEM1OS4zNzU0LDE1LjY4NTQgNjAuMDAxNCwxNS4yODE0IDYwLjAwMTQsMTQuNjA5NCBDNjAuMDAxNCwxMy44NzM0IDU5LjQ2NTQsMTMuNzYxNCA1Ny4zMzk0LDEzLjI2OTQgQzU0LjAwNTQsMTIuNTA3NCA1MS40MzM0LDExLjYzNTQgNTEuNDMzNCw4LjQzNzQgQzUxLjQzMzQsNS4zNzE0IDUzLjg0OTQsMy4zODE0IDU3LjQ5NTQsMy4zODE0IEM2MC4xNTc0LDMuMzgxNCA2Mi4yMzc0LDQuMDk3NCA2My45Mzk0LDUuNDYxNCBMNjEuNzY5NCw4LjUyNTQgQzYwLjMzNzQsNy40OTc0IDU4Ljc3MTQsNi45ODM0IDU3LjM4MzQsNi45ODM0IEM1Ni4zMzM0LDYuOTgzNCA1NS44MTk0LDcuNDA3NCA1NS44MTk0LDcuOTg5NCBDNTUuODE5NCw4Ljc3MzQgNTYuMzU1NCw5LjAxOTQgNTguNTQ3NCw5LjQ4NzQgQzYyLjEyNTQsMTAuMjQ5NCA2NC4zNjM0LDExLjIxMTQgNjQuMzYzNCwxNC4xNDE0IEM2NC4zNjM0LDE3LjM4NTQgNjEuODc5NCwxOS4yODU0IDU4LjAzMzQsMTkuMjg1NCBDNTUuMjU5NCwxOS4yODU0IDUyLjY0MTQsMTguNDEzNCA1MC42OTU0LDE2LjY5MTQiIGlkPSJGaWxsLTUiIGZpbGw9IiMyMzE0NDkiIGZpbGwtcnVsZT0ibm9uemVybyI+PC9wYXRoPgogICAgICAgICAgICA8cG9seWdvbiBpZD0iRmlsbC03IiBmaWxsPSIjMjMxNDQ5IiBmaWxsLXJ1bGU9Im5vbnplcm8iIHBvaW50cz0iNzAuNjQ0NiA3LjUxOTYgNzAuNjQ0NiA5LjI0MTYgNzcuOTYwNiA5LjI0MTYgNzcuOTYwNiAxMy4xMTE2IDcwLjY0NDYgMTMuMTExNiA3MC42NDQ2IDE1LjE0NzYgNzguNjc2NiAxNS4xNDc2IDc4LjY3NjYgMTkuMDE3NiA2Ni4zMDQ2IDE5LjAxNzYgNjYuMzA0NiAzLjY0OTYgNzguNjc2NiAzLjY0OTYgNzguNjc2NiA3LjUxOTYiPjwvcG9seWdvbj4KICAgICAgICAgICAgPHBhdGggZD0iTTg1LjIwMjIsMTAuNDUwMiBMODcuODY0MiwxMC40NTAyIEM4OC44OTQyLDEwLjQ1MDIgODkuNjMyMiw5Ljg0NjIgODkuNjMyMiw5LjAxODIgQzg5LjYzMjIsOC4xOTAyIDg4Ljg5NDIsNy41ODYyIDg3Ljg2NDIsNy41ODYyIEw4NS4yMDIyLDcuNTg2MiBMODUuMjAyMiwxMC40NTAyIFogTTg5Ljc4ODIsMTkuMDE4MiBMODYuNTQ0MiwxNC4zODYyIEw4NS4yMDIyLDE0LjM4NjIgTDg1LjIwMjIsMTkuMDE4MiBMODAuODYyMiwxOS4wMTgyIEw4MC44NjIyLDMuNjUwMiBMODguMjIyMiwzLjY1MDIgQzkxLjY2NjIsMy42NTAyIDk0LjEwNjIsNS44NjQyIDk0LjEwNjIsOS4wMTgyIEM5NC4xMDYyLDExLjIxMDIgOTIuOTQyMiwxMi45MzQyIDkxLjA2NDIsMTMuODA2MiBMOTQuNzMyMiwxOS4wMTgyIEw4OS43ODgyLDE5LjAxODIgWiIgaWQ9IkZpbGwtOSIgZmlsbD0iIzIzMTQ0OSIgZmlsbC1ydWxlPSJub256ZXJvIj48L3BhdGg+CiAgICAgICAgICAgIDxwb2x5Z29uIGlkPSJGaWxsLTExIiBmaWxsPSIjMjMxNDQ5IiBmaWxsLXJ1bGU9Im5vbnplcm8iIHBvaW50cz0iOTUuOTM1NiAzLjY0OTQgOTcuOTAzNiAzLjY0OTQgMTAyLjE1MzYgMTYuMDg3NCAxMDYuMjI1NiAzLjY0OTQgMTA4LjE3MTYgMy42NDk0IDExMi4yNDE2IDE2LjA4NzQgMTE2LjQ5MTYgMy42NDk0IDExOC40NjE2IDMuNjQ5NCAxMTMuMjAzNiAxOS4wMTc0IDExMS40ODE2IDE5LjAxNzQgMTA3LjIwOTYgNS45MzE0I
59DEwMi45MTM2IDE5LjAxNzQgMTAxLjE5MTYgMTkuMDE3NCI+PC9wb2x5Z29uPgogICAgICAgICAgICA8cGF0aCBkPSJNMTMwLjM5OTQsMTMuODczIEwxMjYuODQzNCw1Ljc5NyBMMTIzLjI2MzQsMTMuODczIEwxMzAuMzk5NCwxMy44NzMgWiBNMTMxLjExNTQsMTUuNTI5IEwxMjIuNTQ3NCwxNS41MjkgTDEyMS4wMDM0LDE5LjAxNyBMMTE5LjEwMzQsMTkuMDE3IEwxMjUuODgxNCwzLjY0OSBMMTI3Ljc4MTQsMy42NDkgTDEzMS4xMTU0LDExLjIwOSBMMTMxLjM1NzQsMTEuNzU3IEwxMzIuMjkxNCwxMy44NzMgTDEzMC4zOTk0LDEzLjg3MyBMMTMyLjI5MTQsMTMuODczIEwxMzQuNTU5NCwxOS4wMTcgTDEzMi42NTc0LDE5LjAxNyBMMTMxLjExNTQsMTUuNTI5IFoiIGlkPSJGaWxsLTEzIiBmaWxsPSIjMjMxNDQ5IiBmaWxsLXJ1bGU9Im5vbnplcm8iPjwvcGF0aD4KICAgICAgICAgICAgPGcgaWQ9Ikdyb3VwLTE3IiB0cmFuc2Zvcm09InRyYW5zbGF0ZSgxMzQuMDAwMDAwLCAzLjUwMDAwMCkiPgogICAgICAgICAgICAgICAgPGcgaWQ9IkZpbGwtMTUtQ2xpcHBlZCI+CiAgICAgICAgICAgICAgICAgICAgPG1hc2sgaWQ9Im1hc2stMyIgZmlsbD0id2hpdGUiPgogICAgICAgICAgICAgICAgICAgICAgICA8dXNlIHhsaW5rOmhyZWY9IiNwYXRoLTIiPjwvdXNlPgogICAgICAgICAgICAgICAgICAgIDwvbWFzaz4KICAgICAgICAgICAgICAgICAgICA8ZyBpZD0icGF0aC0yIj48L2c+CiAgICAgICAgICAgICAgICAgICAgPHBvbHlnb24gaWQ9IkZpbGwtMTUiIGZpbGw9IiMyMzE0NDkiIGZpbGwtcnVsZT0ibm9uemVybyIgbWFzaz0idXJsKCNtYXNrLTMpIiBwb2ludHM9IjcuMDg2IDkuMjU0IDAuODkgMC4xNSAzLjA2IDAuMTUgOC4wMDQgNy41OTggMTIuOTkyIDAuMTUgMTUuMDk0IDAuMTUgOC45MiA5LjI1NCA4LjkyIDE1LjUxOCA3LjA4NiAxNS41MTgiPjwvcG9seWdvbj4KICAgICAgICAgICAgICAgIDwvZz4KICAgICAgICAgICAgPC9nPgogICAgICAgIDwvZz4KICAgIDwvZz4KPC9zdmc+"> 60 </a> 61 </div> 62 <div class="lang-selector"> 63 <a href="#" data-language-name="javascript"> javascript </a> 64 </div> 65 <div class="search"> 66 <label for="input-search">Search</label> 67 <input type="text" class="search" id="input-search" placeholder="Search"> 68 </div> 69 <ul class="search-results"></ul> 70 <div id="toc"> 71 </div> 72 <ul class="toc-footer"> 73 <li><a href='https://github.com/tripit/slate'>Documentation Powered by Slate</a></li> 74 </ul> 75 </div> 76 <div class="page-wrapper"> 77 <div class="dark-box"></div> 78 <div class="content"> 79 <h1 id="userway-api">UserWay API</h1> 80 <p>To start working with the UserWay JS API, first add the UserWay script to your site: <a href="https://userway.org/get/">https://userway.org/get</a></p> 81 <p>What do these documents describe?</p> 82 <p>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.</p> 83 <p>Our API provides the ability to open or close the widget menu and control select features and capabilities of the accessibility widget.</p> 84 <p>This may be necessary if you want to automate the call of any functions of the UserWay widget on your site.</p> 85 <p>To use the UserWay API, you need to have our widget installed on the site.</p> 86 <p>The following are the methods that you can use to work with our UserWay API:</p> 87 <h2 id="common">Common</h2> 88 <p>Common methods are not directly related to the operation of the UserWay widget.</p> 89 <h3 id="getversion">getVersion</h3> 90 <pre class="highlight javascript"><code>UserWay.getVersion()</code></pre> 91 <p>Get UserWay API version.</p> 92 <h3 id="iconvisibilityon">iconVisibilityOn</h3> 93 <pre class="highlight javascript"><code>UserWay.iconVisibilityOn()</code></pre> 94 <p>Show UserWay accessibility menu icon.</p> 95 <h3 id="iconvisibilityoff">iconVisibilityOff</h3> 96 <pre class="highlight javascript"><code>UserWay.iconVisibilityOff()</code></pre> 97 <p>Hide UserWay accessibility menu icon.</p> 98 <h3 id="iconvisibilitytoggle">iconVisibilityToggle</h3> 99 <pre class="highlight javascript"><code>UserWay.iconVisibilityToggle()</code></pre> 100 <p>Toggle UserWay accessibility icon's visibility.</p> 101 <h2 id="widget-methods">Widget methods</h2> 102 <p>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.</p> 103 <h3 id="widgettoggle">widgetToggle</h3> 104 <pre class="highlight javascript"><code>UserWay.widgetToggle()</code></pre> 105 <p>Open or close widget menu.</p> 106 <h3 id="widgetopen">widgetOpen</h3> 107 <pre class="highlight javascript"><code>UserWay.widgetOpen()</code></pre> 108 <p>Open widget menu.</p> 109 <h3 id="widgetclose">widgetClose</h3> 110 <pre class="highlight javascript"><code>UserWay.widgetClose()</code></pre> 111 <p>Close widget menu.</p> 112 <h3 id="resetall">resetAll</h3> 113 <pre class="highlight javascript"><code>UserWay.resetAll()</code></pre> 114 <p>Reset all widget features.</p> 115 <h2 id="keyboard-navigation">Keyboard navigation</h2> 116 <p>Methods with which you can control the keyboard navigation function in the UserWay widget.</p> 117 <h3 id="keyboardnavtoggle">keyboardNavToggle</h3> 118 <pre class="highlight javascript"><code>UserWay.keyboardNavToggle()</code></pre> 119 <p>Enable or disable keyboard navigation.</p> 120 <h3 id="keyboardnavenable">keyboardNavEnable</h3> 121 <pre class="highlight javascript"><code>UserWay.keyboardNavEnable()</code></pre> 122 <p>Enable keyboard navigation.</p> 123 <h3 id="keyboardnavdisable">keyboardNavDisable</h3> 124 <pre class="highlight javascript"><code>UserWay.keyboardNavDisable()</code></pre> 125 <p>Disable keyboard navigation.</p> 126 <h2 id="big-cursor">Big Cursor</h2> 127 <p>The methods by which you can control of a big cursor in the UserWay widget.</p> 128 <h3 id="bigcursortoggle">bigCursorToggle</h3> 129 <pre class="highlight javascript"><code>UserWay.bigCursorToggle()</code></pre> 130 <p>Enable or disable big cursor.</p> 131 <h3 id="bigcursorenable">bigCursorEnable</h3> 132 <pre class="highlight javascript"><code>UserWay.bigCursorEnable()</code></pre> 133 <p>Enable big cursor.</p> 134 <h3 id="bigcursordisable">bigCursorDisable</h3> 135 <pre class="highlight javascript"><code>UserWay.bigCursorDisable()</code></pre> 136 <p>Disable big cursor.</p> 137 <h2 id="reading-guide">Reading Guide</h2> 138 <p>The methods by which you can control of a reading guide in the UserWay widget.</p> 139 <h3 id="readingguidetoggle">readingGuideToggle</h3> 140 <pre class="highlight javascript"><code>UserWay.readingGuideToggle()</code></pre> 141 <p>Enable or disable reading guide.</p> 142 <h3 id="readingguideenable">readingGuideEnable</h3> 143 <pre class="highlight javascript"><code>UserWay.readingGuideEnable()</code></pre> 144 <p>Enable reading guide.</p> 145 <h3 id="readingguidedisable">readingGuideDisable</h3> 146 <pre class="highlight javascript"><code>UserWay.readingGuideDisable()</code></pre> 147 <p>Disable reading guide.</p> 148 <h2 id="contrast-feature">Contrast feature</h2> 149 <p>The methods by which you can control the contrast in the UserWay widget.</p> 150 <h3 id="contrasttoggle">contrastToggle</h3> 151 <pre class="highlight javascript"><code>
151UserWay.contrastToggle()</code></pre> 152 <p>Enable or disable contrast feature.</p> 153 <h3 id="contrastenable">contrastEnable</h3> 154 <pre class="highlight javascript"><code>UserWay.contrastEnable(stage)</code></pre> 155 <ul> 156 <li>Enable contrast feature.</li> 157 <li>Can take an integer value from 1 to 4, which indicates the stage of the feature you want to use.</li> 158 <li>If you do not pass an integer value, it will work as a toggle.</li> 159 </ul> 160 <h3 id="contrastdisable">contrastDisable</h3> 161 <pre class="highlight javascript"><code>UserWay.contrastDisable()</code></pre> 162 <p>Disable contrast feature.</p> 163 <h2 id="big-text">Big text</h2> 164 <p>Methods with which you can control the functionality of large text in the UserWay widget.</p> 165 <h3 id="bigtexttoggle">bigTextToggle</h3> 166 <pre class="highlight javascript"><code>UserWay.bigTextToggle()</code></pre> 167 <p>Enable or disable big text feature.</p> 168 <h3 id="bigtextenable">bigTextEnable</h3> 169 <pre class="highlight javascript"><code>UserWay.bigTextEnable(stage)</code></pre> 170 <ul> 171 <li>Enable big text feature.</li> 172 <li>Can take an integer value from 1 to 4, which indicates the stage of the feature you want to use.</li> 173 <li>If you do not pass an integer value, it will work as Toggle.</li> 174 </ul> 175 <h3 id="bigtextdisable">bigTextDisable</h3> 176 <pre class="highlight javascript"><code>UserWay.bigTextDisable()</code></pre> 177 <p>Disable big text feature.</p> 178 <h2 id="highlight-feature">Highlight feature</h2> 179 <p>The methods by which you can control the function of highlighting links in the UserWay widget.</p> 180 <h3 id="highlighttoggle">highlightToggle</h3> 181 <pre class="highlight javascript"><code>UserWay.highlightToggle()</code></pre> 182 <p>Enable or disable highlight feature.</p> 183 <h3 id="highlightenable">highlightEnable</h3> 184 <pre class="highlight javascript"><code>UserWay.highlightEnable()</code></pre> 185 <p>Enable highlight feature.</p> 186 <h3 id="highlightdisable">highlightDisable</h3> 187 <pre class="highlight javascript"><code>UserWay.highlightDisable()</code></pre> 188 <p>Disable highlight feature.</p> 189 <h2 id="legible-fonts">Legible fonts</h2> 190 <p>The methods by which you can control the font enhancement feature in the UserWay widget.</p> 191 <h3 id="legiblefontstoggle">legibleFontsToggle</h3> 192 <pre class="highlight javascript"><code>UserWay.legibleFontsToggle()</code></pre> 193 <p>Enable or disable legible fonts feature.</p> 194 <h3 id="legiblefontsenable">legibleFontsEnable</h3> 195 <pre class="highlight javascript"><code>UserWay.legibleFontsEnable()</code></pre> 196 <p>Enable legible fonts feature.</p> 197 <h3 id="legiblefontsdisable">legibleFontsDisable</h3> 198 <pre class="highlight javascript"><code>UserWay.legibleFontsDisable()</code></pre> 199 <p>Disable legible fonts feature.</p> 200 <h2 id="text-spacing">Text spacing</h2> 201 <p>The methods by which you can control the text spacing feature in the UserWay widget.</p> 202 <h3 id="textspacingtoggle">textSpacingToggle</h3> 203 <pre class="highlight javascript"><code>UserWay.textSpacingToggle()</code></pre> 204 <p>Enable or disable text spacing feature.</p> 205 <h3 id="textspacingenable">textSpacingEnable</h3> 206 <pre class="highlight javascript"><code>UserWay.textSpacingEnable(stage)</code></pre> 207 <ul> 208 <li>Enable text spacing feature.</li> 209 <li>Can take an integer value from 1 to 3, which indicates the stage of the feature you want to use.</li> 210 <li>If you do not pass an integer value, it will work as Toggle.</li> 211 </ul> 212 <h3 id="textspacingdisable">textSpacingDisable</h3> 213 <pre class="highlight javascript"><code>UserWay.textSpacingDisable()</code></pre> 214 <p>Disable text spacing feature.</p> 215 <h2 id="readpage">ReadPage</h2> 216 <p>The methods by which you can control the text reading function in the UserWay widget.</p> 217 <h3 id="readpagetoggle">readPageToggle</h3> 218 <pre class="highlight javascript"><code>UserWay.readPageToggle()</code></pre> 219 <p>Enable, disable or change reading speed of the 'Read Page' feature.</p> 220 <h3 id="readpageenable">readPageEnable</h3> 221 <pre class="highlight javascript"><code>UserWay.readPageEnable()</code></pre> 222 <p>Enable read page feature.</p> 223 <h3 id="readpagedisable">readPageDisable</h3> 224 <pre class="highlight javascript"><code>UserWay.readPageDisable()</code></pre> 225 <p>Disable read page feature.</p> 226 <h2 id="pagestructure">PageStructure</h2> 227 <p>The methods by which you can control the page structure function in the UserWay widget.</p> 228 <h3 id="pagestructureheaders">pageStructureHeaders</h3> 229 <pre class="highlight javascript"><code>UserWay.pageStructureHeaders()</code></pre> 230 <p>Enable page structure view with predefined "headers" tab.</p> 231 <h3 id="pagestructurelandmarks">pageStructureLandmarks</h3> 232 <pre class="highlight javascript"><code>UserWay.pageStructureLandmarks()</code></pre> 233 <p>Enable page structure view with predefined "landmarks" tab.</p> 234 <h3 id="pagestructurelinks">pageStructureLinks</h3> 235 <pre class="highlight javascript"><code>UserWay.pageStructureLinks()</code></pre> 236 <p>Enable page structure view with predefined "links" tab.</p> 237 <h3 id="pagestructuredisable">pageStructureDisable</h3> 238 <pre class="highlight javascript"><code>UserWay.pageStructureDisable()</code></pre> 239 <p>Disable page structure function.</p> 240 <h2 id="tooltips">Tooltips</h2> 241 <p>The methods by which you can control the tooltips feature in the UserWay widget.</p> 242 <h3 id="tooltipstoggle">tooltipsToggle</h3> 243 <pre class="highlight javascript"><code>
243UserWay.tooltipsToggle()</code></pre> 244 <p>Enable or disable tooltips feature.</p> 245 <h3 id="tooltipsenable">tooltipsEnable</h3> 246 <pre class="highlight javascript"><code>UserWay.tooltipsEnable()</code></pre> 247 <p>Enable tooltips feature.</p> 248 <h3 id="tooltipsdisable">tooltipsDisable</h3> 249 <pre class="highlight javascript"><code>UserWay.tooltipsDisable()</code></pre> 250 <h2 id="stop-animations">Stop Animations</h2> 251 <p>The methods by which you can control the stop animations feature in the UserWay widget.</p> 252 <h3 id="stopanimationtoggle">stopAnimationToggle</h3> 253 <pre class="highlight javascript"><code>UserWay.stopAnimationToggle()</code></pre> 254 <p>Enable or disable stop animations feature.</p> 255 <h3 id="stopanimationenable">stopAnimationEnable</h3> 256 <pre class="highlight javascript"><code>UserWay.stopAnimationEnable()</code></pre> 257 <p>Enable stop animations feature.</p> 258 <h3 id="stopanimationdisable">stopAnimationDisable</h3> 259 <pre class="highlight javascript"><code>UserWay.stopAnimationDisable()</code></pre> 260 <p>Disable stop animations feature.</p> 261 <h2 id="quick-accessibility-menu">Quick Accessibility Menu</h2> 262 <h3 id="openquickaccessibilitymenu">openQuickAccessibilityMenu</h3> 263 <pre class="highlight javascript"><code>UserWay.openQuickAccessibilityMenu()</code></pre> 264 <p>Opens quick accessibility menu</p> 265 <h2 id="widget-settings">Widget Settings</h2> 266 <h3 id="changewidgetlanguage">changeWidgetLanguage</h3> 267 <pre class="highlight javascript"><code>
267UserWay.changeWidgetLanguage(languageCode) 268<span class="hljs-comment">/* Supported languages include: ar, bg, bn, cs, de, el, en, en-US, es, et, fa, fi, fo, fr, he, hi, hr, hu, it, ja, ko, lt, nl, no, pa, pl, pt, pt-BR, ro, ru, sl, sv, tr, uk, zh, zh-Hant */</span></code></pre> 269 <p>Updates widget language dynamically. No page refresh required.</p> 270 <h2 id="events">Events</h2> 271 <p>UserWay events are fired at specific points of components' life progress. Each event includes UserWay instance in payload.</p> 272 <h3 id="userway-init_completed">userway:init_completed</h3> 273 <pre class="highlight javascript"><code><span class="hljs-comment">/* Hide UserWay accessibility icon on init */</span> 274<span class="hljs-built_in">document</span>.addEventListener(<span class="hljs-string">'userway:init_completed'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">event</span>) </span>{ 275 <span class="hljs-keyword">var</span> instance = event.detail.userWayInstance 276 instance.iconVisibilityOff() 277}) 278 279<span class="hljs-comment">/* Open UserWay accessibility menu on init */</span> 280<span class="hljs-comment">/* https://codepen.io/userway/pen/QYRGqx */</span> 281<span class="hljs-built_in">document</span>.addEventListener(<span class="hljs-string">'userway:init_completed'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">event</span>
281) </span>{ 282 <span class="hljs-keyword">var</span> instance = event.detail.userWayInstance 283 instance.widgetOpen() 284}) 285 286<span class="hljs-comment">/* Change widget language on init */</span> 287<span class="hljs-built_in">document</span>.addEventListener(<span class="hljs-string">'userway:init_completed'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">event</span>) </span>{ 288 <span class="hljs-keyword">var</span> instance = event.detail.userWayInstance 289 instance.changeWidgetLanguage(<span class="hljs-string">'fr'</span>) 290})</code></pre> 291 <p>Event is fired at the moment all UserWay components have been initialized.</p> 292 <h3 id="userway-render_completed">userway:render_completed</h3> 293 <pre class="highlight javascript"><code><span class="hljs-comment">/* Edit UserWay accessibility icon's element */</span> 294<span class="hljs-comment">/* https://codepen.io/userway/pen/YBmPZO */</span> 295<span class="hljs-built_in">document</span>.addEventListener(<span class="hljs-string">'userway:render_completed'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">event</span>
295) </span>{ 296 <span class="hljs-keyword">var</span> userway = <span class="hljs-built_in">document</span>.querySelector(<span class="hljs-string">'div.userway'</span>) 297 <span class="hljs-keyword">if</span> (userway) { 298 userway.setAttribute(<span class="hljs-string">'title'</span>, <span class="hljs-string">'The text you prefer to have as a tip'</span>) 299 } 300})</code></pre> 301 <p>Event is fired at the moment all UserWay DOM components have been rendered.</p> 302 </div> 303 <div class="dark-box"> 304 <div class="lang-selector"> 305 <a href="#" data-language-name="javascript"> javascript </a> 306 </div> 307 </div> 308 </div> 309
309<script> 310 _userway_config = { 311 account: "1c9dnQkJMU", 312 async: true 313 }; 314 </script>
314 315
315<script type="text/javascript" src="https://cdn.userway.org/widget.js"></script>
315 316 </body> 317</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.