npm 包 react-cropper 使用教程

阅读时长 4 分钟读完

前言

React Cropper 是一个基于 React 的图片裁剪组件,使用非常简单、易于上手。本文将提供 react-cropper 的使用教程,详细介绍如何使用该 npm 包进行图片裁剪。

安装

安装 react-cropper 可以使用 npm 或 yarn:

使用

引入组件

首先,需要引入组件并创建一个图片容器,代码如下:

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

上述代码中,使用 import 引入 react-cropper 组件,并使用 useRef 创建一个 cropperRef 的引用,供后续使用。在 render 函数中,使用 Cropper 组件创建一个图片容器,其中 src 表示图片源,style 表示图片容器大小,initialAspectRatio 表示初始比例,guides 表示是否显示裁剪框的辅助线,在裁剪结束时调用 crop 函数获取裁剪结果,而 ref={cropperRef} 用于将引用存储到 cropperRef 中。

使用 Cropper 实例

根据上述代码,在裁剪结束时会调用 crop 函数。在该函数内部,使用 getCroppedCanvas 函数获取裁剪后的图像数据,将其转换为 Base64 编码格式并输出到控制台,代码如下:

现在,执行程序并进行裁剪即可看到输出到控制台的图像数据了。

Cropper 的 Props

Cropper 组件提供了下列 Props:

src

  • 类型:string 或 object

  • 必填:是

  • 说明:要裁剪的图片源,可以传入图片地址或图片对象。

style

  • 类型:object

  • 必填:否

  • 说明:Cropper 组件的样式。

initialAspectRatio

  • 类型:number

  • 必填:否

  • 说明:初始裁剪框的长宽比例。

guides

  • 类型:boolean

  • 必填:否

  • 说明:是否显示裁剪框的辅助线。

crop

  • 类型:function

  • 必填:否

  • 说明:裁剪结束后的回调函数。

ref

  • 类型:function

  • 必填:否

  • 说明:存储 Cropper 实例的引用。

示例代码

下面是一个简单的示例代码,以帮助您快速上手使用 react-cropper:

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

结论

以上就是 React Cropper 组件的使用教程。随着互联网的发展,图片裁剪已成为许多开发者经常使用的功能,而 React Cropper 的简单易用性可以帮助您快速实现此功能。希望您能在本文中学到新知识,并能够成功使用 react-cropper 组件。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/the-react-cropper