README
@pnx-mixtape/elevator
Documentation and examples: Elevator
Installation
npm install @pnx-mixtape/elevator --save
How to use
CSS
- PostCSS workflow:
@import '@pnx-mixtape/elevator';
- Sass/Eyeglass:
@import 'mixtape-elevator';
- Native CSS:
@import url('dist/elevator.css');
- Link tag:
<link href="dist/elevator.css" rel="stylesheet" type="text/css">
Vanilla JS
- ES6 import:
import Elevator from '@pnx-mixtape/elevator';
- Script tag:
<script src="dist/elevator.js" type="text/javascript"></script>
HTML
<nav class="elevator js-elevator nav nav--jump">
<h4>Jump to Section</h4>
<ul></ul>
</nav>
<div class="page__sections">
<h2 id="section">Section title</h2>
</div>