npm 包 paratissima-react-images 使用教程

在前端开发过程中，经常需要用到图片展示的功能。而 paratissima-react-images 这个 npm 包的出现，给我们带来了更加方便的图片展示功能。本文将详细介绍和使用这个 npm 包，帮助读者快速掌握其使用方法和实践。

1. 安装

使用 npm 安装 paratissima-react-images：

--- ------- ------------------------

2. 概述

paratissima-react-images 是一款基于 React 的图片展示组件，使用它可以在页面上方便的展示一组图片。该组件具备以下的特点：

  • 支持图片预加载
  • 支持缩放和拖动图片
  • 支持响应式设计

在项目中的具体使用方式也十分简单：

------ ------ - -------- - ---- --------
------ ------- ---- ---------------------------

----- ------ - -
  -
    --------- ---------------------------------
    ---------- ---------------------------------
  --
  -
    --------- ---------------------------------
    ---------- ---------------------------------
  --
  -
    --------- ---------------------------------
    ---------- ---------------------------------
    -------------- --- ---------
    ------------ ------ ----- ----- --- -------
  --
--

----- ------- - -- -- -
  ----- ----------- ------------- - ----------------
  ----- --------------- ----------------- - ------------

  ----- --------- - ------- -- -
    ------------------------
    -------------------
  --

  ----- ---------- - -- -- -
    --------------------
  --

  ------ -
    --
      ------- ----------- -- ------------------ ----- ----------
      ------- ----------- -- ------------------ ----- ----------
      --------
        ---------------
        ----------------
        --------------------------
        --------------------------
        --------------------
        ---------------------
        ----------------------
        ---------------------------
        -----------------------
        ----------------------
        ------------------------
        -------------------------
        -------------------------------------------------
        -----------------
        ----------------------
        --------------------
        --------------
        ---------------
        ---------------
        -------------------
        ----------------------
        ----------------
        ---------------------------
        -----------------
        -----------------
        ---------------------
        ----------------------
        ------------------------
        -----------
      --
    ---
  --
--

3. 属性

下面是 paratissima-react-images 支持的属性：

images

必选属性，用来指定展示的图片列表。图片列表由多个对象组成，每个对象包含以下属性：

  • original (string) – 展示的图片路径
  • thumbnail (string) – 缩略图路径
  • originalTitle (string) – 图片的标题
  • description (string) – 图片的描述

showIndex

类型：boolean，默认值：false。

如果设为 true，则在模态框中展示当前图片的序号和总数。

enableKeyboardInput

类型：boolean，默认值：true。

如果设为 false，则不能通过键盘控制图片的缩放和移动。

startIndex

类型：number，默认值：0。

从指定序号开始展示图片。

onClose

类型：function，默认值：undefined。

当用户关闭模态框时，调用此函数。

showThumbnails

类型：boolean，默认值：true。

如果设为 false，则不展示缩略图。

showPlayButton

类型：boolean，默认值：false。

如果设为 true，则在模态框中展示循环播放按钮。

showFullscreenButton

类型：boolean，默认值：false。

如果设为 true，则在模态框中展示全屏按钮。

disableSwipeDown

类型：boolean，默认值：false。

如果设为 true，则禁止向下拖动图片。

disableSwipeUp

类型：boolean，默认值：false。

如果设为 true，则禁止向上拖动图片。

disableArrowKeys

类型：boolean，默认值：false。

如果设为 true，则禁止通过方向键控制图片的缩放和移动。

disableRightClick

类型：boolean，默认值：false。

如果设为 true，则禁止通过鼠标右键控制图片的缩放和移动。

onErrorImageURL

类型：string，默认值：undefined。

如果图片无法加载，展示此 URL 下的图片。

getText

类型：function，默认值：undefined。

返回值必须是 Object 的一个子集，在模态框中展示。

tileViewportStyle

类型：Object，默认值：{}。

在模态框中展示的每个图片的 Viewport 样式。

tileDisplayDelay

类型：number，默认值：0。

展示之前的延迟时间 (以毫秒为单位)。

zoomStep

类型：number，默认值：0.2。

每次滚轮或触控缩放时缩放的乘数。

zoomSpeed

类型：number，默认值：300。

缩放速度 (以毫秒为单位)。

moveSpeed

类型：number，默认值：300。

移动速度 (以毫秒为单位)。

rotationSpeed

类型：number，默认值：300。

旋转速度 (以毫秒为单位)。

viewMode

类型：string，默认值：fit-contain。

