Skip to content

OPTIONS

ViewportProps

属性说明类型默认值
size视口尺寸number300
width视口宽度(覆盖sizenumber-
height视口高度(覆盖sizenumber-
info图片信息{ file: File, width: number, height: number }-
viewSize观察窗口大小number180
grid是否为网格背景booleanfalse
scaleStep缩放步长,单位pxnumber10
ctrlScaleStepCtrl键缩放步长,单位px(0时禁用)number5
shiftScaleStepShift键缩放步长,单位px(0时禁用)number1
wheelReverse滚轮反向booleanfalse
fixedImage图片固定模式booleanfalse
minViewSize最小观察窗口尺寸number10
imagePadding图片边距number10
directionKey方向键移动booleantrue
wasdKeyWASD键移动booleantrue
forceDoubleLayer强制使用双层DOM(图片固定模式下建议开启)booleanfalse

PreviewProps

属性说明类型默认值
size预览窗口尺寸number180
viewportRef关联的视口组件实例InstanceType<typeof Viewport>-
round是否显示圆形预览booleanfalse
bg预览区域背景色string-

ImageSelectOptions

属性说明类型默认值
accept允许的文件类型(参考 input 的 accept 属性)stringimage/*
maxFileSize最大文件大小(单位:字节)number2097152 (2MB)
minSize图片最小尺寸(宽高任一小于该值时抛出错误)number-
maxSize图片最大尺寸(宽高任一超过该值时缩放或抛错)number5000
resizeToMax超过最大尺寸时是否等比例缩放到最大尺寸booleanfalse
compress压缩策略:
- true:全部压缩
- number:文件大于该值时压缩
boolean|numberfalse
quality压缩质量(0-1)number0.8
minVectorSize矢量图最小尺寸(当获取的矢量图的Math.min(width, height)小于这个值时将其放大到这个尺寸)number1024

CropperOptions

属性说明类型默认值
format输出数据格式'file'|'base64''file'
size输出图片尺寸(优先于 maxSize)number-
maxSize最大输出尺寸(超过时等比例缩放)number-
useOriginSize当截取尺寸小于输出尺寸时使用原尺寸booleantrue
type输出图片类型string'image/png'
quality输出质量(0-1)number1
filename输出文件名(仅 file 格式有效)string原文件名
backgroundColorJPEG 格式的填充背景色string'#ffffff'