{"_id":"overlayscrollbars-svelte","_rev":"6-f425755346a39ec5d258a0dfb7b2633b","name":"overlayscrollbars-svelte","dist-tags":{"latest":"0.5.5"},"versions":{"0.4.0":{"name":"overlayscrollbars-svelte","version":"0.4.0","keywords":["overlayscrollbars","svelte","component","styleable","scrollbar","scrollbars","scroll"],"author":{"name":"Rene Haas | KingSora"},"license":"MIT","_id":"overlayscrollbars-svelte@0.4.0","maintainers":[{"name":"kingsora","email":"king-sora@hotmail.de"}],"homepage":"https://kingsora.github.io/OverlayScrollbars","bugs":{"url":"https://github.com/KingSora/OverlayScrollbars/issues"},"dist":{"shasum":"4663eea1d86612b44d4732b4b4de798f6be432b3","tarball":"https://registry.npmjs.org/overlayscrollbars-svelte/-/overlayscrollbars-svelte-0.4.0.tgz","fileCount":9,"integrity":"sha512-5liVtMb0WgHu2ngICYS2c5ihEVQ/6rSFCDuymamTO6fS8M1pgfPeUyaQp9dTms+p+yuQmjdNmplR5dGgzgFhkw==","signatures":[{"sig":"MEUCIQC0PfOqKk+RXkzvlvghk1uz9NkvB26pZGn9cCQ3EMmEKQIgRXip8yQBTkpdB7NeJo39vvmlQIduMLsDGgrKnENa/kU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9711,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjb4ZZACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr8VA/9GljWsrsuFdnT/lMl+Rz2oDmS8ZEc88fZz55fvB5Ujl4iIG2b\r\nCraxjbdTVkJZlG+DxZ1nr/vi4dSZGzZyR7rNUeIjt7EqmcxdPfjybQLq8MTZ\r\nYMUzTaFCDAQq68wW0xIbWE2fx6e2ql6iegsJ9RFT2//HAEIhXylPvUk0SmsQ\r\nfrCItJIEOtrnQSpua5ROvB/aj+Qm/f9EuUwo/AtWfCw2oPu+G23Qi3rByd4w\r\nh/hc99UxB8bNOOIcNlGchqDNPV+TpvJn6GxrMFEVnmx4UA1w3RaEbZ77aInr\r\ntY8KiAgJLlomgdwUwZf9LjDjKQccd0tq+mZOKroQJwaKjjG/UCwCjPV1Z0T3\r\nC2uZLOQzwRy+oSZ5uc0eLYOAqL7pK5bHTlm7moZg+LPVNs5UxpoJ8TTJFg1Y\r\n7X2SsjZVUJKAwqYYcFUVDgHacSx7ISqPLVpa/FZ8gVwMxxF9BNY42dq9bEx9\r\ngTacJ81ijDTJgYDKJTjBk3A7zSJlzevymBjZ8pyIj+pRAPM4lryh0SMxG6FD\r\nZc8dVW8ZkWvzY7bE8jqx09T5vmwhNXeE0WKdWOObXFhaueMLzPyvsuNwFD9J\r\nsu0gzUVEbUS03v8yUnva/POmWZl4yIg2LYp0LkLmzHIJLok9DoztEro7FqaY\r\nOMMrQd0ycfWVpz9CB7pfYUti+zB27dYGDsM=\r\n=Hs9J\r\n-----END PGP SIGNATURE-----\r\n"},"type":"module","types":"./index.d.ts","svelte":"./index.js","exports":{".":"./index.js","./package.json":"./package.json","./OverlayScrollbarsComponent.types":"./OverlayScrollbarsComponent.types.js","./OverlayScrollbarsComponent.svelte":"./OverlayScrollbarsComponent.svelte"},"gitHead":"712785c6a5d062106d26c4d8fe9016702008e364","_npmUser":{"name":"kingsora","email":"king-sora@hotmail.de"},"repository":{"url":"git+https://github.com/KingSora/OverlayScrollbars.git","type":"git","directory":"packages/overlayscrollbars-svelte"},"_npmVersion":"8.15.0","description":"OverlayScrollbars for Svelte.","directories":{},"sideEffects":false,"_nodeVersion":"16.17.0","_hasShrinkwrap":false,"devDependencies":{"tslib":"^2.3.1","svelte":"^3.44.0","typescript":"^4.7.4","svelte-check":"^2.7.1","@sveltejs/kit":"next","@sveltejs/package":"next","overlayscrollbars":"file:./../overlayscrollbars/dist","svelte-preprocess":"^4.10.6","@sveltejs/adapter-auto":"next","@testing-library/svelte":"^3.2.2","@sveltejs/vite-plugin-svelte":"^1.0.9"},"peerDependencies":{"svelte":"^3.44.0","overlayscrollbars":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/overlayscrollbars-svelte_0.4.0_1668253273752_0.7764751632909281","host":"s3://npm-registry-packages"}},"0.5.0":{"name":"overlayscrollbars-svelte","version":"0.5.0","keywords":["overlayscrollbars","svelte","component","styleable","scrollbar","scrollbars","scroll"],"author":{"name":"Rene Haas | KingSora"},"license":"MIT","_id":"overlayscrollbars-svelte@0.5.0","maintainers":[{"name":"kingsora","email":"king-sora@hotmail.de"}],"homepage":"https://kingsora.github.io/OverlayScrollbars","bugs":{"url":"https://github.com/KingSora/OverlayScrollbars/issues"},"dist":{"shasum":"29affab5f8b7645239dcd871101f29dd7942d5ee","tarball":"https://registry.npmjs.org/overlayscrollbars-svelte/-/overlayscrollbars-svelte-0.5.0.tgz","fileCount":15,"integrity":"sha512-1VZjfgvb6lgHXSR7IBUxYvHEMJRYhK/2CuRaMDswjlLXwtqNb7Ajw2hQ13Pg95YDPDgnWCMf5/XPCiVuWHeg0g==","signatures":[{"sig":"MEYCIQCJGWpOlJR5ljhNJBhNKcZPFqC7fKvrbu0PTF8C4eNcFwIhAMAzzL/g/BtOAaf0VK7MhIIW33yOBK+D7nUSRl0SB5fP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":227776},"main":"overlayscrollbars-svelte.cjs.js","type":"module","types":"overlayscrollbars-svelte.d.ts","module":"overlayscrollbars-svelte.es.js","svelte":"./overlayscrollbars-svelte.js","exports":{".":{"types":"./overlayscrollbars-svelte.d.ts","svelte":"./overlayscrollbars-svelte.js","default":"./overlayscrollbars-svelte.js"}},"gitHead":"4838640547c90883a19c1ac09a99b0f3c35ac7ae","_npmUser":{"name":"kingsora","email":"king-sora@hotmail.de"},"repository":{"url":"git+https://github.com/KingSora/OverlayScrollbars.git","type":"git","directory":"packages/overlayscrollbars-svelte"},"_npmVersion":"8.15.0","description":"OverlayScrollbars for Svelte.","directories":{},"sideEffects":false,"_nodeVersion":"16.17.0","_hasShrinkwrap":false,"peerDependencies":{"svelte":">=3.54.0","overlayscrollbars":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/overlayscrollbars-svelte_0.5.0_1689160416686_0.7231699569885202","host":"s3://npm-registry-packages"}},"0.5.1":{"name":"overlayscrollbars-svelte","version":"0.5.1","keywords":["overlayscrollbars","svelte","component","styleable","custom","scrollbar","scrollbars","scroll"],"author":{"name":"Rene Haas | KingSora"},"license":"MIT","_id":"overlayscrollbars-svelte@0.5.1","maintainers":[{"name":"kingsora","email":"king-sora@hotmail.de"}],"homepage":"https://kingsora.github.io/OverlayScrollbars","bugs":{"url":"https://github.com/KingSora/OverlayScrollbars/issues"},"dist":{"shasum":"5eee11592704b8f92440d41d5a9ffea636bb044f","tarball":"https://registry.npmjs.org/overlayscrollbars-svelte/-/overlayscrollbars-svelte-0.5.1.tgz","fileCount":15,"integrity":"sha512-ky70B5oRtTYFwjhAZeCIAH4rPB54dwbN5PUEccJp1lZFO9Z0tyQuvtVlkteO2xqxyCXs+CLx7Gnm9YkHNhSfwQ==","signatures":[{"sig":"MEYCIQDxDVJmjRpKnTIf8KXF3nnoVqN7W5b0i9jMh0m5wbxdkAIhAMPUJ0WTUP4Q575Q7jpsyPI5ZKMjCz2yy7LDP3k9qvM2","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":231799},"main":"overlayscrollbars-svelte.cjs.js","type":"module","types":"overlayscrollbars-svelte.d.ts","module":"overlayscrollbars-svelte.es.js","svelte":"./overlayscrollbars-svelte.js","exports":{".":{"types":"./overlayscrollbars-svelte.d.ts","svelte":"./overlayscrollbars-svelte.js","default":"./overlayscrollbars-svelte.js"}},"gitHead":"7621541a6cfd24baa908ecc34280d141c9c12a12","_npmUser":{"name":"kingsora","email":"king-sora@hotmail.de"},"repository":{"url":"git+https://github.com/KingSora/OverlayScrollbars.git","type":"git","directory":"packages/overlayscrollbars-svelte"},"_npmVersion":"8.15.0","description":"OverlayScrollbars for Svelte.","directories":{},"sideEffects":false,"_nodeVersion":"16.17.0","_hasShrinkwrap":false,"peerDependencies":{"svelte":">=3.54.0","overlayscrollbars":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/overlayscrollbars-svelte_0.5.1_1692997389379_0.5684846304061693","host":"s3://npm-registry-packages"}},"0.5.2":{"name":"overlayscrollbars-svelte","version":"0.5.2","keywords":["overlayscrollbars","svelte","component","styleable","custom","scrollbar","scrollbars","scroll"],"author":{"name":"Rene Haas | KingSora"},"license":"MIT","_id":"overlayscrollbars-svelte@0.5.2","maintainers":[{"name":"kingsora","email":"king-sora@hotmail.de"}],"homepage":"https://kingsora.github.io/OverlayScrollbars","bugs":{"url":"https://github.com/KingSora/OverlayScrollbars/issues"},"dist":{"shasum":"549d1e7a49c17e9027a067f6096cb61552c1f8d6","tarball":"https://registry.npmjs.org/overlayscrollbars-svelte/-/overlayscrollbars-svelte-0.5.2.tgz","fileCount":15,"integrity":"sha512-PRWC5vyJAY8VHzuVyMYD5dptoL8ArYizubPZ/5qEXIVQfcDxz7Bl9vRxCkR0RsHnP8TKXe3c7WaDGF7arPRV8Q==","signatures":[{"sig":"MEYCIQDcksvg71hZyFDoanWvHulinT5v8QzkBl4xxA9m9hK6pwIhAJD9CqXqvRqYiXfoSokaZYCUDQW7+RaQbIjGYpjwJ8Mo","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":229829},"main":"overlayscrollbars-svelte.cjs.js","type":"module","types":"overlayscrollbars-svelte.d.ts","module":"overlayscrollbars-svelte.es.js","svelte":"./overlayscrollbars-svelte.js","exports":{".":{"types":"./overlayscrollbars-svelte.d.ts","svelte":"./overlayscrollbars-svelte.js","default":"./overlayscrollbars-svelte.js"}},"gitHead":"fa4611c533212fd2edf16ac87b573b2652e5357b","_npmUser":{"name":"kingsora","email":"king-sora@hotmail.de"},"repository":{"url":"git+https://github.com/KingSora/OverlayScrollbars.git","type":"git","directory":"packages/overlayscrollbars-svelte"},"_npmVersion":"9.8.1","description":"OverlayScrollbars for Svelte.","directories":{},"sideEffects":false,"_nodeVersion":"18.18.0","_hasShrinkwrap":false,"peerDependencies":{"svelte":">=3.54.0","overlayscrollbars":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/overlayscrollbars-svelte_0.5.2_1697401254680_0.660977284204602","host":"s3://npm-registry-packages"}},"0.5.3":{"name":"overlayscrollbars-svelte","version":"0.5.3","keywords":["overlayscrollbars","svelte","component","styleable","custom","scrollbar","scrollbars","scroll"],"author":{"name":"Rene Haas | KingSora"},"license":"MIT","_id":"overlayscrollbars-svelte@0.5.3","maintainers":[{"name":"kingsora","email":"king-sora@hotmail.de"}],"homepage":"https://kingsora.github.io/OverlayScrollbars","bugs":{"url":"https://github.com/KingSora/OverlayScrollbars/issues"},"dist":{"shasum":"3fd8766612e3ebd0882a37d4a826e04fa25ed250","tarball":"https://registry.npmjs.org/overlayscrollbars-svelte/-/overlayscrollbars-svelte-0.5.3.tgz","fileCount":23,"integrity":"sha512-oBuYVlCavo6FNSf+qnvrE9XGbRnnGmpLIGBMNBjlTieGB7v3/bPZ+/j06Zgs89sWn8mI73myMmgGXI97PHuxoQ==","signatures":[{"sig":"MEQCIG4NgiYcKBHPqS+iJi1lHsIJVMH89bYTyGpWpRjSs9ijAiBSnrYvnsq6YjNYSmn7uIfSEKjYv7qMhU0OCTXOFo+fcw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":457194},"main":"overlayscrollbars-svelte.esm.js","type":"module","types":"overlayscrollbars-svelte.d.ts","module":"overlayscrollbars-svelte.esm.js","svelte":"./overlayscrollbars-svelte.js","exports":{".":{"import":{"types":"./overlayscrollbars-svelte.d.mts","default":"./overlayscrollbars-svelte.mjs"},"svelte":{"types":"./overlayscrollbars-svelte.d.ts","default":"./overlayscrollbars-svelte.js"},"default":{"types":"./overlayscrollbars-svelte.d.ts","default":"./overlayscrollbars-svelte.js"},"require":{"types":"./overlayscrollbars-svelte.d.cts","default":"./overlayscrollbars-svelte.cjs"}}},"gitHead":"cc4f902c7dd2d6f17d3e10c571b25e4e26ef4b15","_npmUser":{"name":"kingsora","email":"king-sora@hotmail.de"},"repository":{"url":"git+https://github.com/KingSora/OverlayScrollbars.git","type":"git","directory":"packages/overlayscrollbars-svelte"},"_npmVersion":"10.2.3","description":"OverlayScrollbars for Svelte.","directories":{},"sideEffects":false,"_nodeVersion":"20.10.0","_hasShrinkwrap":false,"peerDependencies":{"svelte":">=3.54.0","overlayscrollbars":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/overlayscrollbars-svelte_0.5.3_1706099296759_0.2819004034715824","host":"s3://npm-registry-packages"}},"0.5.4":{"name":"overlayscrollbars-svelte","version":"0.5.4","keywords":["overlayscrollbars","svelte","component","styleable","custom","scrollbar","scrollbars","scroll"],"author":{"name":"Rene Haas | KingSora"},"license":"MIT","_id":"overlayscrollbars-svelte@0.5.4","maintainers":[{"name":"kingsora","email":"king-sora@hotmail.de"}],"homepage":"https://kingsora.github.io/OverlayScrollbars","bugs":{"url":"https://github.com/KingSora/OverlayScrollbars/issues"},"dist":{"shasum":"a2f30ef10e15a0fa2bd69e021549527b35c9dd1b","tarball":"https://registry.npmjs.org/overlayscrollbars-svelte/-/overlayscrollbars-svelte-0.5.4.tgz","fileCount":23,"integrity":"sha512-QvcC9jdP5kweoKyi+40/+5ynBxY0RwdGlpNX0P1OpK1sGQWlCBUO33VHVDMrRPc1Ki7Q0ZtGbkOZt/pkFXHCWg==","signatures":[{"sig":"MEUCIBD5X9ZVk+xsDrrXoAr6c/O/PN1lKfl/naPmHgy1/K1uAiEA1jxvuTbIycJGhbVVRlc/FaBHjahVO6rtN7bku6H8oBQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":464566},"main":"overlayscrollbars-svelte.esm.js","type":"module","types":"overlayscrollbars-svelte.d.ts","module":"overlayscrollbars-svelte.esm.js","svelte":"./overlayscrollbars-svelte.js","exports":{".":{"import":{"types":"./overlayscrollbars-svelte.d.mts","default":"./overlayscrollbars-svelte.mjs"},"svelte":{"types":"./overlayscrollbars-svelte.d.ts","default":"./overlayscrollbars-svelte.js"},"default":{"types":"./overlayscrollbars-svelte.d.ts","default":"./overlayscrollbars-svelte.js"},"require":{"types":"./overlayscrollbars-svelte.d.cts","default":"./overlayscrollbars-svelte.cjs"}}},"gitHead":"e0ad5d026909b85d10e9ed0f7605cddd067408c9","_npmUser":{"name":"kingsora","email":"king-sora@hotmail.de"},"repository":{"url":"git+https://github.com/KingSora/OverlayScrollbars.git","type":"git","directory":"packages/overlayscrollbars-svelte"},"_npmVersion":"10.2.4","description":"OverlayScrollbars for Svelte.","directories":{},"sideEffects":false,"_nodeVersion":"20.11.1","_hasShrinkwrap":false,"peerDependencies":{"svelte":">=3.54.0","overlayscrollbars":"^2.0.0"},"_npmOperationalInternal":{"tmp":"tmp/overlayscrollbars-svelte_0.5.4_1712014780944_0.25454922010541736","host":"s3://npm-registry-packages"}},"0.5.5":{"name":"overlayscrollbars-svelte","version":"0.5.5","type":"module","description":"OverlayScrollbars for Svelte.","author":{"name":"Rene Haas | KingSora"},"license":"MIT","homepage":"https://kingsora.github.io/OverlayScrollbars","bugs":{"url":"https://github.com/KingSora/OverlayScrollbars/issues"},"repository":{"type":"git","url":"git+https://github.com/KingSora/OverlayScrollbars.git","directory":"packages/overlayscrollbars-svelte"},"keywords":["overlayscrollbars","svelte","component","styleable","custom","scrollbar","scrollbars","scroll"],"main":"overlayscrollbars-svelte.esm.js","module":"overlayscrollbars-svelte.esm.js","types":"overlayscrollbars-svelte.d.ts","svelte":"./overlayscrollbars-svelte.js","exports":{".":{"svelte":{"types":"./overlayscrollbars-svelte.d.ts","default":"./overlayscrollbars-svelte.js"},"import":{"types":"./overlayscrollbars-svelte.d.mts","default":"./overlayscrollbars-svelte.mjs"},"require":{"types":"./overlayscrollbars-svelte.d.cts","default":"./overlayscrollbars-svelte.cjs"},"default":{"types":"./overlayscrollbars-svelte.d.ts","default":"./overlayscrollbars-svelte.js"}}},"peerDependencies":{"overlayscrollbars":"^2.0.0","svelte":"^5.0.0"},"sideEffects":false,"_id":"overlayscrollbars-svelte@0.5.5","gitHead":"c5163d234c430e51c8298995c70373c122938589","_nodeVersion":"22.13.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-+dRW3YZSvFbKi5vDCpnUOHuoPLLSdu0BUVVMYZdmfVghu7XkafDRebG2y91/ImPqj6YDAUsz1rcWVYhCJSS/pQ==","shasum":"a40ec3558d5c3190fc827a6f5838999b6025c1d8","tarball":"https://registry.npmjs.org/overlayscrollbars-svelte/-/overlayscrollbars-svelte-0.5.5.tgz","fileCount":23,"unpackedSize":1135262,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDhDNQu+isiKCJHKq6337BgNK3TNl/Tyf44ke+8ZYr+GAIhAKrRlR0/sWRiNMpi3ut3VnaKp5nKpFfMBy3T12RsI9IY"}]},"_npmUser":{"name":"kingsora","email":"king-sora@hotmail.de"},"directories":{},"maintainers":[{"name":"kingsora","email":"king-sora@hotmail.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/overlayscrollbars-svelte_0.5.5_1739971701743_0.23624006360672034"},"_hasShrinkwrap":false}},"time":{"created":"2022-11-12T11:41:13.751Z","modified":"2025-02-19T13:28:22.166Z","0.4.0":"2022-11-12T11:41:13.903Z","0.5.0":"2023-07-12T11:13:36.910Z","0.5.1":"2023-08-25T21:03:09.663Z","0.5.2":"2023-10-15T20:20:54.889Z","0.5.3":"2024-01-24T12:28:16.910Z","0.5.4":"2024-04-01T23:39:41.156Z","0.5.5":"2025-02-19T13:28:21.987Z"},"bugs":{"url":"https://github.com/KingSora/OverlayScrollbars/issues"},"author":{"name":"Rene Haas | KingSora"},"license":"MIT","homepage":"https://kingsora.github.io/OverlayScrollbars","keywords":["overlayscrollbars","svelte","component","styleable","custom","scrollbar","scrollbars","scroll"],"repository":{"type":"git","url":"git+https://github.com/KingSora/OverlayScrollbars.git","directory":"packages/overlayscrollbars-svelte"},"description":"OverlayScrollbars for Svelte.","maintainers":[{"name":"kingsora","email":"king-sora@hotmail.de"}],"readme":"<div align=\"center\">\r\n  <a href=\"https://kingsora.github.io/OverlayScrollbars\"><img src=\"https://raw.githubusercontent.com/KingSora/OverlayScrollbars/master/logo/logo.png\" width=\"160\" height=\"160\" alt=\"OverlayScrollbars\"></a>\r\n  <a href=\"https://svelte.dev/\"><img src=\"https://raw.githubusercontent.com/KingSora/OverlayScrollbars/master/packages/overlayscrollbars-svelte/logo.svg\" width=\"160\" height=\"160\" alt=\"Svelte\"></a>\r\n</div>\r\n<br />\r\n<div align=\"center\">\r\n\r\n  [![OverlayScrollbars](https://img.shields.io/badge/OverlayScrollbars-%5E2.0.0-338EFF?style=flat-square)](https://github.com/KingSora/OverlayScrollbars)\r\n  [![Svelte](https://img.shields.io/badge/Svelte-%5E5.0.0-FF3E00?style=flat-square&logo=svelte)](https://github.com/sveltejs/svelte)\r\n  [![Downloads](https://img.shields.io/npm/dt/overlayscrollbars-svelte.svg?style=flat-square)](https://www.npmjs.com/package/overlayscrollbars-svelte)\r\n  [![Version](https://img.shields.io/npm/v/overlayscrollbars-svelte.svg?style=flat-square)](https://www.npmjs.com/package/overlayscrollbars-svelte)\r\n  [![License](https://img.shields.io/github/license/kingsora/overlayscrollbars.svg?style=flat-square)](#)\r\n\r\n</div>\r\n<h3 align=\"center\">\r\n  <a href=\"https://kingsora.github.io/OverlayScrollbars\">Website</a>\r\n  &nbsp;&nbsp;&bull;&nbsp;&nbsp;\r\n  <a href=\"https://kingsora.github.io/OverlayScrollbars/examples\">Examples</a>\r\n</h3>\r\n\r\n# OverlayScrollbars for Svelte\r\n\r\nThis is the official OverlayScrollbars Svelte wrapper.\r\n\r\n## Installation\r\n\r\n```sh\r\nnpm install overlayscrollbars-svelte\r\n```\r\n\r\n## Peer Dependencies\r\n\r\nOverlayScrollbars for Svelte has the following **peer dependencies**:\r\n\r\n- The vanilla JavaScript library: [overlayscrollbars](https://www.npmjs.com/package/overlayscrollbars)\r\n\r\n```\r\nnpm install overlayscrollbars\r\n```\r\n\r\n- The Svelte framework: [svelte](https://www.npmjs.com/package/svelte)\r\n\r\n```\r\nnpm install svelte\r\n```\r\n\r\n## Usage\r\n\r\nThe first step is to import the CSS file into your app:\r\n```ts\r\nimport 'overlayscrollbars/overlayscrollbars.css';\r\n```\r\n\r\n> __Note__: If the path `'overlayscrollbars/overlayscrollbars.css'` is not working use `'overlayscrollbars/styles/overlayscrollbars.css'` as the import path for the CSS file.\r\n\r\n## Component\r\n\r\nThe main entry point is the `OverlayScrollbarsComponent` which can be used in your application as a component:\r\n\r\n```svelte\r\n<script>\r\nimport { OverlayScrollbarsComponent } from \"overlayscrollbars-svelte\";\r\n\r\n// ...\r\n</script>\r\n\r\n<OverlayScrollbarsComponent defer>\r\n  example content\r\n</OverlayScrollbarsComponent>\r\n```\r\n\r\n### Properties\r\n\r\nThe component accepts all properties of regular elements such as `div` and `span`.  \r\nAdditionally it has custom optional properties:\r\n\r\n- `element`: accepts a `string` which represents the tag of the root element.\r\n- `options`: accepts an `object` which represents the OverlayScrollbars options.\r\n- `events`: accepts an `object` which represents the OverlayScrollbars events.\r\n- `defer`: accepts an `boolean` or `object`. Defers the initialization to a point in time when the browser is idle.\r\n\r\n> __Note__: Its **highly recommended** to use the `defer` option whenever possible to defer the initialization to a browser's idle period.\r\n\r\n```svelte\r\n<!-- example usage -->\r\n<OverlayScrollbarsComponent\r\n  element=\"span\"\r\n  options={{ scrollbars: { autoHide: 'scroll' } }}\r\n  events={{ scroll: () => { /* ... */ } }}\r\n  defer\r\n/>\r\n```\r\n\r\n### Events\r\n\r\nAdditionally to the `events` property the `OverlayScrollbarsComponent` emits \"native\" Svelte events. To prevent name collisions with DOM events the events have a `os` prefix. \r\n\r\n> __Note__: Events are still supported even though they are are [deprecated](https://svelte.dev/docs/svelte/v5-migration-guide#Event-changes). This was done to ease migration and will be removed in a future release. Please use the `events` option instead.\r\n\r\n```svelte\r\n<!-- example usage -->\r\n<OverlayScrollbarsComponent\r\n  on:osInitialized={onInitialized}\r\n  on:osUpdated={onUpdated}\r\n  on:osDestroyed={onDestroyed}\r\n  on:osScroll={onScroll}\r\n/>\r\n```\r\n\r\nAll events are typed, but you can use the `EventListenerArgs` type as utility in case its needed:\r\n\r\n```ts\r\nimport type { EventListenerArgs } from 'overlayscrollbars';\r\n\r\n// example listener\r\nconst onUpdated = (event) => {\r\n  const [instance, onUpdatedArgs] = event.detail as EventListenerArgs['updated'];\r\n}\r\n```\r\n\r\n### Ref\r\n\r\nThe `ref` of the `OverlayScrollbarsComponent` will give you an object with which you can access the OverlayScrollbars `instance` and the root `element` of the component.  \r\nThe ref object has two properties:\r\n\r\n- `osInstance`: a function which returns the OverlayScrollbars instance.\r\n- `getElement`: a function which returns the root element.\r\n\r\n## Primitive\r\n\r\nIn case the `OverlayScrollbarsComponent` is not enough, you can also use the `useOverlayScrollbars` primitive:\r\n\r\n```svelte\r\n<script>\r\n  import { useOverlayScrollbars } from 'overlayscrollbars-svelte';\r\n  import { onMount } from 'svelte';\r\n\r\n  let div = $state();\r\n  let params = $state$({ options, events, defer });\r\n  const [initialize, instance] = useOverlayScrollbars(() => params);\r\n\r\n  /** \r\n   * or:\r\n   * \r\n   * let options = $state$();\r\n   * let events = $state();\r\n   * let defer = $state();\r\n   * const [initialize, instance] = useOverlayScrollbars({\r\n   *   options: () => options,\r\n   *   events: () => events,\r\n   *   defer: () => defer,\r\n   * });\r\n   * \r\n   */\r\n\r\n  onMount(() => {\r\n    initialize({ target: div });\r\n  });\r\n</script>\r\n\r\n<div bind:this={div}></div>\r\n```\r\n\r\nThe primitive is for advanced usage and lets you control the whole initialization process. This is useful if you want to integrate it with other plugins.\r\n\r\n### Parameters\r\n\r\nParameters are optional and similar to the `OverlayScrollbarsComponent`.\r\nIts an `object` with optional properties:\r\n\r\n- `options`: accepts an `object` which represents the OverlayScrollbars options.\r\n- `events`: accepts an `object` which represents the OverlayScrollbars events.\r\n- `defer`: accepts an `boolean` or `object`. Defers the initialization to a point in time when the browser is idle.\r\n\r\n> __Note__: You can also pass a `function` as parameter which returns the object in case the object itself is reactive. This also applies to all fields.\r\n\r\n### Return\r\n\r\nThe `useOverlayScrollbars` primitive returns a `tuple` with two values:\r\n\r\n- The first value is the `initialization` function, it takes one argument which is the `InitializationTarget`.\r\n- The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.\r\n\r\n## License\r\n\r\nMIT\r\n","readmeFilename":"README.md"}