展示模式：contain，cover 或 fit-contain 中的一种。

  • contain ：图片应缩小到适合视口的大小。
  • cover ：图片应扩大到覆盖视口。
  • fit-contain ：如果图片小于视口，请缩放它以适应视口并使其保持比例。如果图片大于视口，请缩小它以适应视口并使其保持比例。

imageMargin

类型：number，默认值：10。

图像之间的间距（以像素为单位）。

backdropClosesModal

类型：boolean，默认值：false。

如果设为 true，则点击模态框背景将关闭模态框。

maxSpreadZoom

类型：number，默认值：2。

最大缩放级别。

minSpreadZoom

类型：number，默认值：1。

最小缩放级别。

preventScroll

类型：boolean，默认值：false。

如果设为 true，则防止滚动行为。

containerWidth

类型：string，默认值："100%"。

容器宽度。

containerHeight

类型：string，默认值："100%"。

容器高度。

id

类型：string，默认值：undefined。

自定义 id。

4. 示例代码

下面我们来看一下 paratissima-react-images 的运行示例：

------ ------ - -------- - ---- --------
------ ------- ---- ---------------------------

----- ------ - -
  -
    --------- -----------------------------------------
    ---------- -----------------------------------------
    -------------- ------ ---
    ------------ ------ ----- ----- --- ----- ----------- ---------- -------
  --
  -
    --------- -----------------------------------------
    ---------- -----------------------------------------
    -------------- ------ ---
    ------------ -------- --------- ------- ------ --- -------- ----- ------------ -----
  --
  -
    --------- -----------------------------------------
    ---------- -----------------------------------------
    -------------- ------ ---
    ------------ -------- ----- ------ ----- --- --------- -- ------ -- -------- ---- --------- -----
  --
  -
    --------- -----------------------------------------
    ---------- -----------------------------------------
    -------------- ------ ---
    ------------ ------------- --- ----- --- -- ------- ------------
  --
  -
    --------- -----------------------------------------
    ---------- -----------------------------------------
    -------------- ------ ---
    ------------ ------- -------- ----- --- --- ---- -------- --- --------- -------
  --
--

----- ------- - -- -- -
  ----- ----------- ------------- - ----------------
  ----- --------------- ----------------- - ------------

  ----- --------- - ------- -- -
    ------------------------
    -------------------
  --

  ----- ---------- - -- -- -
    --------------------
  --

  ----- ------- - -- ------------- ------ -- -- -
    ------ -
      --------------- - --- --
      ----------- --------------- - ----- --- --------------------
      ---------------- ---------
      ---------------- ---------
      ----------------- ------------
      ------------------ -------------
      ------------------- --------------
      -------------------- ----------------
    --
  --

  ------ -
    --
      ------- ----------- -- ------------------ ----- ----------
      ------- ----------- -- ------------------ ----- ----------
      ------- ----------- -- ------------------ ----- ----------
      ------- ----------- -- ------------------ ----- ----------
      ------- ----------- -- ------------------ ----- ----------

      --------
        ---------------
        ----------------
        --------------------------
        --------------------------
        --------------------
        ---------------------
        ----------------------
        ---------------------------
        -----------------------
        ----------------------
        ------------------------
        -------------------------
        -------------------------------------------------
        -----------------
        --------------------
          ----------- ---- --- -------------
          ------------ ------
          ------------ ----------
        --
        --------------------
        --------------
        ----

------------------------------------------------------------------------------ ----------
-----------------------------------------------------------------------------------------------------------------------------
阅读全文

