Initial Commit 🧨

Author: hirasso

.github/DISCUSSION_TEMPLATE/ideas.yml

@@ -8,8 +8,8 @@ body:
         ### Thanks for taking the time to fill out this bug report! 🏓 Before you begin:
 
         - ✅ Make sure you are running the latest version of the library
-        - ✅ Please make sure you read our [Code of Conduct](https://github.com/hirasso/scrollmemory/blob/master/CODE_OF_CONDUCT.md)
-        - ✅ Make sure to check [discussions](https://github.com/hirasso/scrollmemory/discussions) and [existing issues](https://github.com/issues?q=is%3Aissue+repo%3Ahirasso%2Fscrollmemory+). Maybe your problem was already solved :)
+        - ✅ Please make sure you read our [Code of Conduct](https://github.com/hirasso/restore-scroll/blob/master/CODE_OF_CONDUCT.md)
+        - ✅ Make sure to check [discussions](https://github.com/hirasso/restore-scroll/discussions) and [existing issues](https://github.com/issues?q=is%3Aissue+repo%3Ahirasso%2Frestore-scroll+). Maybe your problem was already solved :)
 
   - type: textarea
     id: what-did-you-expect
@@ -52,11 +52,11 @@ body:
     attributes:
       label: Checked all these? 📚
       options:
-        - label: I have read the [usage instructions](https://github.com/hirasso/scrollmemory#usage-example)
+        - label: I have read the [usage instructions](https://github.com/hirasso/restore-scroll#usage-example)
           required: true
-        - label: I have checked [discussions](https://github.com/hirasso/scrollmemory/discussions) and [existing issues](https://github.com/issues?q=is%3Aissue+repo%3Ahirasso%2Fscrollmemory+) for related problems
+        - label: I have checked [discussions](https://github.com/hirasso/restore-scroll/discussions) and [existing issues](https://github.com/issues?q=is%3Aissue+repo%3Ahirasso%2Frestore-scroll+) for related problems
           required: true
-        - label: I agree to follow this project's [Code of Conduct](https://github.com/hirasso/scrollmemory/blob/master/CODE_OF_CONDUCT.md)
+        - label: I agree to follow this project's [Code of Conduct](https://github.com/hirasso/restore-scroll/blob/master/CODE_OF_CONDUCT.md)
           required: true
         - label: I have provided all necessary information to the best of my knowledge
           required: true

.github/DISCUSSION_TEMPLATE/q-a.yml

@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
   - name: Discussions
-    url: https://github.com/hirasso/scrollmemory/discussions
+    url: https://github.com/hirasso/restore-scroll/discussions
     about: Join the discussion and get help by other users.

.github/ISSUE_TEMPLATE/bug.yml

@@ -7,8 +7,8 @@ body:
       value: |
         ### Thanks for taking the time to request a new feature! 🏓 Before you begin:
 
-        - ✅ Please make sure you read our [Code of Conduct](https://github.com/hirasso/scrollmemory/blob/master/CODE_OF_CONDUCT.md)
-        - ✅ Make sure to check [discussions](https://github.com/hirasso/scrollmemory/discussions) and [existing issues](https://github.com/issues?q=is%3Aissue+repo%3Ahirasso%2Fscrollmemory+). Maybe the feature does already exist :)
+        - ✅ Please make sure you read our [Code of Conduct](https://github.com/hirasso/restore-scroll/blob/master/CODE_OF_CONDUCT.md)
+        - ✅ Make sure to check [discussions](https://github.com/hirasso/restore-scroll/discussions) and [existing issues](https://github.com/issues?q=is%3Aissue+repo%3Ahirasso%2Frestore-scroll+). Maybe the feature does already exist :)
 
   - type: textarea
     id: describe-the-problem
@@ -46,11 +46,11 @@ body:
     attributes:
       label: Checked all these? 📚
       options:
-        - label: I have read the [usage instructions](https://github.com/hirasso/scrollmemory#usage-example)
+        - label: I have read the [usage instructions](https://github.com/hirasso/restore-scroll#usage-example)
           required: true
-        - label: I have checked [discussions](https://github.com/hirasso/scrollmemory/discussions) and [existing issues](https://github.com/issues?q=is%3Aissue+repo%3Ahirasso%2Fscrollmemory+) for related problems
+        - label: I have checked [discussions](https://github.com/hirasso/restore-scroll/discussions) and [existing issues](https://github.com/issues?q=is%3Aissue+repo%3Ahirasso%2Frestore-scroll+) for related problems
           required: true
-        - label: I agree to follow this project's [Code of Conduct](https://github.com/hirasso/scrollmemory/blob/master/CODE_OF_CONDUCT.md)
+        - label: I agree to follow this project's [Code of Conduct](https://github.com/hirasso/restore-scroll/blob/master/CODE_OF_CONDUCT.md)
           required: true
         - label: I have provided all necessary information to the best of my knowledge
           required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1 +1 @@
-scrollmemory.js.org
+restore-scroll.js.org

.github/ISSUE_TEMPLATE/feature.yml

@@ -1,38 +1,38 @@
 <p align="center">
 
-[![readme-header](https://github.com/hirasso/scrollmemory/assets/869813/978e2445-d11c-4f32-8f73-e0cf8dfdce8c)](https://scrollmemory.js.org)
+[![readme-header](https://github.com/hirasso/restore-scroll/assets/869813/978e2445-d11c-4f32-8f73-e0cf8dfdce8c)](https://restore-scroll.js.org)
 
 </p>
 
 <div align="center">
 
-[![e2e test status](https://img.shields.io/github/actions/workflow/status/hirasso/scrollmemory/e2e-tests.yml?branch=main&label=e2e%20tests)](https://github.com/hirasso/scrollmemory/actions/workflows/e2e-tests.yml)
-[![unit test status](https://img.shields.io/github/actions/workflow/status/hirasso/scrollmemory/unit-tests.yml?branch=main&label=unit%20tests)](https://github.com/hirasso/scrollmemory/actions/workflows/unit-tests.yml)
-[![weekly NPM downloads](https://img.shields.io/npm/dw/scrollmemory)](https://www.npmjs.com/package/scrollmemory)
-[![license](https://img.shields.io/github/license/hirasso/scrollmemory)](https://github.com/hirasso/scrollmemory/blob/master/LICENSE)
+[![e2e test status](https://img.shields.io/github/actions/workflow/status/hirasso/restore-scroll/e2e-tests.yml?branch=main&label=e2e%20tests)](https://github.com/hirasso/restore-scroll/actions/workflows/e2e-tests.yml)
+[![unit test status](https://img.shields.io/github/actions/workflow/status/hirasso/restore-scroll/unit-tests.yml?branch=main&label=unit%20tests)](https://github.com/hirasso/restore-scroll/actions/workflows/unit-tests.yml)
+[![weekly NPM downloads](https://img.shields.io/npm/dw/restore-scroll)](https://www.npmjs.com/package/restore-scroll)
+[![license](https://img.shields.io/github/license/hirasso/restore-scroll)](https://github.com/hirasso/restore-scroll/blob/master/LICENSE)
 
 </div>
 
 ## Demo
 
-[scrollmemory.js.org](https://scrollmemory.js.org)
+[restore-scroll.js.org](https://restore-scroll.js.org)
 
 ## Installation
 
 Install the plugin from npm and import it into your bundle:
 
 ```bash
-npm i scrollmemory
+npm i restore-scroll
 ```
 
 ```js
-import ScrollMemory from "scrollmemory";
+import restoreScroll from "restore-scroll";
 ```
 
 Or include the minified production file from a CDN:
 
 ```html
-<script src="https://unpkg.com/scrollmemory"></script>
+<script src="https://unpkg.com/restore-scroll"></script>
 ```
 
 ## Usage Example
@@ -64,29 +64,29 @@ Suppose you have the following HTML:
 This is how you would mirror the scroll position between the two `div.scroller`:
 
 ```js
-import ScrollMemory from "scrollmemory";
+import restoreScroll from "restore-scroll";
 /** Mirror all divs that match the class `.scroller` */
-new ScrollMemory(document.querySelectorAll(".scroller"));
+new restoreScroll(document.querySelectorAll(".scroller"));
 ```
 
 See also this [minimal example on CodePen](https://codepen.io/rassohilber/pen/JjxwJpo)
 
 💡 To mirror the scroll position from and to the `window`, you would have to add one of `:root`, `html` or `body` to the selector:
 
 ```js
-new ScrollMemory(document.querySelectorAll(":root, .scroller"));
+new restoreScroll(document.querySelectorAll(":root, .scroller"));
 /** or */
-new ScrollMemory(document.querySelectorAll("html, .scroller"));
+new restoreScroll(document.querySelectorAll("html, .scroller"));
 /** or */
-new ScrollMemory(document.querySelectorAll("body, .scroller"));
+new restoreScroll(document.querySelectorAll("body, .scroller"));
 ```
 
 ## Options
 
-You can pass in a few additional options to ScrollMemory as the second argument:
+You can pass in a few additional options to restoreScroll as the second argument:
 
 ```js
-new ScrollMemory(document.querySelectorAll(".scroller"), options);
+new restoreScroll(document.querySelectorAll(".scroller"), options);
 ```
 
 The type signature of the options object:
@@ -113,10 +113,10 @@ Type: `boolean`, default: `true`. Should debug messages be printed to the consol
 
 ## API
 
-To access ScrollMemory's API, you have to save a reference to the class during instaciation:
+To access restoreScroll's API, you have to save a reference to the class during instaciation:
 
 ```js
-const mirror = new ScrollMemory(document.querySelectorAll(".scroller"));
+const mirror = new restoreScroll(document.querySelectorAll(".scroller"));
 ```
 
 ### `mirror.progress`
@@ -142,7 +142,7 @@ mirror.progress = 0.5;
 Get the current progress of an element. The element doesn't _need_ to be one of the mirrored elements
 
 ```ts
-const mirror = new ScrollMemory(document.querySelectorAll(".scroller"));
+const mirror = new restoreScroll(document.querySelectorAll(".scroller"));
 // ...sometime later:
 console.log(mirror.getScrollProgress(document.querySelector(":root")));
 ```
@@ -153,6 +153,6 @@ There are already a few libraries out there that do the same thing. But all I co
 
 Also, this simple package gave me an excuse to play around with the tooling involved with creating a robust open source `npm` package:
 
-- The [demo page](https://scrollmemory.js.org) is generated using [Astro](https://astro.build) and deployed via [Netlify](https://www.netlify.com/)
+- The [demo page](https://restore-scroll.js.org) is generated using [Astro](https://astro.build) and deployed via [Netlify](https://www.netlify.com/)
 - Browser testing is being done with [PlayWright](https://playwright.dev/), using the demo site as the source for the test fixtures
 - The source code is written in [TypeScript](https://www.typescriptlang.org/)

CNAME

@@ -1,6 +1,6 @@
 {
-  "name": "scrollmemory",
-  "amdName": "ScrollMemory",
+  "name": "restore-scroll",
+  "amdName": "restore-scroll",
   "version": "0.0.0",
   "description": "Remember scroll positions of the window and elements between reloads",
   "packageManager": "pnpm@10.13.1",
@@ -11,20 +11,20 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/hirasso/scrollmemory.git"
+    "url": "https://github.com/hirasso/restore-scroll.git"
   },
   "license": "MIT",
   "type": "module",
   "source": "./src/index.ts",
-  "main": "./dist/ScrollMemory.cjs",
-  "module": "./dist/ScrollMemory.module.js",
-  "unpkg": "./dist/ScrollMemory.umd.js",
+  "main": "./dist/restore-scroll.cjs",
+  "module": "./dist/restore-scroll.module.js",
+  "unpkg": "./dist/restore-scroll.umd.js",
   "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/types/index.d.ts",
-      "import": "./dist/ScrollMemory.modern.js",
-      "require": "./dist/ScrollMemory.cjs"
+      "import": "./dist/restore-scroll.modern.js",
+      "require": "./dist/restore-scroll.cjs"
     }
   },
   "files": [
@@ -37,7 +37,7 @@
     "prepublishOnly": "pnpm run build",
     "build": "pnpm run clean && pnpm run build:module && pnpm run build:bundle",
     "build:module": "BROWSERSLIST_ENV=modern microbundle src/index.ts --format modern,esm,cjs",
-    "build:bundle": "BROWSERSLIST_ENV=production microbundle src/scrollmemory.ts --format umd --external none",
+    "build:bundle": "BROWSERSLIST_ENV=production microbundle src/index.ts --format umd --external none --define process.env.NODE_ENV=production",
     "watch": "BROWSERSLIST_ENV=development microbundle src/index.ts --watch --format modern",
     "playground:dev": "astro dev --root playground",
     "playground:build": "astro build --root playground",
@@ -65,7 +65,7 @@
   "devEngines": {
     "packageManager": {
       "name": "pnpm",
-      "onFail": "error"
+      "onFail": "warn"
     }
   }
 }

README.md

@@ -16,17 +16,6 @@ import Nav from './Nav.astro';
 		</div>
 	</section>
 
-	<Nav
-		links={[
-			{
-				href: '#top',
-				title: 'Top',
-				description: 'Scroll to the top of the page',
-				direction: 'up'
-			}
-		]}
-	/>
-
 	<section data-testid="horizontal">
 		<h2>Horizontal</h2>
 		<div
@@ -38,17 +27,6 @@ import Nav from './Nav.astro';
 		</div>
 	</section>
 
-	<Nav
-		links={[
-			{
-				href: '#top',
-				title: 'Top',
-				description: 'Scroll to the top of the page',
-				direction: 'up'
-			}
-		]}
-	/>
-
 	<section data-testid="both-axis">
 		<h2>Both axis</h2>
 		<div
@@ -60,25 +38,6 @@ import Nav from './Nav.astro';
 		</div>
 	</section>
 
-	<Nav
-		links={[
-			{
-				href: '#top',
-				title: 'Top',
-				description: 'Scroll to the top of the page',
-				direction: 'up'
-			},
-			{
-				href: '/anchors-2/',
-				title: 'Anchors 2',
-				description: 'Go to the second anchors page',
-				attributes: {
-					'data-testid': 'link-to-anchors-2-after-both-axis'
-				}
-			}
-		]}
-	/>
-
 	<section>
 		<p>
 			Lorem ipsum dolor sit amet consectetur adipisicing elit. Quod eligendi repudiandae