Skip to content

Commit 821159a

Browse files
author
binaryify
committed
improve docs
1 parent 5aeb942 commit 821159a

File tree

11 files changed

+369
-30
lines changed

11 files changed

+369
-30
lines changed

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2018-2022 Binaryify
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md‎

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
1-
# vue-perfect-scrollbar
2-
3-
## Project setup
4-
```
5-
yarn install
6-
```
7-
8-
### Compiles and hot-reloads for development
9-
```
10-
yarn run serve
11-
```
12-
13-
### Compiles and minifies for production
14-
```
15-
yarn run build
16-
```
1+
# vue-custom-scrollbar
2+
3+
Minimalistic but perfect custom scrollbar component for Vue.JS(using [utatti/perfect-scrollbar](https://github.com/utatti/perfect-scrollbar))
4+
5+
## Why custom scrollbar
6+
7+
As you know, Chrome support custom scrollbar, but Firefox don't support it, if you want your website perfect, please use this component~
8+
9+
## Why vue-custom-scrollbar?
10+
11+
vue-custom-scrollbar is minimalistic but perfect scrollbar component for Vue.JS.
12+
13+
- No change on design layout
14+
- No manipulation on DOM tree
15+
- Use plain `scrollTop` and `scrollLeft`
16+
- Scrollbar style is fully customizable
17+
- Efficient update on layout change
18+
19+
## Docs
20+
21+
[Docs](https://binaryify.github.io/vue-custom-scrollbar/)
22+
23+
## License
24+
25+
[MIT](https://github.com/Binaryify/vue-custom-scrollbar/blob/master/LICENSE)

‎docs/.vuepress/components/demo-1.vue‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
<script>
1010
import vueCustomScrollbar from '../../../src/vue-scrollbar.vue'
11-
console.log(vueCustomScrollbar)
1211
export default {
1312
components: {
1413
vueCustomScrollbar

‎docs/.vuepress/dist/404.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<meta name="description" content="">
88

99

10-
<link rel="preload" href="/vue-custom-scrollbar/assets/css/0.styles.b075adcd.css" as="style"><link rel="preload" href="/vue-custom-scrollbar/assets/js/app.6a7694e2.js" as="script"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/2.da42264c.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/3.7b364f08.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/4.5aac8fbe.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/5.8e20654a.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/6.75c9d241.js">
10+
<link rel="preload" href="/vue-custom-scrollbar/assets/css/0.styles.b075adcd.css" as="style"><link rel="preload" href="/vue-custom-scrollbar/assets/js/app.3a68f57d.js" as="script"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/2.da42264c.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/3.7b364f08.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/4.134216c8.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/5.f7209ce5.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/6.75c9d241.js">
1111
<link rel="stylesheet" href="/vue-custom-scrollbar/assets/css/0.styles.b075adcd.css">
1212
</head>
1313
<body>
1414
<div id="app" data-server-rendered="true"><div class="theme-container"><div class="content"><h1>404</h1> <blockquote>That's a Four-Oh-Four.</blockquote> <a href="/vue-custom-scrollbar/" class="router-link-active">Take me home.</a></div></div></div>
15-
<script src="/vue-custom-scrollbar/assets/js/app.6a7694e2.js" defer></script>
15+
<script src="/vue-custom-scrollbar/assets/js/app.3a68f57d.js" defer></script>
1616
</body>
1717
</html>

‎docs/.vuepress/dist/assets/js/4.5aac8fbe.js‎ renamed to ‎docs/.vuepress/dist/assets/js/4.134216c8.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/.vuepress/dist/assets/js/5.8e20654a.js‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/.vuepress/dist/assets/js/5.f7209ce5.js‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/.vuepress/dist/assets/js/app.6a7694e2.js‎ renamed to ‎docs/.vuepress/dist/assets/js/app.3a68f57d.js‎

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)