Canvas

画布

<Canvas /> 组件的 RN 版本尚未实现。

支持情况：

参考文档

类型

ComponentType<CanvasProps>

示例代码

React

class App extends Components {
  render () {
    // 如果是支付宝小程序，则要加上 id 属性，值和canvasId一致
    return (
      <Canvas style='width: 300px; height: 200px;' canvasId='canvas' />
    )
  }
}

Vue

<template>
  <!-- 如果是支付宝小程序，则要加上 id 属性，值和canvasId一致 -->
  <canvas style="width: 300px; height: 200px;" canvas-id="canvas" />
</template>

CanvasProps

参数	类型	默认值	必填	说明
type	string		否	指定 canvas 类型，支持 2d 和 webgl
canvasId	string		否	canvas 组件的唯一标识符，若指定了 type 则无需再指定该属性
disableScroll	boolean	false	否	当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新
id	string		否	组件唯一标识符。 注意：同一页面中的 id 不可重复。
width	string		否
height	string		否
nativeProps	Record<string, unknown>		否	用于透传 WebComponents 上的属性到内部 H5 标签上
onTouchStart	CanvasTouchEventFunction		否	手指触摸动作开始
onTouchMove	CanvasTouchEventFunction		否	手指触摸后移动
onTouchEnd	CanvasTouchEventFunction		否	手指触摸动作结束
onTouchCancel	CanvasTouchEventFunction		否	手指触摸动作被打断，如来电提醒，弹窗
onLongTap	CommonEventFunction		否	手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动
onError	CommonEventFunction<onErrorEventDetail>		否	当发生错误时触发 error 事件，detail = {errMsg: 'something wrong'}
onTap	CommonEventFunction		否	点击。
onReady	CommonEventFunction		否	canvas 组件初始化成功触发。

API 支持度

API	微信小程序	百度小程序	支付宝小程序	抖音小程序	QQ 小程序	京东小程序	H5	React Native	Harmony	Harmony hybrid	ASCF元服务
CanvasProps.type	✔️		✔️	✔️							✔️
CanvasProps.canvasId	✔️	✔️		✔️	✔️	✔️	✔️			✔️	✔️
CanvasProps.disableScroll	✔️	✔️	✔️		✔️	✔️					✔️
CanvasProps.id			✔️				✔️			✔️
CanvasProps.width			✔️				✔️			✔️
CanvasProps.height			✔️				✔️			✔️
CanvasProps.nativeProps							✔️			✔️
CanvasProps.onTouchStart	✔️	✔️	✔️	✔️	✔️	✔️	✔️			✔️	✔️
CanvasProps.onTouchMove	✔️	✔️	✔️	✔️	✔️	✔️	✔️			✔️	✔️
CanvasProps.onTouchEnd	✔️	✔️	✔️	✔️	✔️	✔️	✔️			✔️	✔️
CanvasProps.onTouchCancel	✔️	✔️	✔️	✔️	✔️	✔️	✔️			✔️	✔️
CanvasProps.onLongTap	✔️	✔️	✔️		✔️	✔️	✔️			✔️	✔️
CanvasProps.onError	✔️	✔️			✔️	✔️					✔️
CanvasProps.onTap			✔️
CanvasProps.onReady			✔️

onErrorEventDetail

参数	类型
errMsg	string