xverse-components-share-poster
v1.0.5
Published
xverse components share-poster
Downloads
15
Readme
API
| 参数名 | 类型 | 说明 | 默认值 | 是否必填 | 备注 | | ------------------------- | ---------------------- | ------------------------------ | ------- | ---------------- | -------------------------------------------------------------------------------- | ----- | --- | | isVerticalPoster | boolean | 是否为竖版海报 | - | false | 默认为横版,开启后会调整海报居中 | | backgroundColor | string | 组件的背景色 | - | false | - | | backgroundImg | string | 组件的背景图 | - | false | - | | posterBackgroundImg | string | 海报的背景图 | - | false | - | | posterBackgroundFillStyle | string | 海报的背景填充色 | - | false | - | | backButtonImg | string | 返回按钮 icon | - | false | - | | backButtonStyle | CSSProperties | 返回按钮的样式设置 | - | false | 修改返回按钮的位置 | | posterWidth | number | 海报的宽(px) | - | false | 尽可能小于 1024,如果超过,需要测试 ios 是否可以正常展示 | | posterHeight | number | 海报的高(px) | - | false | 尽可能小于 1024,如果超过,需要测试 ios 是否可以正常展示 | | posterRadius | number | 海报的 Radius(px) | 8 | false | - | | isShowNickName | boolean | 是否展示昵称 | true | false | 默认展示用户昵称 | | nicknameSize | number | 昵称大小 | - | false | - | | nicknameColor | string | 昵称颜色 | - | false | - | | nicknameXPos | number | 昵称 X 坐标 | - | false | - | | nicknameYPos | number | 昵称 Y 坐标 | - | false | - | | nicknameAlign | 'left' | 'center' | 'right' | 昵称文字对齐方式 | left | false | - | | extraImg | IImageConfig[] | 需要在海报背景图上方绘制的图片 | - | false | - | | extraText | ITextConfig[] | 需要在海报背景图上方绘制的文字 | - | false | - | | avatarImg | IImageConfig | 用户头像设置 | - | false | 用户头像默认图片,会被动态传入的真实头像覆盖,但是需要配置该图才会显示用户头像。 | | afterNameText | string | 昵称后面设置的文字 | - | false | - | | onBack | () => void | 点击返回的回调 | - | false | - | | onLongPress | () => void | 长按海报的回调 | - | false | - | | onClickPoster | () => void | 点击海报的回调 | - | false | - | | className | string | css 类名 | - | false | - | | posterStyle | CSSProperties | 最终生成的海报的样式设置 | - | false | - | | needShowCountDown | boolean | 是否显示倒计时 | - | false | - | | isScreenShotMode | boolean | 是否截取场景 | - | false | 为 true 的时候 posterBackgroundImg 不需要传值 | | countDownImg | string[] | 倒计时图片 | - | false | - | | saveTipsStyle | CSSProperties | 长按保存提示样式设置 | - | false | 通过样式的背景图设置了提示信息 | | onSetShareImageUrl | (url?: string) => void | 将分享图片传出 | - | false | - |