https://github.com/nathan-degraaf/slide.js

A simple but powerful slider.
https://github.com/nathan-degraaf/slide.js

Last synced: about 2 months ago
JSON representation

A simple but powerful slider.

• Host: GitHub
• URL: https://github.com/nathan-degraaf/slide.js
• Owner: Nathan-deGraaf
• License: mit
• Created: 2024-05-28T21:57:34.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-28T23:10:29.000Z (8 months ago)
• Last Synced: 2024-05-29T13:48:27.454Z (8 months ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# slide.js

slide.js is a simple and customizable slider/carousel library for JavaScript.

## Features

- Easy to use

- Customizable

- Supports autoplay

- Pagination

- Responsive design

## Installation

You can install slide.js via npm:

```sh

npm install slide.js

```

## Usage

Include the slide.js CSS and JavaScript files in your project.

```sh

  


    
Slide 1

    
Slide 2

    
Slide 3

  

```


## JavaScript

The JavaScript file is automatically initialized on DOMContentLoaded, so you don't need to call any initialization function.

## Settings

You can customize the behavior of the slider using data attributes on the .slider element. Here are the available options:

| Option              | Type    | Default | Description                       |

|---------------------|---------|---------|-----------------------------------|

| data-autoplay       | boolean | false   | Enables or disables autoplay      |

| data-autoplay-speed | integer | 3000    | Speed of autoplay in milliseconds |

| data-paginate       | boolean | true    | Enables or disables pagination    |

This README provides clear and concise information on how to use and configure `slide.js`. If you have any additional changes or features to include, feel free to let me know!