Shuffle.js 技术文档

2024-12-24 15:02:54作者：秋阔奎Evelyn

1. 安装指南

使用 npm 安装

npm install shufflejs

使用 CDN

<script src="https://unpkg.com/shufflejs/dist/shuffle.min.js"></script>

2. 项目的使用说明

基本用法

Shuffle.js 是一个用于分类、排序和过滤响应式网格项目的 JavaScript 库。它可以帮助你轻松地创建一个动态的网格布局，支持响应式设计和多种交互方式。

示例代码

以下是一个基本的示例，展示了如何使用 Shuffle.js 创建一个响应式网格布局：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Shuffle.js 示例</title>
    <style>
        .grid {
            position: relative;
            overflow: hidden;
        }
        .grid-item {
            width: 25%;
            padding: 10px;
            box-sizing: border-box;
        }
        .grid-item img {
            width: 100%;
            display: block;
        }
    </style>
</head>
<body>
    <div id="grid" class="grid">
        <div class="grid-item js-item">
            <img src="image1.jpg" alt="Image 1">
        </div>
        <div class="grid-item js-item">
            <img src="image2.jpg" alt="Image 2">
        </div>
        <div class="grid-item js-item">
            <img src="image3.jpg" alt="Image 3">
        </div>
        <!-- 更多网格项 -->
    </div>

    <script src="https://unpkg.com/shufflejs/dist/shuffle.min.js"></script>
    <script>
        const shuffleInstance = new Shuffle(document.getElementById('grid'), {
            itemSelector: '.js-item',
            sizer: '.js-shuffle-sizer',
        });
    </script>
</body>
</html>

关键配置项

itemSelector: 指定网格项的选择器。
sizer: 指定一个元素作为网格布局的尺寸参考。

3. 项目API使用文档

初始化

const shuffleInstance = new Shuffle(element, options);

element: 容器元素，通常是一个 div。
options: 配置对象，包含以下可选参数：
- itemSelector: 网格项的选择器，默认为 '.shuffle-item'。
- sizer: 尺寸参考元素的选择器，默认为 null。
- speed: 动画速度，默认为 250。
- easing: 动画缓动效果，默认为 'cubic-bezier(0.4, 0.0, 0.2, 1)'。

方法

shuffleInstance.filter(category): 根据类别过滤网格项。
shuffleInstance.sort(options): 根据指定规则对网格项进行排序。
shuffleInstance.update(): 更新网格布局。
shuffleInstance.add(elements): 添加新的网格项。
shuffleInstance.remove(elements): 移除指定的网格项。

事件

shuffle:layout: 当网格布局更新时触发。
shuffle:filtered: 当网格项被过滤时触发。
shuffle:sort: 当网格项被排序时触发。

4. 项目安装方式

通过 npm 安装

npm install shufflejs

通过 CDN 引入

<script src="https://unpkg.com/shufflejs/dist/shuffle.min.js"></script>

手动下载

你可以从 GitHub 仓库下载源码，并将其引入到你的项目中。

<script src="/path/to/shuffle.min.js"></script>

通过以上步骤，你可以轻松地将 Shuffle.js 集成到你的项目中，并利用其强大的功能来创建动态的响应式网格布局。

登录后查看全文