[email protected]

by PayPal Accessibility Team & University of Illinois

See the Authors section for more information.

SkipTo is a replacement for your old classic "Skipnav" link, (so please use it as such)! The SkipTo script creates a drop-down menu consisting of the links to important landmarks and headings on a given web page. Once installed and configured, the menu makes it easier for keyboard and screen reader users to quickly jump to the desired location by simply choosing it from the list of options.

Benefits

• All users can get an outline of the content on the page.
• Screen reader users can get a higher level navigation menu without having to use the screen reader landmark and header navigation commands which typically include longer lists of lower level headings and less used landmarks.
• Keyboard only users can more efficiently navigate to content on a page.
• Speech recognition users can use the menu to more efficiently navigate to content on a page.

Access keys

Access keys work just like regular shortcut keys except that they need a browser-specific modifier key in order to work. For example, to use the "SkipTo" access key, you would press the modifier key + the access key (0 in this particular case). here is a quick list for how this would work in most popular browsers.

• Mozilla Firefox -- Alt+Shift+0.
• Google Chrome -- Alt+0 (Windows) and Control+Option+0 (Mac OS).
• Safari -- Control+Option+0.

Websites using SkipTo

• DRES Accessible IT Group
• College of Applied Health Sciences

How it works

1. The SkipTo menu button should be the first tabable element on the page, and if it is configured not to be visible when the page is loaded, the menu button becomes visible when it receives focus.
2. Once the keyboard focus is on the menu button, pressing the ENTER or the SPACEBAR key will pull down the list of important landmarks and headings on the page.
3. Use arrow keys to select your choice and press ENTER to move focus to the section of the page.
4. If you decide to reach the menu again, simply press the built-in access key (0 by default). See the notes on Access keys for More information on how to use them.

Adding to Website

All you need are either SkipTo.js or SkipTo.min.js from the "compiled/js" directory. Please note that SkipTo.min.js is a minified (a lighter version) of the script. If you would like to be able to debug your production-ready script, include the provided SkipTo.min.map file as well.

Local File on Your Web Server

Copy the

skipto.js

skipto.min.js

script

CDN Service

The easiest way is to include a reference to

skipto.min.js

NOTE: CDN referenced files may not available to computers behind firewall protected networks.

What About WordPress?

A module is under development for WordPress.

Configure Options

Setting properties is optional, when a property is not defined it's default value is used.

Options for adding the

button

element

The following options are useful for identify where the menu will be in the DOM structure of the page and which elements will be used as the container for the menu button. The options are of type

string

| Property | default | Description | | :------------- | :---------- | :---------- | |

displayOption

static

fixed

popup

static

fixed

popup

accessKey

attachElement

containerElement

customClass

containerRole

banner

header

Button Positioning

| Property | Type | Default | Description | | :------------- | :----- | :------ | :---------- | |

positionLeft

46%

CSS Selectors for identifying Landmarks and Headings

The

landmarks

The options are of type

string

| Property | Default | Description | | :------------- | :------ | :---------- | |

landmarks

querySelectorAll

headings

querySelectorAll

Color Theme Options

A color theme sets all the color options defined by the theme. There is only one theme at this time.

| Property | Type | Default | Description | | :------------- | :----- | :------ | :---------- | |

colorTheme

default

Colors used for Button and Menu styling

Color values must use CSS color values, for example

#8AF

rgb(40, 50, 90)

#a0bf32

blue

| Property | Type | Default | Description | | :------------- | :----- | :------ | :---------- | |

buttonTextColor

#1a1a1a

buttonBackgroundColor

#eeeeee

focusBorderColor

#1a1a1a

menuTextColor

#1a1a1a

menuBackgroundColor

#dcdcdc

menuitemFocusTextColor

#eeeeee

menuitemFocusBackgroundColor

#1a1a1a

NOTE: Make sure colors meet the color contrast requirements of WCAG 2.1 for text

Heading Shortcuts and Action Menu Options

