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
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
12
12
> "Click to scroll" **component** using the modern Browser API.
13
13
14
-
## π₯ Features
14
+
## :fire: Features
15
15
16
16
- Just **one tiny file**
17
17
- Component based (great for **async loading** and code splitting)
@@ -21,10 +21,10 @@
21
21
- Vue as the only dependency
22
22
- Highly customizable
23
23
24
-
## π Getting started
24
+
## :mag_right: Getting started
25
25
26
26
27
-
### π¦οΈ Through NPM
27
+
### :package: Through NPM
28
28
29
29
```
30
30
$ npm install vue-next-level-scroll
@@ -58,11 +58,11 @@ export default {
58
58
59
59
```
60
60
61
-
### πβ Using a CDN
61
+
### :link::x: Using a CDN
62
62
63
63
Sorry! You can't use *VueNextLevelScroll* with a CDN by now.
64
64
65
-
## π Usage
65
+
## :hammer_and_wrench: Usage
66
66
67
67
### You might like to go for a Polyfill
68
68
@@ -84,8 +84,8 @@ better suited for universal/SSR code and can be loaded asynchronously as well!
84
84
85
85
| Prop | Optional? | Comment |
86
86
|---| --- | --- |
87
-
| target |β | Can be any query selector you want (or a function that returns such). Will be passed to the scroll function |
88
-
| scrollFunction |β | You can define an own scroll function that will take the `target` prop as parameter and can do whatever you like. |
87
+
| target |:white_check_mark:| Can be any query selector you want (or a function that returns such). Will be passed to the scroll function |
88
+
| scrollFunction |:white_check_mark:| You can define an own scroll function that will take the `target` prop as parameter and can do whatever you like. |
89
89
90
90
91
91
### Default scroll function explained
@@ -153,11 +153,11 @@ export default {
153
153
154
154
You might not need the polyfill then as well :wink:
155
155
156
-
## π οΈ Contributing
156
+
## :gear: Contributing
157
157
158
158
Please see our [CONTRIBUTING.md](./CONTRIBUTING.md)
159
159
160
160
161
-
## π License
161
+
## :bookmark_tabs: License
162
162
163
163
[MIT License](./LICENSE.md) - Copyright (c) Developmint - Alexander Lichter
0 commit comments