You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-12Lines changed: 24 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -11,21 +11,22 @@
11
11
The mobile first menu navigation for today's modern web, sourced with Typescript and packed with lots of features.
12
12
13
13
14
-
# Demo
14
+
##Demo
15
15
Download the package and check the **docs** folder, or check it online [here](http://thednp.github.io/navbar).
16
16
17
17
# Navbar Highlights
18
18
* Mobile First Design
19
19
* Accessibility Focus
20
20
* TypeScript sourced and powerful build tools
21
-
* SCSS sources with powerful mixins and CSS variables
21
+
* SCSS sources with flexible mixins and CSS variables
22
22
* very light footprint, `5kb` in size when minified
23
23
* 3 sets of positions top (main), left or right
24
24
* provides a set of options for JavaScript initialization
25
25
* DATA API allows you to automatically initiate without JS invocation
26
-
* modern browsers supported and semi-modern alike with a special polyfill for IE10+ provided
26
+
* modern browsers supported
27
27
28
-
# How It Works
28
+
29
+
## How It Works
29
30
**On mobile**
30
31
* uses the native events behavior, it requires some elements to click on
31
32
* shows the `<button class="navbar-toggle">` element for element visibility toggle
@@ -39,14 +40,25 @@ Download the package and check the **docs** folder, or check it online [here](ht
39
40
40
41
On both mobile and desktop, Navbar.js allows for full keyboard navigation via the **TAB** and **SPACE** keys. In addition, directional arrows provide navigation on desktop with RTL support.
41
42
42
-
# NPM
43
-
You can install this through NPM:
43
+
## Install
44
+
```bash
45
+
pnpm install -D @thednp/navbar
46
+
```
47
+
48
+
```bash
49
+
yarn add -D @thednp/navbar
50
+
```
44
51
52
+
```bash
53
+
npm install -D @thednp/navbar
45
54
```
46
-
$ npm install @thednp/navbar
55
+
56
+
```bash
57
+
deno add -D npm:@thednp/navbar@latest
47
58
```
48
59
49
-
# Browser Usage
60
+
61
+
## Browser Usage
50
62
Download the [latest package](https://github.com/thednp/navbar/archive/master.zip). unpack and inspect the contents. You need to copy the `navbar.js` and `navbar.css` or their minified variations to your app `assets` folders as follows.
51
63
Link the required CSS in your document `<head>` tag
52
64
```html
@@ -95,13 +107,13 @@ Alternatively you can use only the menu itself and use the specific attribute:
95
107
Other initialization and markup options apply, explained in [the demo](http://thednp.github.io/navbar/).
0 commit comments