The inclusion of heading level shortcut keys and the more landmarks and more headings action buttons are enabled by default, but they can be disabled through configuration. The values are of type boolean.

| Property | Default | Description | | :------------- | :------ |:---------- | |

enableActions

enableHeadingLevelShortcuts

Internationalization (I18N)

The text labels and messages can be updated through configuration to local language requirements.

Button Labeling

The labels and messages can be localized for specific languages or updated to reflect custom selectors.

| Property | Default | Description | | :------------- | :------ |:---------- | |

buttonLabel

buttonTitle

buttonTitleWithAccesskey

accesskeyNotSupported

Menu, Group and Menuitem Labeling

The labels and messages can be localized for specific languages or updated to reflect custom selectors.

| Property | Default | Description | | :------------- | :------ |:---------- | |

menuLabel

landmarkGroupLabel

headingGroupLabel

mofnGroupLabel

headingLevelLabel

aria-label

mainLabel

main

searchLabel

search

navLabel

navigation

asideLabel

complementary

footerLabel

contentinfo

headerLabel

banner

formLabel

form

msgNoLandmarksFound

msgNoHeadingsFound

Action labeling

The labels and messages can be localized for specific languages or updated to reflect custom selectors.

| Property | Default | Description | | :------------- | :------ |:---------- | |

menuLabel

landmarkImportantGroupLabel

actionGroupLabel

actionShowHeadingsHelp

actionShowImportantHeadingsLabel

actionShowAllHeadingsLabel

actionShowLandmarksHelp

actionShowImportantLandmarksLabel

actionShowAllLandmarksLabel

actionShowImportantHeadingsAriaLabel

aria-label

actionShowAllHeadingsAriaLabel

aria-label

actionShowImportantLandmarksAriaLabel

aria-label

actionShowAllLandmarksAriaLabel

aria-label

Example Settings

If have different requirements for your web site and include other heading levels as well as ARIA landmarks, you will need to provide a JSON object containing the necessary configuration parameters. The following is a sample configuration:

HTML, Classes and Ids for custom styling

The source code in this section is for developers to understand the HTML, classes and ids used in the SkipTo menu button and menu for use in custom styling.

  
  
    Skip To Content
  
  
  

    
    

      Important Landmarks
    
    

      

        Main
      
      

        Navigation: SkipTo test pages
      
      
    
    

<!--
//
// Heading group label and menu items
//
-->
<div id="id-skip-to-group-headings-label" role="separator">
  Important Headings
</div>
<div role="group" aria-labelledby="id-skip-to-group-headings-label" id="id-skip-to-group-headings">
  <div role="menuitem" class="heading skip-to-h1" data-id="9" data-level="1">
    <span class="level"><span>1</span>)</span>
    <span class="label">Example Content</span>
  </div>
  <div role="menuitem" class="heading skip-to-h2" data-id="10" data-level="2">
    <span class="level"><span>2</span>)</span>
    <span class="label">Pastrami</span>
  </div>
  <!--
  ... more menu items ...
  -->
</div>
<!-- End Headings Group -->

<!--
//
// Action group label and menu items
//
-->
<div role="separator" id="id-skip-to-group-actions-label">
  Actions
</div>
<div role="group" aria-labelledby="id-skip-to-group-actions-label" id="id-skip-to-group-actions">
  <div role="menuitem" class="action" data-id="skip-to-more-headings" data-show-heading-option="all">
    <span class="label skip-to-action">Show All headings (15)</span>
  </div>
  <div role="menuitem" class="action last" data-id="skip-to-more-landmarks" data-show-landmark-option="all">
    <span class="label skip-to-action">Show All landmarks (10)</span>
  </div>
</div>
<!-- End Action Group -->
  

Notes

• Parameters are optional.
• SkipTo can be attached to any element on the page (see the "attachElement" parameter). if no "attachElement" is found, the script will be attached as the first element after body.
• When the custom class is specified (see the customClass parameter), the user can override the style:

.skipTo.MyCustomClass {
  background:  red;
  left: 50px;
  top: 50px;
}

