@cocreate/scrollbar 1.16.0 → 2.0.0

package/CONTRIBUTING.md

@@ -1,19 +1,19 @@
 # Contributing to CoCreate-overlay-scroll
 
-This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-overlay-scroll/graphs/contributors).
-You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-overlay-scroll/pulls),
-[propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-overlay-scroll/issues).
+This project is work of [many contributors](https://github.com/CoCreateJS/overlay-scroll/graphs/contributors).
+You're encouraged to submit [pull requests](https://github.com/CoCreateJS/overlay-scroll/pulls),
+[propose features and discuss issues](https://github.com/CoCreateJS/overlay-scroll/issues).
 
 In the examples below, substitute your Github username for `contributor` in URLs.
 
 ## Fork the Project
 
-Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-overlay-scroll) and check out your copy.
+Fork the [project on Github](https://github.com/CoCreateJS/overlay-scroll) and check out your copy.
 
 ```
 git overlay-scroll https://github.com/contributor/CoCreate-overlay-scroll.git
 cd CoCreate-overlay-scroll
-git remote add upstream https://gitlab.com/cocreatejs/CoCreate-overlay-scroll.git
+git remote add upstream https://github.com/CoCreateJS/overlay-scroll.git
 ```
 
 ## Create a Topic Branch
@@ -75,7 +75,7 @@ git push origin my-feature-branch
 
 ## Make a Pull Request
 
-Go to [https://github.com/CoCreate-app/CoCreate-overlay-scroll](https://github.com/CoCreate-app/CoCreate-overlay-scroll) and select your feature branch.
+Go to [https://github.com/CoCreateJS/overlay-scroll](https://github.com/CoCreateJS/overlay-scroll) and select your feature branch.
 Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
 
 ## Rebase

package/README.md

@@ -138,11 +138,11 @@ The stylesheet also includes `theme-indigo`, `theme-emerald`, `theme-rose`,
 
 ## Project links
 
-- [Documentation](https://cocreate.app/docs/scrollbar)
-- [Issues](https://github.com/CoCreate-app/CoCreate-scrollbar/issues)
-- [Releases](https://github.com/CoCreate-app/CoCreate-scrollbar/releases)
-- [Contributing](https://github.com/CoCreate-app/CoCreate-scrollbar/blob/master/CONTRIBUTING.md)
+- [Documentation](https://CoCreateJS.com/docs/scrollbar)
+- [Issues](https://github.com/CoCreateJS/scrollbar/issues)
+- [Releases](https://github.com/CoCreateJS/scrollbar/releases)
+- [Contributing](https://github.com/CoCreateJS/scrollbar/blob/master/CONTRIBUTING.md)
 
 ## License
 
-[MIT](https://github.com/CoCreate-app/CoCreate-scrollbar/blob/master/LICENSE)
+[MIT](https://github.com/CoCreateJS/scrollbar/blob/master/LICENSE)

package/docs/index.html

@@ -9,7 +9,7 @@
 			rel="icon"
 			type="image/png"
 			sizes="32x32"
-			href="https://cocreate.app/images/favicon.ico" />
+			href="https://CoCreateJS.com/images/favicon.ico" />
 		<meta
 			name="description"
 			content="A simple yet powerful drag-and-drop solution powered by javascript." />
@@ -19,7 +19,7 @@
 		<meta name="robots" content="index,follow" />
 		<meta
 			property="og:image"
-			content="https://cdn.cocreate.app/docs/CoCreate-overlay-scroll.png" />
+			content="https://cdn.CoCreateJS.com/docs/CoCreate-overlay-scroll.png" />
 
 		<link
 			rel="stylesheet"
@@ -73,7 +73,7 @@
 						share-title="testing im a title"
 						share-height="600"
 						share-width="700"
-						share-media="https://cdn.cocreate.app/docs/overlay-scroll.png"
+						share-media="https://cdn.CoCreateJS.com/docs/overlay-scroll.png"
 						hover="display:block!important"
 						hover-query=".social-networks">
 						<div class="display:none social-networks">
@@ -104,7 +104,7 @@
 						></a>
 					</div>
 					<a
-						href="https://github.com/CoCreate-app/CoCreate-dnd"
+						href="https://github.com/CoCreateJS/CoCreate-dnd"
 						target="_blank"
 						class=""
 						><i src="/assets/svg/github.svg"></i
@@ -143,7 +143,7 @@
 					<p class="padding:10px_0px line-height:1.5">
 						Or you can use cdn link:
 					</p>
-					<pre><code class="language-html">&lt;script&gt;https://cdn.cocreate.app/overlay-scroll/latest/CoCreate-overlay-scroll.min.js&lt;/script&gt;</code></pre>
+					<pre><code class="language-html">&lt;script&gt;https://cdn.CoCreateJS.com/overlay-scroll/latest/CoCreate-overlay-scroll.min.js&lt;/script&gt;</code></pre>
 					<!-- <p class="padding:10px_0px line-height:1.5">for styling please refer to #id-style</p> -->
 
 					<div
@@ -427,13 +427,13 @@
 				</div>
 			</div>
 			<button
-				href="https://github.com/CoCreate-app/CoCreate-overlay-scroll/tree/master/docs/index.html?message=docs%3A%20describe%20your%20change..."
+				href="https://github.com/CoCreateJS/CoCreate-overlay-scroll/tree/master/docs/index.html?message=docs%3A%20describe%20your%20change..."
 				target="_blank"
 				class="display:flex justify-content:center align-items:center position:fixed bottom:15px right:15px height:50px width:50px border-radius:50% box-shadow:0px_2px_10px_0px_rgba(0,_0,_0,_0.4)">
 				<i src="../assets/svg/pencil-alt.svg"></i>
 			</button>
 		</main>
 
-		<script src="https://CoCreate.app/dist/CoCreate.js"></script>
+		<script src="https://CoCreateJS.com/dist/CoCreate.js"></script>
 	</body>
 </html>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/scrollbar",
-  "version": "1.16.0",
+  "version": "2.0.0",
   "description": "A declarative custom scrollbar for native scroll containers with configurable axes, track positions, visibility, and automatic DOM lifecycle handling.",
   "keywords": [
     "scrollbar",
@@ -22,17 +22,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://gitlab.com/cocreatejs/CoCreate-scrollbar.git"
+    "url": "git+https://github.com/CoCreateJS/scrollbar.git"
   },
   "author": "CoCreate LLC",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/CoCreate-app/CoCreate-scrollbar/issues"
+    "url": "https://github.com/CoCreateJS/scrollbar/issues"
   },
-  "homepage": "https://cocreate.app/docs/scrollbar",
+  "homepage": "https://CoCreateJS.com/docs/scrollbar",
   "funding": {
     "type": "GitHub Sponsors ❤",
-    "url": "https://github.com/sponsors/CoCreate-app"
+    "url": "https://github.com/sponsors/CoCreateJS"
   },
   "main": "./src/index.js",
   "dependencies": {

package/src/index.js

@@ -19,7 +19,9 @@ const CoCreateScrollbar = (function () {
 
     /**
      * Core ScrollInstance Class
-     */
+ * @private
+ * @environment client
+ */
     function ScrollInstance(el, config) {
         this.element = el;
         this.options = Object.assign({
@@ -83,6 +85,11 @@ const CoCreateScrollbar = (function () {
         this.update();
     };
 
+    /**
+     *
+ * @public
+ * @environment client
+ */
     ScrollInstance.prototype.init = function () {
         this.parseAttributes();
 
@@ -348,6 +355,11 @@ const CoCreateScrollbar = (function () {
         }
     };
 
+    /**
+     *
+ * @public
+ * @environment client
+ */
     ScrollInstance.prototype.destroy = function () {
         clearTimeout(this.scrollTimer);
         if (this.resizeObserver) this.resizeObserver.disconnect();
@@ -414,6 +426,11 @@ const CoCreateScrollbar = (function () {
             return created.length === 1 ? created[0] : created;
         },
 
+        /**
+         *
+ * @public
+ * @environment client
+ */
         get: function (el) {
             return instances.get(el);
         },
@@ -423,6 +440,11 @@ const CoCreateScrollbar = (function () {
             if (inst) inst.destroy();
         },
 
+        /**
+         *
+ * @public
+ * @environment client
+ */
         initAll: function () {
             if (typeof document === 'undefined') return;
             var targets = document.querySelectorAll(selector);
@@ -473,3 +495,57 @@ Observer.init({
 CoCreateScrollbar.initAll();
 
 export default CoCreateScrollbar;
+
+/**
+ *
+ * @name scrollbar
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name scrollbar-pos
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name scrollbar-type
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ *
+ * @name scrollbar-visible
+ * @kind member
+ * @attribute
+ * @environment client
+ */
+
+/**
+ * A declarative custom scrollbar for native scroll containers with configurable axes, track positions, visibility, and automatic DOM lifecycle handling.
+ *
+ * @module scrollbar
+ * @environment client
+ */
+
+/**
+ * Declarative selectors recognized by this module.
+ *
+ * @name declarative-selectors
+ * @kind member
+ * @selectors
+ * @environment client
+ * @example
+ * ```json
+ * [
+ *   "[scrollbar]"
+ * ]
+ * ```
+ */