Gallery
一个使用JS编写的图片库
使用方法
- 在HTML中引入gallery.min.js和gallery.min.css(压缩文件已使用babel编译成es5语法)
或者
npm install j-gallery --save-dev
ES5
var Gallery = Gallery
ES6
- 定义一个根图片容器,并指定类名、宽度(宽度支持百分比)
- 新建一个Gallery的实例,并传入容器的类名
const gallery =
- 初始化类库,并传入初始化配置
gallery
- 第一个参数为一个图片地址字符串或者图片地址字符串数组,可以传入一个或多个图片
- 第二个参数为对象,用于初始化配置
配置项 | 说明 | 可选项 | 含义 | 默认值 |
---|---|---|---|---|
layout | 布局类型 | 1 2 3 |
拼图布局 瀑布布局 木桶布局 |
2 |
fullScreen | 图片点击预览 | true false |
打开 关闭 |
false |
gutter | 图片间距 | {x: number, y: number} | x:横向间距 y:纵向间距 |
{x: 10, y: 10} |
waterfallColumn | 瀑布布局列数 | 正整数 | 瀑布布局列数 | 4 |
barrelHeight | 木桶布局最小高度 | 正整数 | 最小高度 | 200 |
API
/** * 添加图片 * @param * @param */gallery /** * 移除相册中的图片 * @param * @return */gallery /** * 设置相册的布局 * @param */gallery /** * 获取相册的布局 * @return */gallery /** * 获取相册所有图像对应的 DOM 元素 * @return */gallery /** * 设置拼图布局容器高度 * @param * @returns */gallery /** * 设置图片之间的间距 * @param * @param * @return */gallery /** * 设置瀑布流列数 * @param * @return */gallery /** * 允许点击图片时全屏浏览图片 */gallery /** * 禁止点击图片时全屏浏览图片 */gallery /** * 获取点击图片时全屏浏览图片是否被允许 * @return */gallery /** * 设置木桶模式每行高度的上下限,单位像素 * @param */gallery /** * 获取木桶模式每行高度的下限 * @return */gallery