Compiling CSS and JavaScript

You may feel slightly adventurous and decide to change some colors or even enhance the script with your changes. Once you do this, here is how you compile the skipTo script for production.

git clone https://github.com/paypal/skipto.git
cd skipto
sudo npm install grunt-cli -g
npm install
grunt

1. You should now have a directory called

   compiled

   with the necessary files in it.
2. See instructions above on which files you need to get the SkipTo script running on your web site.

Note: On Windows, build-win.bat runs npm install and grunt modules (Step 3). To successfully run, you must launch a Windows command prompt as an Admin (Ctrl+Shift+Enter) and then run build-win.bat from this command prompt.

Cleaning up

If you would like to revert your local code repository to its initial state, simply run

grunt clean

from the root directory of your repository.

Of course, we want feedback

Please do not hesitate to raise issues and comment on Github if something doesn't work or you have ideas on how to improve the script.

Happy skipping!

Authors

Current Contributors

Jon Gunderson https://github.com/jongund

Nicholas Hoyt https://github.com/nhoyt

Prem Nawaz Khan https://github.com/mpnkhan || @mpnkhan

Previous Contributors

Victor Tsaran https://github.com/vick08 || @vick08

Ron Feathers https://github.com/rfeathers || @ronfeathers

Marc Kocher https://github.com/mdkocher || @marckocher

Version History

Version 4.0.3

• Fixed bug in using role description as a class name for menuitem
• Fixed bug in setting

  menuTextColor

  property.
• Updated documentation.

Version 4.0.2

• Changed landmarks from using the tag name in the class list to custom skip-to prefixed tag name.
• Fixed bug when no landmarks or headings found.
• Simplified color configuration options.

Version 3.1.4

• Fixed Joomla configuration option.
• Added m of n to landmark and heading group labels.

Version 3.1.3

• Added "fixed" to the

  displayOptions

  customization.

Version 3.1.2

• Fixed bug in moving focus for landmarks.

Version 3.1.1

• Changed "Important" to "Selected" landmarks and headings.

Version 3.1

• Added

  aria-label

  for action menu items to make the label screen reader friendly
• For heading menuitems, use

  aria-label

  to make the label more like a screen reader
• Use element names as landmark labels instead of landmark names
• Support

  aria-roledescription

  for labeling landmark roles in menu
• Nested landmarks and header levels are indented
• Added actions to toggle between "Important" and "All" landmarks and headings.
• Added additional keyboard shortcuts in the menu based on heading level.
• Added more information about accesskey in help.
• Fixed bugs in 3.0

Version 3.0

• Removed id selector options, if ids are needed they could be added to the landmarks selector
• Removed need to call initialization function
• Removed support for Internet Explorer
• Improved code readability and ARIA support, by removing complexity needed to support Internet Explorer
• Improved configuration of button and menu labeling
• Add configuration of button and menu colors, without adding a stylesheet
• Update the landmarks and headings in the menu by querying the DOM every time the menu is opened
• Reduced markup conflicts by using a data attribute rather than an IDREF for targets
• Reduced changes in page markup by only applying tabindex=-1 when focus is moved to a target
• Updated the function for testing if an element is visible

Version 2.1

• Ignore hidden landmarks and headings, based on:
  • CSS: display: none
  • CSS: visibility: hidden
  • HTML5 hidden attribute
  • ARIA 1.0 aria-hidden=true attribute
  • ARIA 1.0 role=presentation attribute
  • any element that is less than 4 pixels high or wide

Version 2.0

• Support for HTML5 section elements
• Calculate accessible names for landmarks and headings
• Updated menu to separate headings from landmarks
• Created default for main content
  • main element
  • [role=Main]
• Created default for HTML5 sections
  • nav element
• Updated defaults for landmarks
  • [role=navigation]
  • [role=search]
• Updated defaults for headings
  • h1 element
  • h2 element

Copyright and license

Copyright 2021, PayPal and University of Illinois under the BSD license.