Skip to content

Commit

Permalink
feat(watermark): support font-family configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
uyarn committed Sep 4, 2023
1 parent 20409c6 commit 67b72cb
Show file tree
Hide file tree
Showing 8 changed files with 216 additions and 3 deletions.
Binary file modified db/TDesign.db
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
:: BASE_DOC ::

## API

### Watermark Props

name | type | default | description | required
Expand Down Expand Up @@ -30,8 +29,9 @@ zIndex | Number | - | \- | N
name | type | default | description | required
-- | -- | -- | -- | --
fontColor | String | rgba(0,0,0,0.1) | \- | N
fontFamily | String | - | font-family configuration for watermark text. | N
fontSize | Number | 16 | \- | N
fontWeight | String | normal | optionsnormal/lighter/bold/bolder | N
fontWeight | String | normal | options: normal/lighter/bold/bolder | N
text | String | - | \- | N

### WatermarkImage
Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-react/src/watermark/watermark.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
:: BASE_DOC ::

## API

### Watermark Props

名称 | 类型 | 默认值 | 说明 | 必传
Expand Down Expand Up @@ -30,6 +29,7 @@ zIndex | Number | - | 水印元素的 `z-index`,默认值写在 CSS 中 | N
名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
fontColor | String | rgba(0,0,0,0.1) | 水印文本文字颜色 | N
fontFamily | String | - | 水印文本文字字体 | N
fontSize | Number | 16 | 水印文本文字大小 | N
fontWeight | String | normal | 水印文本文字粗细。可选项:normal/lighter/bold/bolder | N
text | String | - | 水印文本内容 | N
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
:: BASE_DOC ::

## API

### Watermark Props

