+
Skip to content

T99/tinyscroller

Repository files navigation

Tinyscroller

An absolutely abnormally abysmally small image scroller.

Table of Contents

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.

Copyright (C) 2022 Trevor Sears

About

An absolutely abnormally abysmally small image scroller.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载