{"id":19575275,"url":"https://github.com/kevguy/deslider","last_synced_at":"2025-04-27T06:31:09.973Z","repository":{"id":58220470,"uuid":"81008402","full_name":"kevguy/Deslider","owner":"kevguy","description":"A feature-rich slideshow library","archived":false,"fork":false,"pushed_at":"2017-03-25T21:28:46.000Z","size":491,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-10T11:18:22.639Z","etag":null,"topics":["es6-javascript","javascript","library","scss","slideshow","webpack"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kevguy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-05T17:21:17.000Z","updated_at":"2017-09-08T02:21:38.000Z","dependencies_parsed_at":"2022-08-31T02:51:08.529Z","dependency_job_id":null,"html_url":"https://github.com/kevguy/Deslider","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevguy%2FDeslider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevguy%2FDeslider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevguy%2FDeslider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevguy%2FDeslider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevguy","download_url":"https://codeload.github.com/kevguy/Deslider/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223948651,"owners_count":17230132,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["es6-javascript","javascript","library","scss","slideshow","webpack"],"created_at":"2024-11-11T06:46:42.913Z","updated_at":"2024-11-11T06:46:43.705Z","avatar_url":"https://github.com/kevguy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deslider\nDeslider is a highly configurable lightweight slideshow library written with finger gesture support\n\n## Table of contents\n- [Live Demo](#live-demo)\n- [Installation](#installation)\n- [Getting started](#getting-started)\n  - [CDN](#cdn)\n  - [Bower/NPM](#bowernpm)\n- [Configuration](#configuration)\n  - [Example Options](#exmaple-options)\n\n## Live Demo\n[Codepen](http://codepen.io/kevlai22/pen/zNmZQv)\n\n## Installation\nYou may install Deslider using NPM or Bower:\n- NPM: `npm install deslider`\n- Bower: `bower install deslider`\nIf you prefer, you can include this library in your project using our officical CDN:\n- [Deslider on jsDelivr](https://www.jsdelivr.com/projects/deslider)\n\n## Getting Started\n### CDN\nAdd the necessary links to your `\u003chead\u003e` element: with a unique `id`:\n\n```html\n  \u003cscript type=\"text/javascript\" src=\"https://cdn.jsdelivr.net/deslider/1.5.1/Deslider.min.js\"\u003e\u003c/script\u003e\n  \u003clink rel=\"stylesheet\" type=\"text/css\" href=\"https://cdn.jsdelivr.net/deslider/1.5.1/style.css\"\u003e\n```\n\n### Bower/NPM\n```html\n  \u003cscript type=\"text/javascript\" src=\"INSTALLATION_DIR/lib/Deslider.min.js\"\u003e\u003c/script\u003e\n  \u003clink rel=\"stylesheet\" type=\"text/css\" href=\"INSTALLATION_DIR/css/style.css\"\u003e\n```\nAnd add a `\u003cdiv\u003e` with a unique `id`:\n\n```html\n  \u003cdiv id=\"deslider-container\"\u003e\u003c/div\u003e\n```\n\n## Configuration\nAt the end of your page you need to initialize Deslider by running the following code:\n\n```javascript\n  var myDeslider = new Deslider(imgSources, container, options);\n```\n\n* `imgSources` (*Array*): contains all the images you want to show in Deslider\n* `container` (*String*): the `id` of the container  \n* `options` (*Object*, Optional): configuration  \n * `auto` (*Object*): the existence of this object enables Deslider's automatic animation and defines its behaviors  \n   * `speed` (*Number*): the number of time(ms) for switching to another image automatically   \n   \n   * `pauseOnHover` (*Boolean*): enables/disables the animation when the mouse hovers on Deslider    \n    \n * `fullScreen` (*Boolean*): enables/disables the button that lets user toggle between full-screen mode and normal mode  \n * `swipe` (Boolean): enables/disables the feature that lets swipe the slideshow for another image  \n * `pagination` (*Boolean*): shows/hides the pagination bar  \n * `repeat` (*Boolean*): specifies if looping back to the first image after the last image in imgSources is shown \n   \n### Example Usage:\n  ```javascript\n  var imgSources = [\n    \"sample.jpg\",\n    \"https://sample_image.com/source.jpg\",\n    ...\n  ];\n  \n  var containerId = '#deslider-container';\n  \n  var options = {\n    auto: {\n      speed: 3000,\n      pauseOnHover: true,\n    },\n    fullScreen: true,\n    swipe: true,\n    pagination: true,\n    repeat: true\n  };\n  \n  var myDeslider = new Deslider(imgSources, containerId, options);\n  ```\n  \n## License\n[MIT License](https://github.com/kevguy/Deslider/blob/master/LICENSE.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevguy%2Fdeslider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevguy%2Fdeslider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevguy%2Fdeslider/lists"}