Skip to content

Commit ab22598

Browse files
author
binaryify
committed
improve docs
1 parent cdcd01e commit ab22598

File tree

7 files changed

+41
-27
lines changed

7 files changed

+41
-27
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
11
# vue-custom-scrollbar
22

3-
Minimalistic but perfect custom scrollbar component for Vue.JS(using [utatti/perfect-scrollbar](https://github.com/utatti/perfect-scrollbar))
3+
Vue.JS 的简约但完美的自定义滚动条组件(使用了 [utatti/perfect-scrollbar](https://github.com/utatti/perfect-scrollbar),所以如果遇到某些问题,可以查看 `perfect-scrollbar` 仓库)
44

5-
## Why custom scrollbar
5+
Minimalistic but perfect custom scrollbar component for Vue.JS(using [utatti/perfect-scrollbar](https://github.com/utatti/perfect-scrollbar), so if you have any question, you also can check the `perfect-scrollbar` repo)
66

7-
As you know, Chrome support custom scrollbar, but Firefox don't support it, if you want your website perfect, please use this component~
7+
## 为什么要自定义滚动条/Why custom scrollbar
88

9-
## Why vue-custom-scrollbar?
9+
众所周知,谷歌浏览器支持自定义滚动条,但是火狐或其他浏览器不支持,如果你希望你的网站更完美,就用这个组件吧~
1010

11-
vue-custom-scrollbar is minimalistic but perfect scrollbar component for Vue.JS.
11+
As you know, Chrome support custom scrollbar, but Firefox or other browsers don't support it, if you want your website perfect, please use this component~
1212

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
13+
## 为什么要使用 vue-custom-scrollbar?/Why use vue-custom-scrollbar?
1814

19-
## Docs
15+
`vue-custom-scrollbar` 是 Vue.JS 的一个简约但完美的自定义滚动条组件
16+
17+
`vue-custom-scrollbar` is minimalistic but perfect scrollbar component for Vue.JS.
18+
19+
- 不改变设计布局 / No change on design layout
20+
- 不需要手动操作 DOM / Don't need manipulate DOM manually
21+
- 使用普通的 `scrollTop` and `scrollLeft` / Use plain `scrollTop` and `scrollLeft`
22+
- 滚动条样式可完全自定义 / Scrollbar style is fully customizable
23+
- 布局更改后更新 / Efficient update on layout change
24+
25+
## 文档/Docs
2026

2127
[Docs](https://binaryify.github.io/vue-custom-scrollbar/)
2228

docs/.vuepress/dist/404.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<meta name="description" content="Vue.JS 的迷你但完美的自定义滚动条组件">
88

99

10-
<link rel="preload" href="/vue-custom-scrollbar/assets/css/0.styles.2e1de20b.css" as="style"><link rel="preload" href="/vue-custom-scrollbar/assets/js/app.bb026c28.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.c5c5aee4.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/5.8bc6869b.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/6.b8a737be.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/7.9f00cfd5.js">
10+
<link rel="preload" href="/vue-custom-scrollbar/assets/css/0.styles.2e1de20b.css" as="style"><link rel="preload" href="/vue-custom-scrollbar/assets/js/app.422d5545.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.c5c5aee4.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/5.8bc6869b.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/6.b8a737be.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/7.9f00cfd5.js">
1111
<link rel="stylesheet" href="/vue-custom-scrollbar/assets/css/0.styles.2e1de20b.css">
1212
</head>
1313
<body>
14-
<div id="app" data-server-rendered="true"><div class="theme-container"><div class="content"><h1>404</h1> <blockquote>How did we get here?</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.bb026c28.js" defer></script>
14+
<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.422d5545.js" defer></script>
1616
</body>
1717
</html>

docs/.vuepress/dist/assets/js/app.bb026c28.js renamed to docs/.vuepress/dist/assets/js/app.422d5545.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/en/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<meta name="description" content="Minimalistic but perfect custom scrollbar component for Vue.JS">
88

99

10-
<link rel="preload" href="/vue-custom-scrollbar/assets/css/0.styles.2e1de20b.css" as="style"><link rel="preload" href="/vue-custom-scrollbar/assets/js/app.bb026c28.js" as="script"><link rel="preload" href="/vue-custom-scrollbar/assets/js/6.b8a737be.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.c5c5aee4.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/5.8bc6869b.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/7.9f00cfd5.js">
10+
<link rel="preload" href="/vue-custom-scrollbar/assets/css/0.styles.2e1de20b.css" as="style"><link rel="preload" href="/vue-custom-scrollbar/assets/js/app.422d5545.js" as="script"><link rel="preload" href="/vue-custom-scrollbar/assets/js/6.b8a737be.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.c5c5aee4.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/5.8bc6869b.js"><link rel="prefetch" href="/vue-custom-scrollbar/assets/js/7.9f00cfd5.js">
1111
<link rel="stylesheet" href="/vue-custom-scrollbar/assets/css/0.styles.2e1de20b.css">
1212
</head>
1313
<body>
@@ -76,6 +76,6 @@
7676
<a href="https://github.com/utatti/perfect-scrollbar/wiki/Caveats" target="_blank" rel="noopener noreferrer">Caveats<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> too.</p> <p>IE&lt;11 is not supported, and patches to fix problems in IE&lt;=10 will not be
7777
accepted. When old IEs should be supported, please fork the project and make
7878
modification locally.</p> <h2 id="more"><a href="#more" aria-hidden="true" class="header-anchor">#</a> More</h2> <p>Please refer to <a href="https://github.com/utatti/perfect-scrollbar" target="_blank" rel="noopener noreferrer">perfect-scrollbar<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p> <h2 id="license"><a href="#license" aria-hidden="true" class="header-anchor">#</a> License</h2> <p><a href="https://github.com/Binaryify/vue-custom-scrollbar/blob/master/LICENSE" target="_blank" rel="noopener noreferrer">MIT<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></p></div> <div class="page-edit"><!----> <!----></div> <!----> </div> <!----></div></div>
79-
<script src="/vue-custom-scrollbar/assets/js/6.b8a737be.js" defer></script><script src="/vue-custom-scrollbar/assets/js/app.bb026c28.js" defer></script>
79+
<script src="/vue-custom-scrollbar/assets/js/6.b8a737be.js" defer></script><script src="/vue-custom-scrollbar/assets/js/app.422d5545.js" defer></script>
8080
</body>
8181
</html>

0 commit comments

Comments
 (0)