skipto

by paypal

paypal / skipto

SkipTo is a replacement for your old classic "Skipnav" link. Once installed on a site, the script dy...

128 Stars 41 Forks Last release: Not found BSD 3-Clause "New" or "Revised" License 233 Commits 2 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

PayPal accessibility logo

[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 of SkipTo

  • 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.

Example Screen Shot

How it works

  1. The SkipTo menu button is the first tabable element on the page, and if it is not visible becomes the first time the user tabs into the page.
  2. Once the keyboard focus is on the menu button, pressing the ENTER or the SPACEBAR key will pull down the list of high-level headings and on the current page.
  3. Use arrow keys to select your choice and press ENTER to skip to it.
  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.

How do I get it on my web site?

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.

To use the SkipTo script, just include it at the bottom of your HTML page or template, as follows:


NOTE: Make sure that "src" points to the place where you put the SkipTo Javascript file, otherwise, things will not work as intended.

What About WordPress

A module is being considered for WordPress.

Configuring SkipTo

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

Options for adding the button

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

displayOption
|
static
| Values of
static
or
popup
are defined. The value
static
the button is visible, when
popup
is used the button is initially not visible, but becomes visible when it receives focus. | |
accessKey
|
0
| Accesskey provides a way to open the Skip To menu from anywhere on the page, the default is the number zero. | |
attachElement
|
header
| A CSS selector for identifying which element to attach the menu button container. | |
containerElement
|
div
| Element to use as a container for the button and the menu. |
customClass
|
skipTo
| CSS class added to the container element. Can be used for customize styling of the button and menu with author supplied stylesheet. | |
containerRole
| none | Optional landmark role added to a container element, if the container element is not within a landmark. Ideally the menu button is placed within the
banner
landmark (e.g.
header
element. |

CSS Selectors for identifying Landmarks and Headings

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

landmarks
|
main, [role="main"], [role="search"], nav, [role="navigation"], aside, [role="complementary"]
| A set of CSS selectors used by
querySelectorAll
to get an array of landmark nodes. | |
headings
|
main h1, [role="main"] h1, main h2, [role="main"] h2
| A set of CSS selectors used by
querySelectorAll
to get an array of headings nodes. |

Button and Menu labeling

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

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

buttonLabel
| 'Skip to Content' | Change the label for the button. | |
menuLabel
| Landmarks and Headings' | Change the label for the menu. | |
landmarkGroupLabel
| 'Landmarks' | Change the menu group label for landmarks. | |
headingGroupLabel
| 'Main Headings' | Change the menu group label for headings. | |
mainLabel
| 'main' | The label in the menu for
main
lanamarks | |
searchLabel
| 'search' | The label in the menu for
search
landmarks | |
navLabel
| 'menu' | The label in the menu for
navigation
landmarks | |
asideLabel
| 'aside' | The label in the menu for
complementary
landmarks | |
footerLabel
| 'footer' | The label in the menu for
contentinfo
landmarks | |
headerLabel
| 'header' | The label in the menu for
banner
landmarks | |
formLabel
| 'form' | The label in the menu for
form
landmdrks | |
msgNoLandmarksFound
| 'No landmarks to skip to'| Message for when no landmarks are found. | |
msgNoHeadingsFound
| 'No main headings to skip to'| Message for when no headings are found. |

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 | | :------------- | :----- | :------ | :---------- | |

colorTheme
| string |
default
| A predefined color scheme for skipTo, currently values 'default' and 'illinois' | |
buttonColor
| Color |
#1a1a1a
| Color of text for "Skip To Content" button. | |
buttonBackgroundColor
| Color |
#eeeeee
| Background color of text for "Skip To Content" button. | |
buttonBorderColor
| Color |
#eeeeee
| Border color of text for "Skip To Content" button. | |
buttonColorFocus
| Color |
#000000
| Color of text for "Skip To Content" button when it has focus. | |
buttonFocusBackgroundColor
| Color |
#dcdcdc
| Background color of text for "Skip To Content" button when it has focus. | |
buttonFocusBorderColor
| Color |
#1a1a1a
| Border color of "Skip To Content" button when it has focus. | |
menuBackgroundColor
| Color |
#eeeeee
| Menu background color. | |
menuBorderColor
| Color |
1a1a1a
| Menu border color | |
menuitemColor
| Color |
#1a1a1a
| Menuitem text color. | |
menuitemBackgroundColor
| Color |
#eeeeee
| Menuitem text background color. | |
menuitemFocusColor
| Color |
#eeeeee
| Menuitem text color then it has focus. | |
menuitemFocusBackgroundColor
| Color |
#1a1a1a
| Menuitem text backgroundcolor then it has focus. | |
menuitemFocusBorderColor
| Color |
#1a1a1a
| Menuitem border color then it has focus. |

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

Position of Button

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

positionLeft
| length |
46%
| The position of the "Skip To Content" button from left margin. |

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:

    

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

sh
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!

PayPal Accessibility Team Twitter: @PayPalInclusive

Authors

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

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

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

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

Jon Gunderson https://github.com/jongund

Nicholas Hoyt https://github.com/nhoyt

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 -- CONTROL+ALT+0 (Windows) and CONTROL+OPTION+0 (Mac OS).
  • Safari -- CONTROL+0.

Version History

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 2019, PayPal under the BSD license.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.