Skip to content

afonsopacifer/skip-to-content

Repository files navigation

<skip-to-content>

<⬇️/> A Polymer element for Skip to Content.

demo

Live Demo

Check it live!

Install

Install the component using Bower:

$ bower install skip-to-content --save

Usage

  1. Import Web Components' polyfill:
<script src="bower_components/webcomponentsjs/webcomponents-lite.min.js"></script>
  1. Import Custom Element:
<link rel="import" href="bower_components/skip-to-content/skip-to-content.html">
  1. Start using it!
<skip-to-content skipTo="#main" color="#e00571"></skip-to-content>

Attributes

Attribute Type Default Description
skipTo String #main Destination ID.
color String #000 The background color.

Style

Style the element with CSS as you would a normal DOM element.

.skip-to-content {

}

Browser Support

Using the webcomponents.js

IE Chrome Firefox Opera Safari
11+ Latest ✔ Latest ✔ Latest ✔ Latest ✔

Development

  1. Install Bower & Polymer-CLI:
$ [sudo] npm install -g bower polymer-cli polyserve
  1. Install local dependencies:
$ bower install
  1. Start the development server on http://localhost:8080/:
$ polyserve
  1. Running tests
$ polymer test test/index.html -l chrome

View docs:
http://localhost:8080/components/skip-to-content/

View demo:
http://localhost:8080/components/skip-to-content/demo/

Versioning

To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.

Contributing

Find on our issues the next steps of the project ;)
Want to contribute? Follow these recommendations.

History

See Releases for detailed changelog.

License

MIT License © Afonso Pacifer