@evermade/overflow-slider 1.0.0

package/.editorconfig

@@ -0,0 +1,22 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = tab
+insert_final_newline = true
+
+# Get rid of whitespace to avoid diffs with a bunch of EOL changes
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
+
+[{*.css,*.scss}]
+indent_size = 4

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Publish to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/.nvmrc

@@ -0,0 +1 @@
+v16.16.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Evermade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,104 @@
+# Overflow Slider
+
+This is slider library that is based on CSS overflow and progressive enhancements via JavaScript. The library is written in TypeScript but it requires no dependencies.
+
+This library is heavily inspired by [Keen Slider](https://keen-slider.io/) and provides somewhat similar programming interface but with different engine running under the hood – CSS overflow.
+
+Overflow Slider aims to be lightweight, mobile-first and accessible. It is designed to be used in modern web projects and is very customizable and extendable via plugins and CSS.
+
+## Demos
+
+* [Example and demos](https://evermade.github.io/overflow-slider/)
+
+### Usage
+
+If you’re using a bundler (such as Webpack or Rollup), you can install through npm:
+
+```bash
+npm install @evermade/oveflow-slider
+```
+
+Import the `OverflowSlider` along with plugins you want to use.
+
+```js
+import {
+	OverflowSlider,
+	DragScrollingPlugin,
+	SkipLinksPlugin,
+	ArrowsPlugin,
+	ScrollIndicatorPlugin,
+	DotsPlugin
+} from "@evermade/overflow-slider";
+
+// minimal example
+const minimalSlider = new OverflowSlider(
+	document.querySelector( '.slider-container-here' ),
+);
+
+// example with plugins
+const slider = new OverflowSlider(
+	document.querySelector( '.slider-container-here' ),
+	{
+		// options here
+	},
+	[
+		DragScrollingPlugin(),
+		ArrowsPlugin(),
+		ScrollIndicatorPlugin(),
+		DotsPlugin(),
+		SkipLinksPlugin(),
+	]
+);
+
+// note that many plugins have their own settings so you can pass them as an object
+
+const slider = new OverflowSlider(
+	document.querySelector( '.slider-container-here' ),
+	{
+		// options here
+	},
+	[
+		ArrowsPlugin({
+			texts: {
+				buttonPrevious: 'Previous',
+				buttonNext: 'Next',
+			},
+			icons: {
+				prev: '<svg>...</svg>',
+				next: '<svg>...</svg>',
+			},
+			classNames: {
+				navContainer: 'my-nav-container',
+				prevButton: 'my-prev-button',
+				nextButton: 'my-next-button',
+			},
+			container: document.querySelector( '.my-nav-container' ),
+		}),
+	]
+);
+
+```
+
+### Styles
+
+You can import base styles from the library to get started. The base styles include basic styles for the slider and some plugins.
+
+```scss
+@import "@evermade/overflow-slider/dist/overflow-slider.css";
+```
+
+You can use the CSS variables to override some values easily.
+
+Note that you can easily write styles from scratch if you want to. See source code from `src/overflow-slider.scss` for reference.
+
+## Development
+
+Install tools `npm install` and build `npm run build` or develop with `npm run watch`.
+
+Releasing new version:
+
+* Update version in `package.json`
+* Commit to master
+* Set tag with version number to git
+* Create new release in GitHub
+* NPM package is automatically published from GitHub

package/changelog.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Version 1.0.0
+
+- Initial release