name | type | default | description | required
-- | -- | -- | -- | --
alpha | Number | 1 | \- | N
content | String / Slot / Function | - | Typescript:`string \| TNode`[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
default | String / Slot / Function | - | Typescript:`string \| TNode`[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
height | Number | - | \- | N
isRepeat | Boolean | true | \- | N
lineSpace | Number | 16 | \- | N
movable | Boolean | false | \- | N
moveInterval | Number | 3000 | \- | N
offset | Array | - | Typescript:`Array<number>` | N
removable | Boolean | true | \- | N
rotate | Number | -22 | \- | N
watermarkContent | Object / Array | - | Typescript:`WatermarkText\|WatermarkImage\|Array<WatermarkText\|WatermarkImage>` | N
width | Number | - | \- | N
x | Number | - | \- | N
y | Number | - | \- | N
zIndex | Number | - | \- | N

### WatermarkText

name | type | default | description | required
-- | -- | -- | -- | --
fontColor | String | rgba(0,0,0,0.1) | \- | N
fontFamily | String | - | font-family configuration for watermark text. | N
fontSize | Number | 16 | \- | N
fontWeight | String | normal | options: normal/lighter/bold/bolder | N
text | String | - | \- | N

### WatermarkImage

name | type | default | description | required
-- | -- | -- | -- | --
isGrayscale | Boolean | false | \- | N
url | String | - | \- | N
41 changes: 41 additions & 0 deletions packages/products/tdesign-vue-next/src/watermark/watermark.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
:: BASE_DOC ::

## API

### Watermark Props

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
alpha | Number | 1 | 水印整体透明度,取值范围 [0-1] | N
content | String / Slot / Function | - | 水印所覆盖的内容节点。TS 类型:`string \| TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
default | String / Slot / Function | - | 水印所覆盖的内容节点,同 `content`。TS 类型:`string \| TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
height | Number | - | 水印高度 | N
isRepeat | Boolean | true | 水印是否重复出现 | N
lineSpace | Number | 16 | 行间距,只作用在多行(`content` 配置为数组)情况下 | N
movable | Boolean | false | 水印是否可移动 | N
moveInterval | Number | 3000 | 水印发生运动位移的间隙,单位:毫秒 | N
offset | Array | - | 水印在画布上绘制的水平和垂直偏移量,正常情况下水印绘制在中间位置,即 `offset = [gapX / 2, gapY / 2]`。TS 类型:`Array<number>` | N
removable | Boolean | true | 水印是否可被删除,默认会开启水印节点防删 | N
rotate | Number | -22 | 水印旋转的角度,单位 ° | N
watermarkContent | Object / Array | - | 水印内容,需要显示多行情况下可配置为数组。TS 类型:`WatermarkText\|WatermarkImage\|Array<WatermarkText\|WatermarkImage>` | N
width | Number | - | 水印宽度 | N
x | Number | - | 水印之间的水平间距 | N
y | Number | - | 水印之间的垂直间距 | N
zIndex | Number | - | 水印元素的 `z-index`,默认值写在 CSS 中 | N

### WatermarkText

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
fontColor | String | rgba(0,0,0,0.1) | 水印文本文字颜色 | N
fontFamily | String | - | 水印文本文字字体 | N
fontSize | Number | 16 | 水印文本文字大小 | N
fontWeight | String | normal | 水印文本文字粗细。可选项:normal/lighter/bold/bolder | N
text | String | - | 水印文本内容 | N

### WatermarkImage

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
isGrayscale | Boolean | false | 水印图片是否需要灰阶显示 | N
url | String | - | 水印图片源地址,为了显示清楚,建议导出 2 倍或 3 倍图 | N
41 changes: 41 additions & 0 deletions packages/products/tdesign-vue/src/watermark/watermark.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
:: BASE_DOC ::

## API

### Watermark Props

name | type | default | description | required
-- | -- | -- | -- | --
alpha | Number | 1 | \- | N
content | String / Slot / Function | - | Typescript:`string \| TNode`[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
default | String / Slot / Function | - | Typescript:`string \| TNode`[see more ts definition](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
height | Number | - | \- | N
isRepeat | Boolean | true | \- | N
lineSpace | Number | 16 | \- | N
movable | Boolean | false | \- | N
moveInterval | Number | 3000 | \- | N
offset | Array | - | Typescript:`Array<number>` | N
removable | Boolean | true | \- | N
rotate | Number | -22 | \- | N
watermarkContent | Object / Array | - | Typescript:`WatermarkText\|WatermarkImage\|Array<WatermarkText\|WatermarkImage>` | N
width | Number | - | \- | N
x | Number | - | \- | N
y | Number | - | \- | N
zIndex | Number | - | \- | N

### WatermarkText

name | type | default | description | required
-- | -- | -- | -- | --
fontColor | String | rgba(0,0,0,0.1) | \- | N
fontFamily | String | - | font-family configuration for watermark text. | N
fontSize | Number | 16 | \- | N
fontWeight | String | normal | options: normal/lighter/bold/bolder | N
text | String | - | \- | N

### WatermarkImage

name | type | default | description | required
-- | -- | -- | -- | --
isGrayscale | Boolean | false | \- | N
url | String | - | \- | N
41 changes: 41 additions & 0 deletions packages/products/tdesign-vue/src/watermark/watermark.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
:: BASE_DOC ::

## API

### Watermark Props

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
alpha | Number | 1 | 水印整体透明度,取值范围 [0-1] | N
content | String / Slot / Function | - | 水印所覆盖的内容节点。TS 类型:`string \| TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
default | String / Slot / Function | - | 水印所覆盖的内容节点,同 `content`。TS 类型:`string \| TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue/blob/develop/src/common.ts) | N
height | Number | - | 水印高度 | N
isRepeat | Boolean | true | 水印是否重复出现 | N
lineSpace | Number | 16 | 行间距,只作用在多行(`content` 配置为数组)情况下 | N
movable | Boolean | false | 水印是否可移动 | N
moveInterval | Number | 3000 | 水印发生运动位移的间隙,单位:毫秒 | N
offset | Array | - | 水印在画布上绘制的水平和垂直偏移量,正常情况下水印绘制在中间位置,即 `offset = [gapX / 2, gapY / 2]`。TS 类型:`Array<number>` | N
removable | Boolean | true | 水印是否可被删除,默认会开启水印节点防删 | N
rotate | Number | -22 | 水印旋转的角度,单位 ° | N
watermarkContent | Object / Array | - | 水印内容,需要显示多行情况下可配置为数组。TS 类型:`WatermarkText\|WatermarkImage\|Array<WatermarkText\|WatermarkImage>` | N
width | Number | - | 水印宽度 | N
x | Number | - | 水印之间的水平间距 | N
y | Number | - | 水印之间的垂直间距 | N
zIndex | Number | - | 水印元素的 `z-index`,默认值写在 CSS 中 | N

### WatermarkText

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
fontColor | String | rgba(0,0,0,0.1) | 水印文本文字颜色 | N
fontFamily | String | - | 水印文本文字字体 | N
fontSize | Number | 16 | 水印文本文字大小 | N
fontWeight | String | normal | 水印文本文字粗细。可选项:normal/lighter/bold/bolder | N
text | String | - | 水印文本内容 | N

### WatermarkImage

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
isGrayscale | Boolean | false | 水印图片是否需要灰阶显示 | N
url | String | - | 水印图片源地址,为了显示清楚,建议导出 2 倍或 3 倍图 | N
49 changes: 49 additions & 0 deletions packages/scripts/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -119025,6 +119025,55 @@
"String"
]
},
{
"id": 1693810226,
"platform_framework": [
"1",
"2",
"4",
"8",
"16",
"32",
"64"
],
"component": "WatermarkText",
"field_category": 1,
"field_name": "fontFamily",
"field_type": [
"1"
],
"field_default_value": "",
"field_enum": "",
"field_desc_zh": "水印文本文字字体",
"field_desc_en": "font-family configuration for watermark text.",
"field_required": 0,
"event_input": "",
"create_time": "2023-09-04 06:50:26",
"update_time": "2023-09-04 06:50:26",
"event_output": null,
"custom_field_type": null,
"syntactic_sugar": null,
"readonly": 1,
"html_attribute": 0,
"trigger_elements": "",
"deprecated": 0,
"version": "",
"test_description": null,
"support_default_value": 0,
"field_category_text": "Props",
"platform_framework_text": [
"Vue(PC)",
"React(PC)",
"Angular(PC)",
"Vue(Mobile)",
"React(Mobile)",
"Angular(Mobile)",
"Miniprogram"
],
"field_type_text": [
"String"
]
},
{
"id": 2598,
"platform_framework": [
Expand Down

0 comments on commit 67b72cb

Please sign in to comment.