@docuseal/signature-maker-react

中文文档
1.1.0发布于 2026/11/11MITTypeScriptESM + CJS近 30 天下载 3.9万

用于绘图、打字和上传签名的响应组件

中文使用文档
文档目录5 节
  1. 安装
  2. 使用量
  3. 活动
  4. 道具
  5. 许可证

Signature Maker

签名制作者反应

反应组件,让用户绘制,打入或上传他们的签名,并作为PNG返回. 一个薄薄的包裹围绕 签名制作者-js 网页组件.

现场演示 • 妇女 文档 • 妇女 联合来文 • 妇女 阴道

安装

npm install @docuseal/signature-maker-react
# or
yarn add @docuseal/signature-maker-react

要求反应18或19. 用于服务器侧渲染的工作.

使用量

不需要处理器: 提交按钮将签名下载为 PNG .

import { SignatureMaker } from '@docuseal/signature-maker-react'

export function App() {
  return <SignatureMaker downloadOnSave={true} />
}

用户点击时处理签名 提交 :

import { SignatureMaker } from '@docuseal/signature-maker-react'

export function App() {
  const handleSave = (detail) => {
    fetch('/save-signature', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ file: detail.base64 }),
    })
  }

  return <SignatureMaker onSave={handleSave} />
}

在没有提交按钮的情况下嵌入窗体并跟踪每个更改:

import { useState } from 'react'
import { SignatureMaker } from '@docuseal/signature-maker-react'

export function App() {
  const [signatureBase64, setSignatureBase64] = useState(null)

  const handleSubmit = (event) => {
    event.preventDefault()

    fetch('/submit-form', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ name: event.target.name.value, signature: signatureBase64 }),
    })
  }

  return (
    <form onSubmit={handleSubmit}>
      <input name="name" type="text" />
      <SignatureMaker withSubmit={false} onChange={(detail) => setSignatureBase64(detail.base64)} />
      <button type="submit">Submit</button>
    </form>
  )
}

与 CSS 类重排并翻译标签. 一个完整的 DaisyUI 例子 :

import React from 'react'
import { SignatureMaker } from '@docuseal/signature-maker-react'

export function App() {
  return (
    <div className="app">
      <SignatureMaker
        className="block my-8"
        saveButtonText="Télécharger"
        undoButtonText="Annuler"
        clearButtonText="Clair"
        drawTypeButtonText="Dessiner"
        textTypeButtonText="Type"
        uploadTypeButtonText="Télécharger"
        textInputPlaceholder="Tapez votre signature ici"
        typeButtonsContainerClass="flex gap-2 mb-4 justify-center"
        drawTypeButtonClass="flex items center justify-center py-3 w-40 uppercase border-neutral-focus space-x-2 border rounded-3xl cursor-pointer hover:bg-neutral hover:text-white hover:font-semibold"
        drawTypeButtonActiveClass="bg-neutral text-white font-semibold"
        textTypeButtonClass="flex items center justify-center py-3 w-40 uppercase border-neutral-focus space-x-2 border rounded-3xl cursor-pointer hover:bg-neutral hover:text-white hover:font-semibold"
        textTypeButtonActiveClass="bg-neutral text-white font-semibold"
        uploadTypeButtonClass="flex items center justify-center py-3 w-40 uppercase border-neutral-focus space-x-2 border rounded-3xl cursor-pointer hover:bg-neutral hover:text-white hover:font-semibold"
        uploadTypeButtonActiveClass="bg-neutral text-white font-semibold"
        textInputClass="input mb-4 input-bordered bg-white text-2xl w-full h-14 rounded-2xl"
        canvasClass="bg-white border border-base-300 rounded-2xl w-full"
        undoButtonClass="btn btn-outline btn-sm font-medium"
        clearButtonClass="btn btn-outline btn-sm font-medium"
        saveButtonClass="btn btn-neutral text-white text-base w-full"
      />
    </div>
  );
}

活动

Prop何时参数
onSave单击后提交按钮{ base64, blob }
onChange绘图、打出、上传或清除的签名{ base64, blob }两者 null 空时

ref 允许获取基本要素 enableDrawPanel(), (中文(简体) ), enableTextPanel(), (中文(简体) ), enableUploadPanel() 编辑 签名( p) 实例 pad。类型脚本声明包括:

import { useRef } from 'react'
import { SignatureMaker, type SignatureDetail, type SignatureMakerElement } from '@docuseal/signature-maker-react'

const ref = useRef<SignatureMakerElement>(null)
const handleSave = (detail: SignatureDetail) => console.log(detail.base64)

<SignatureMaker ref={ref} onSave={handleSave} />

道具

行为:

Prop默认说明
withDrawntrue显示绘图标签
withTypedtrue显示类型标签
withUploadtrue显示上传标签
withColorSelecttrue显示笔色拾取器
withSubmittrue显示提交按钮
downloadOnSavefalse在提交时下载 PNG
fontUrl舞蹈脚本用于打字签名的 WOFF 字体
className, (中文(简体) ), style适用于 <signature-maker> 元素本身

标签 : saveButtonText, (中文(简体) ), undoButtonText, (中文(简体) ), clearButtonText, (中文(简体) ), drawTypeButtonText, (中文(简体) ), textTypeButtonText, (中文(简体) ), uploadTypeButtonText, (中文(简体) ), textInputPlaceholder。 。 。 .

样式: 以下每个元素都接受 <element>Class 财务报告和审定财务报表 <element>Style (a CSS 字符串). 一个类取代了默认的内行样式,一个样式会凌驾于它们之上. 状态变体被附加在基类或样式上.

元素国家变式
saveButtonsaveButtonDisabledClass, (中文(简体) ), saveButtonsDisabledStyle
drawTypeButton, (中文(简体) ), textTypeButton, (中文(简体) ), uploadTypeButtonActiveClass, (中文(简体) ), ActiveStyle
undoButton, (中文(简体) ), clearButton, (中文(简体) ), textInput, (中文(简体) ), canvas, (中文(简体) ), typeButtonsContainer, (中文(简体) ), controlButtonsContainer

示例 drawTypeButtonClass="tab" 加号 drawTypeButtonActiveClass="tab-active" 调制 class="tab tab-active" 在选中 Draw 时 .

许可证

麻省理工学院

版本与发布记录

@docuseal/signature-maker-react 共发布 4 个版本,首次发布于 2024/09/17;过去 12 个月发布了 1 个版本。

版本发布日期距今
1.1.0latest2026/11/112 天前
1.0.22024/11/032 年前
1.0.12024/09/262 年前
1.0.02024/09/172 年前

关于 @docuseal/signature-maker-react 的常见问题

@docuseal/signature-maker-react 是什么?

用于绘图、打字和上传签名的响应组件

如何安装 @docuseal/signature-maker-react?

在项目目录运行 npm install @docuseal/signature-maker-react,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@docuseal/signature-maker-react 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@docuseal/signature-maker-react 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@docuseal/signature-maker-react 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@docuseal/signature-maker-react 可以商用吗?

@docuseal/signature-maker-react 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@docuseal/signature-maker-react 的下载量有多少?

根据 npm 官方下载统计,@docuseal/signature-maker-react 在 2026/10/13 – 2026/11/11 这 30 天内被下载 38,919 次,日均约 1,297 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@docuseal/signature-maker-react 还在维护吗?

最新版本 1.1.0 发布于 2026/11/11(2 天前);至今共发布 4 个版本,其中过去 12 个月发布了 1 个;首次发布于 2024/09/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。