Skip to content

Commit 980163b

Browse files
author
Said Ibragimov
committed
Added deploy bages and updated doc
1 parent d937ec2 commit 980163b

File tree

2 files changed

+28
-7
lines changed

2 files changed

+28
-7
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Vue 3 and Nuxt 3 smooth scrollbar component
22

3-
Add your styled scrollbar to any block, which will look consistent across all platforms. To see how it works, plaese, see the demo.
3+
Add your styled scrollbar to any block, which will look consistent across all platforms. To see how it works, please, see the demo.
4+
5+
[![npm version](https://badge.fury.io/js/vue-smooth-scrollbar-ts.svg)](https://badge.fury.io/js/vue-smooth-scrollbar-ts)
6+
[![Github Package](https://github.com/siibragimov/vue-smooth-scrollbar-ts/actions/workflows/npm-publish-github-packages.yml/badge.svg)](https://github.com/siibragimov/vue-smooth-scrollbar-ts/actions/workflows/npm-publish-github-packages.yml)
7+
[![Node.js Package](https://github.com/siibragimov/vue-smooth-scrollbar-ts/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/siibragimov/vue-smooth-scrollbar-ts/actions/workflows/npm-publish.yml)
48

59
Based on [https://idiotwu.github.io/smooth-scrollbar/](https://idiotwu.github.io/smooth-scrollbar/).
610

@@ -11,7 +15,7 @@ There are two examples in the demo. One of them with custom styles.
1115
## Installation and setup
1216

1317
### 1. Install component:
14-
If you want to install package from __npmjs registry__ use:
18+
If you want to install package from __npmjs registry__(recommended) use:
1519
```shell
1620
npm i vue-smooth-scrollbar-ts
1721
```
@@ -29,7 +33,7 @@ If you want to install package from __GitHub packages__ use:
2933
```shell
3034
npm install @siibragimov/vue-smooth-scrollbar-ts
3135
```
32-
**Note**: Don't forget to configure registry. Use __.npmrc__ file or use command:
36+
**Note**: Don't forget to configure registry for installing packages from GitHub. Use __.npmrc__ file or use command:
3337
```shell
3438
npm config set registry https://npm.pkg.github.com/
3539
```
@@ -51,9 +55,15 @@ For Nuxt 3:
5155

5256
### 3. Define overriding styles for scrollbars if needed. See the [`App.vue`](/src/App.vue).
5357

54-
**Note**: to make component work properly add height or width styling properties explicitly for the parent block of component. It behaviour is very close to the scroll when you use `overflow: scroll`. For more info checkout the [page](https://github.com/idiotWu/smooth-scrollbar/tree/develop/docs#common-mistakes).
58+
**Note**: to make component work properly add height or width styling properties explicitly for the parent block of component. It behaviour is very close to the scroll when you use `overflow: scroll`. For more info checkout [this page](https://github.com/idiotWu/smooth-scrollbar/tree/develop/docs#common-mistakes).
59+
60+
61+
### 4. Import component in your code:
62+
```javascript
63+
import { VueSmoothScrollbarTs } from 'vue-smooth-scrollbar-ts'
64+
```
5565

56-
### 4. Wrap content you want to be scrolled.
66+
### 5. Wrap content you want to be scrolled.
5767

5868
Example:
5969
```javascript

package.json

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"public": true,
44
"author": "sayid.ibragimov",
55
"license": "MIT",
6-
"version": "1.0.0",
6+
"version": "1.0.1",
77
"type": "module",
88
"files": [
99
"dist",
@@ -58,6 +58,17 @@
5858
"vue3",
5959
"nuxt3",
6060
"typescript",
61-
"smooth-scrollbar"
61+
"smooth-scrollbar",
62+
"smooth-scrolling",
63+
"custom-scrollbar",
64+
"scrollbar",
65+
"scroll",
66+
"scroll-style",
67+
"scrollbar-style",
68+
"smoothscroll",
69+
"mac-scroll",
70+
"macos-scroll",
71+
"mac",
72+
"macos"
6273
]
6374
}

0 commit comments

Comments
 (0)