Tinyscroller NPM

Tinyscroller

An absolutely abnormally abysmally small image scroller.

Find tinyscroller on NPM.

Installation

Install from NPM with

$ npm install --save tinyscroller

Basic Usage

A new Tinyscroller instance can be initialized using the new Tinyscroller(target) constructor:

// By using a CSS selector:
let tinyscroller = new Tinyscroller(".container > div");

// Or by using a pre-fetched DOM node:
let element = document.getElementById("my-tinyscroller-container");
let tinyscroller = new Tinyscroller(element);

Tinyscroller comes with a couple of basic options for customization using the new Tinyscroller(target, options) constructor:

let tinyscroller = new Tinyscroller(target, {
	orientation: "horizontal",
	fit: "cover",
	progress: true,
	arrows: false,
});

Option	Type	Default	Description
`orientation`	`"vertical" \\| "horizontal"`	`"horizontal"`	The axis along which images are displayed in this scroller.
`fit`	`"contain" \\| "cover" \\| "fill"`	`"cover"`	The method by which images fill their containers if their aspect ratio does not match the container size.
`progress`	`boolean`	`true`	Whether or not progress dots should be overlayed on top of the slider.
`arrows`	`boolean`	`true`	Whether or not next/last navigation arrows should be overlayed on top of the slider.

Example

License

tinyscroller is made available under the GNU General Public License v3.

slider scroller carousel

@infinitebrahmanuniverse/nolb-tinys @everything-registry/sub-chunk-2950

0.2.1

2 years ago

0.1.0