{"id":15717745,"url":"https://github.com/siibragimov/vue-smooth-scrollbar-ts","last_synced_at":"2026-01-04T06:39:37.428Z","repository":{"id":248013019,"uuid":"825747517","full_name":"siibragimov/vue-smooth-scrollbar-ts","owner":"siibragimov","description":"Vue 3 and Nuxt 3 compatible smooth-scrollbar component","archived":false,"fork":false,"pushed_at":"2024-07-18T19:36:59.000Z","size":1453,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-12T19:37:41.964Z","etag":null,"topics":["custom-scrollbar","mac","macos","nuxt3","scroll","scroll-style","scrollbar","scrollbar-style","smooth-scrolling","typescript","vue3"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/siibragimov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-08T12:19:25.000Z","updated_at":"2024-07-18T19:37:03.000Z","dependencies_parsed_at":"2024-07-19T00:13:50.261Z","dependency_job_id":"1eafe681-e209-4037-a3af-e095af0e468a","html_url":"https://github.com/siibragimov/vue-smooth-scrollbar-ts","commit_stats":null,"previous_names":["siibragimov/vue-smooth-scrollbar-ts"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siibragimov%2Fvue-smooth-scrollbar-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siibragimov%2Fvue-smooth-scrollbar-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siibragimov%2Fvue-smooth-scrollbar-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siibragimov%2Fvue-smooth-scrollbar-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/siibragimov","download_url":"https://codeload.github.com/siibragimov/vue-smooth-scrollbar-ts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244656734,"owners_count":20488640,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["custom-scrollbar","mac","macos","nuxt3","scroll","scroll-style","scrollbar","scrollbar-style","smooth-scrolling","typescript","vue3"],"created_at":"2024-10-03T21:51:09.677Z","updated_at":"2026-01-04T06:39:37.390Z","avatar_url":"https://github.com/siibragimov.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vue 3 and Nuxt 3 smooth scrollbar component\n\nAdd your styled scrollbar to any block, which will look consistent across all platforms. To see how it works, please, see the demo.\n\n[![npm version](https://badge.fury.io/js/vue-smooth-scrollbar-ts.svg)](https://badge.fury.io/js/vue-smooth-scrollbar-ts)\n[![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)\n[![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)\n[![Bundle size](https://badgen.net/bundlephobia/minzip/vue-smooth-scrollbar-ts)](https://bundlephobia.com/package/vue-smooth-scrollbar-ts)\n\nBased on [https://idiotwu.github.io/smooth-scrollbar/](https://idiotwu.github.io/smooth-scrollbar/).\n\n## Demo\nThere are two examples in the demo. One of them with custom styles.\n![Demo](https://raw.github.com/siibragimov/vue-smooth-scrollbar-ts/main/public/demo.webp)\n\n## Installation and setup\n\n### 1. Install component:\nIf you want to install package from __npmjs registry__(recommended) use:\n```shell\nnpm i vue-smooth-scrollbar-ts\n```\n\n```shell\nyarn add vue-smooth-scrollbar-ts\n```\n\n```shell\npnpm add vue-smooth-scrollbar-ts\n```\n\nIf you want to install package from __GitHub packages__ use: \n\n```shell\nnpm install @siibragimov/vue-smooth-scrollbar-ts\n```\n**Note**: Don't forget to configure registry for installing packages from GitHub. Use __.npmrc__ file or use command:\n```shell\nnpm config set registry https://npm.pkg.github.com/\n```\n\n### 2. Import CSS.\nFor Vue 3:\n```javascript\n  // in entry point (main.js)\n  import '../node_modules/vue-smooth-scrollbar-ts/dist/style.css';\n```\nFor Nuxt 3:\n```javascript\n  // nuxt.config.ts\n  export default defineNuxtConfig({\n    css: ['~/node_modules/vue-smooth-scrollbar-ts/dist/style.css'],\n  });\n```\n**Note**: If you have problems with import, check the file path and especially the prefix.\n\n### 3. Define overriding styles for scrollbars if needed. See the [`App.vue`](/src/App.vue).\n\n**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).\n\n\n### 4. Import component in your code:\n```javascript\nimport { VueSmoothScrollbarTs } from 'vue-smooth-scrollbar-ts'\n```\n\n### 5. Wrap content you want to be scrolled.\n\nExample:\n```javascript\n\u003caside class=\"container\"\u003e\n  \u003cVueSmoothScrollbarTs\u003e\n      \u003c!-- YOUR CONTENT --\u003e\n  \u003c/VueSmoothScrollbarTs\u003e\n\u003c/aside\u003e\n```\n## Properties\n\n| Name  | Type | Default | Description |\n| ------------- | ------------- | ------------- | ------------- |\n| __options__  | `ScrollbarOptions`  | `{}`  | check the list [here](https://github.com/idiotWu/smooth-scrollbar/tree/develop/docs#available-options-for-scrollbar) |\n| __plugins__  | `Array\u003cScrollbarPlugin\u003e`  | `[]`  | check the list [here](https://github.com/idiotWu/smooth-scrollbar/tree/develop/docs) |\n| __scrollIntoView__  | `boolean`  | `false`  | Scrolls the block into viewport when the user points cursor over it |\n\n## Contributing\n\nTo run in development mode \n```shell\nnpm run dev\n```\n\nUse for build component\n```shell\nnpm run build\n```\nand follow the instruction in console to open the test page.\n\nTo generate types you can use:\n```shell\nnpm run types\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiibragimov%2Fvue-smooth-scrollbar-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsiibragimov%2Fvue-smooth-scrollbar-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiibragimov%2Fvue-smooth-scrollbar-ts/lists"}