awesome-slider v1.2.0

awesome-slider

a vanilla javascript slider/carousel/swiper plugin.

Demo

Demo 合集 🚀

如果在框架中使用, 比如react, 需要在组件unmount时, 移除所有相关监听事件. 示例:

awesome-slider in react

installing

Using yarn

yarn add awesome-slider

Using npm

npm install awesome-slider

Using cdn

<script src="https://unpkg.com/awesome-slider/dist/awesome-slider.min.js"></script>

Example

const AwesomeSlider = require("awesome-slider");
// or
import AwesomeSlider from "awesome-slider";

const awesomeSlider = new AwesomeSlider(images, container, [options]);

API

images

• Type : Array<String | Object>
• Default: undefined
• Usage

可以是简单模式

["./images/1.jpg", "./images/2.jpg", "./images/3.jpg", "./images/4.jpg"];

也可以自由组合

[
  {
    tagName: "a",
    attrs: {
      style: "",
      class: "",
      href: "https://wwww.example.com"
    },
    children: [
    "this just textNote, not object",
    {
      tagName: "div",
      attrs: {
      style:""
    },
  },
  "./images/example.jpg"
]

container

• Type : Object
• Default: undefined
• Usage

包裹 images 的 html 元素

var container = document.querySelector(".container"); 👈

// react
...
const containerRef = useRef(null);
...
const container = containerRef.current; 👈
...
<div className="container" ref={containerRef}>

options

ratio

• Type : Number
• Default: 1180 / 500
• Usage

宽高比

duration

• Type : Number
• Default: 1000 * 0.5
• Usage

轮播动画过渡的时长(ms)

autoplay

• Type : Boolean
• Default: true
• Usage

是否开启自动轮播

interval

• Type : Number
• Default: 1000 * 5
• Usage

自动轮播的间隔时长(ms)

indicator

• Type : {style: Function, active: Function}
• Default: indicator
• Usage

轮播状态的指示 js创建html, 通过有传递的参数做样式交互, 如果要使用this, 就不要使用箭头函数, 一般现有传递的参数够用

const style = ({ listWrap, realLen, initIndex }) => {};

const style = ({ current }) => {};

const indicator = {
  style,
  active
};

initIndex

• Type : number
• Default: 0
• Usage

初始展示的图片的序号

manual

• Type : {previous: Object, next: Object}
• Default: null
• Usage

js创建html, 插入两部分, 分别是previous和next

timing

• Type : String | Function
• Default: linear
• Usage

轮播动画类型

enableResize

• Type : Boolean
• Default: false
• Usage

是否开启窗口大小变化的监听

tip:如果container的大小是随窗口改变自适应的, 建议开启, 可以自动调整轮播图到正确位置

imageDownloading

• Type : Object
• Default: null
• Usage

js创建html, 插入图片加载的效果

imagePlaceholder

• Type : Object
• Default: null
• Usage

js创建html, 插入图片加载失败的占位

utils

内置的几个方法, 因为对自身不影响, 可以作为工具函数为外部所用

const AwesomeSlider = require("awesome-slider");
const { element, debounce, animate, translate } = AwesomeSlider.prototype.utils;

Note

使用了requestAnimationFrame, 如果要向低浏览器兼容, 可以自行引入requestAnimationFrame polyfill 比如yarn add raf