猜你喜欢

  • npm 包 `kwik` 使用教程

    如果你是一名前端工程师，你肯定会经常用到 npm 包来加速你的开发工作。其中一个非常实用的 npm 包就是 kwik，它是一个轻量级的 JavaScript 工具库，能够帮助开发者更快地编写 Java...

    2 年前
  • npm 包 wepy-com-charts 使用教程

    前言 wepy-com-charts 是一款基于 echarts 封装的 wepy 框架组件库，旨在为开发者提供一种轻松的方式在 wepy 项目中使用现代化的图表库。

    2 年前
  • npm 包 js-keyboard 使用教程

    随着前端技术的不断发展，前端工程师们在日常开发中需要频繁使用键盘输入，而 js-keyboard 是一款强大的 npm 包，可以帮助前端工程师更加便捷地管理键盘输入。

    2 年前
  • npm 包 generator-spring-rest-jwt 使用教程

    本教程介绍了如何使用 npm 包 generator-spring-rest-jwt 来生成一个基于 Spring 的 RESTful API 服务，并添加 JWT 身份验证功能。

    2 年前
  • npm 包 matricss-rules 使用教程

    在前端开发中，我们经常需要编写 CSS 来实现页面样式。CSS 的编写有时会非常繁琐，这时候我们可以使用 matricss-rules 来简化代码，提高效率。本文将介绍 npm 包 matricss-...

    2 年前
  • npm 包 slack_builder 使用教程

    前言 近年来，Slack 频繁地被企业和团队所使用。而在 Slack 中，我们经常需要使用交流及通知功能，给团队带来不小的便利。由此，也引出了 Slack Bot 的概念，Slack Bot 可以通过...

    2 年前
  • npm 包 @told/tiled-map 使用教程

    前言 在前端开发中，有许多开发者都有过制作游戏或需要使用地图的经历。针对这种需求，有一款 npm 包叫做 "@told/tiled-map"，它可以帮助我们轻松制作地图，提高开发效率。

    2 年前
  • npm 包 trezor-verify 使用教程

    在前端开发中，数据安全性是至关重要的一部分。Trezor 是一款硬件钱包，能够保护您的加密货币资产。而 trezor-verify 是一款基于 Trezor 硬件钱包的 npm 包，大大提高了前端钱包...

    2 年前
  • npm 包 Static Component Webpack Plugin 使用教程

    前言 在前端开发中，我们经常会需要将一些组件或者页面缓存起来，以达到更好的性能和用户体验。在这样的场景下，我们可以使用 Static Component Webpack Plugin 来帮助我们更轻松...

    2 年前
  • npm 包 3y2y 使用教程

    3y2y 是一个轻量级的前端工具库，可以帮助我们快速实现一些常见的前端功能。在这篇文章中，我将介绍 3y2y 的基本使用方法，以及示例代码和建议的用例。 安装 3y2y 首先，我们需要使用 npm 来...

    2 年前
  • npm包：airconsole-typescript的使用教程

    在这个前端技术充满竞争的时代，如何快速的构建高质量的游戏是很多开发者所需要解决的一个问题。而在游戏开发中，使用airconsole-typescript这个npm包可以帮助我们快速的构建出高质量的游戏...

    2 年前
  • npm包@never.no/story-api使用教程

    什么是@never.no/story-api? @never.no/story-api是一个可以帮助前端开发者快速创建交互式故事的npm包。它提供了许多有用的功能，包括故事创建、互动元素添加等。

    2 年前
  • npm 包 css-into-js 使用教程

    前言 随着 React 等前端框架的普及，CSS-in-JS 的技术也越来越受到关注。CSS-in-JS 可以将 CSS 和 JS 合并到一起，使用 JS 来管理样式，避免了传统 CSS 的一些问题，...

    2 年前
  • npm 包 add-to-cart-component 使用教程

    在现代的电商网站中，购物车是一个非常重要的组件。而在前端开发中，我们可以通过 NPM 上的一些包来快速实现购物车的功能。其中，add-to-cart-component 就是一个非常实用的购物车组件，...

    2 年前
  • npm 包 leetscript 使用教程

    近年来，JavaScript 一直在快速发展。前端开发工作中使用的一些库和框架以及技术日新月异，前端开发者需要持续地学习和跟进新技术的变化。其中一个工具就是 npm，npm 包是 JavaScript...

    2 年前
  • npm 包 pt-react-tree 使用教程

    随着 web 应用越来越复杂、业务逻辑越来越复杂，前端的开发工作也变得越来越重要。在前端开发过程中，我们需要使用各种工具和技术来快速、高效地开发 web 应用。 npm 是一个非常流行的 Node.j...

    2 年前
  • NPM 包 mimix 使用教程

    简介 mimix 是一款能够混合对象和数组的 npm 包，可以将多个对象和数组合并到一起，且不影响原始数据。它非常适用于开发过程中需要对数据进行组合处理的场景。 安装 使用 npm 可以很方便地安装 ...

    2 年前
  • npm 包 leetscript-cli 使用教程

    在前端领域中，有许多 npm 包可以帮助我们提高开发效率。leetscript-cli 就是一个让开发者能够轻松使用 leetspeak 的工具。本文将详细介绍 leetscript-cli 的使用方...

    2 年前
  • npm 包 aws-sdk-on-lambda 使用教程

    在 AWS Lambda 中使用 AWS SDK 可以非常便捷地操作 AWS 各种服务，我们也可以在本地 Node.js 项目中使用 AWS SDK，而 npm 包 aws-sdk-on-lambda...

    2 年前
  • NPM 包 Bing-translator 使用教程

    简介 Bing-translator 是一款基于微软翻译 API 的 NPM 包，可以用来进行多语言翻译。该包支持 50 多种语言的翻译，并且支持自动检测源语言和目标语言，可以极大地提高开发效率。

    2 年前

相关推荐

    暂无文章