Skip to content

Commit

Permalink
Added deploy bages and updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Said Ibragimov committed Jul 15, 2024
1 parent d937ec2 commit 980163b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 7 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Vue 3 and Nuxt 3 smooth scrollbar component

Add your styled scrollbar to any block, which will look consistent across all platforms. To see how it works, plaese, see the demo.
Add your styled scrollbar to any block, which will look consistent across all platforms. To see how it works, please, see the demo.

[![npm version](https://badge.fury.io/js/vue-smooth-scrollbar-ts.svg)](https://badge.fury.io/js/vue-smooth-scrollbar-ts)
[![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)
[![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)

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

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

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

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

**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).
**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).


### 4. Import component in your code:
```javascript
import { VueSmoothScrollbarTs } from 'vue-smooth-scrollbar-ts'
```

### 4. Wrap content you want to be scrolled.
### 5. Wrap content you want to be scrolled.

Example:
```javascript
Expand Down
15 changes: 13 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"public": true,
"author": "sayid.ibragimov",
"license": "MIT",
"version": "1.0.0",
"version": "1.0.1",
"type": "module",
"files": [
"dist",
Expand Down Expand Up @@ -58,6 +58,17 @@
"vue3",
"nuxt3",
"typescript",
"smooth-scrollbar"
"smooth-scrollbar",
"smooth-scrolling",
"custom-scrollbar",
"scrollbar",
"scroll",
"scroll-style",
"scrollbar-style",
"smoothscroll",
"mac-scroll",
"macos-scroll",
"mac",
"macos"
]
}

0 comments on commit 980163b

Please sign in to comment.