Skip to content

Commit bf7f4fb

Browse files
authored
feat(watermark): add layout API (#705)
1 parent 0fb65cf commit bf7f4fb

File tree

26 files changed

+356
-50
lines changed

26 files changed

+356
-50
lines changed

db/TDesign.db

0 Bytes
Binary file not shown.

packages/products/tdesign-miniprogram/src/watermark/README.en-US.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ alpha | Number | 1 | \- | N
1212
content | String / Slot | - | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
1313
height | Number | - | \- | N
1414
is-repeat | Boolean | true | \- | N
15+
layout | String | rectangular | options: rectangular/hexagonal | N
1516
line-space | Number | 16 | \- | N
1617
movable | Boolean | false | \- | N
1718
move-interval | Number | 3000 | \- | N

packages/products/tdesign-miniprogram/src/watermark/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ alpha | Number | 1 | 水印整体透明度,取值范围 [0-1] | N
1212
content | String / Slot | - | 水印所覆盖的内容节点。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/src/common/common.ts) | N
1313
height | Number | - | 水印高度 | N
1414
is-repeat | Boolean | true | 水印是否重复出现 | N
15+
layout | String | rectangular | 水印的布局方式,rectangular:矩形,即横平竖直的水印;hexagonal:六边形,即错位的水印。可选项:rectangular/hexagonal | N
1516
line-space | Number | 16 | 行间距,只作用在多行(`content` 配置为数组)情况下 | N
1617
movable | Boolean | false | 水印是否可移动 | N
1718
move-interval | Number | 3000 | 水印发生运动位移的间隙,单位:毫秒 | N

packages/products/tdesign-miniprogram/src/watermark/props.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ const props: TdWatermarkProps = {
2424
type: Boolean,
2525
value: true,
2626
},
27+
/** 水印的布局方式,rectangular:矩形,即横平竖直的水印;hexagonal:六边形,即错位的水印 */
28+
layout: {
29+
type: String,
30+
value: 'rectangular',
31+
},
2732
/** 行间距,只作用在多行(`content` 配置为数组)情况下 */
2833
lineSpace: {
2934
type: Number,

packages/products/tdesign-miniprogram/src/watermark/type.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@ export interface TdWatermarkProps {
3535
type: BooleanConstructor;
3636
value?: boolean;
3737
};
38+
/**
39+
* 水印的布局方式,rectangular:矩形,即横平竖直的水印;hexagonal:六边形,即错位的水印
40+
* @default rectangular
41+
*/
42+
layout?: {
43+
type: StringConstructor;
44+
value?: 'rectangular' | 'hexagonal';
45+
};
3846
/**
3947
* 行间距,只作用在多行(`content` 配置为数组)情况下
4048
* @default 16

packages/products/tdesign-mobile-react/src/watermark/defaultProps.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import { TdWatermarkProps } from './type';
77
export const watermarkDefaultProps: TdWatermarkProps = {
88
alpha: 1,
99
isRepeat: true,
10+
layout: 'rectangular',
1011
lineSpace: 16,
1112
movable: false,
1213
moveInterval: 3000,

packages/products/tdesign-mobile-react/src/watermark/type.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ export interface TdWatermarkProps {
2929
* @default true
3030
*/
3131
isRepeat?: boolean;
32+
/**
33+
* 水印的布局方式,rectangular:矩形,即横平竖直的水印;hexagonal:六边形,即错位的水印
34+
* @default rectangular
35+
*/
36+
layout?: 'rectangular' | 'hexagonal';
3237
/**
3338
* 行间距,只作用在多行(`content` 配置为数组)情况下
3439
* @default 16

packages/products/tdesign-mobile-react/src/watermark/watermark.en-US.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
## API
44

5-
65
### Watermark Props
76

87
name | type | default | description | required
@@ -14,6 +13,7 @@ children | TNode | - | Typescript:`string \| TNode`。[see more ts definition]
1413
content | TNode | - | Typescript:`string \| TNode`[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
1514
height | Number | - | \- | N
1615
isRepeat | Boolean | true | \- | N
16+
layout | String | rectangular | options: rectangular/hexagonal | N
1717
lineSpace | Number | 16 | \- | N
1818
movable | Boolean | false | \- | N
1919
moveInterval | Number | 3000 | \- | N

packages/products/tdesign-mobile-react/src/watermark/watermark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
## API
44

5-
65
### Watermark Props
76

87
名称 | 类型 | 默认值 | 描述 | 必传
@@ -14,6 +13,7 @@ children | TNode | - | 水印所覆盖的内容节点,同 `content`。TS 类
1413
content | TNode | - | 水印所覆盖的内容节点。TS 类型:`string \| TNode`[通用类型定义](https://github.com/Tencent/tdesign-mobile-react/blob/develop/src/common.ts) | N
1514
height | Number | - | 水印高度 | N
1615
isRepeat | Boolean | true | 水印是否重复出现 | N
16+
layout | String | rectangular | 水印的布局方式,rectangular:矩形,即横平竖直的水印;hexagonal:六边形,即错位的水印。可选项:rectangular/hexagonal | N
1717
lineSpace | Number | 16 | 行间距,只作用在多行(`content` 配置为数组)情况下 | N
1818
movable | Boolean | false | 水印是否可移动 | N
1919
moveInterval | Number | 3000 | 水印发生运动位移的间隙,单位:毫秒 | N

packages/products/tdesign-mobile-vue/src/watermark/props.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ export default {
3030
type: Boolean,
3131
default: true,
3232
},
33+
/** 水印的布局方式,rectangular:矩形,即横平竖直的水印;hexagonal:六边形,即错位的水印 */
34+
layout: {
35+
type: String as PropType<TdWatermarkProps['layout']>,
36+
default: 'rectangular' as TdWatermarkProps['layout'],
37+
validator(val: TdWatermarkProps['layout']): boolean {
38+
if (!val) return true;
39+
return ['rectangular', 'hexagonal'].includes(val);
40+
},
41+
},
3342
/** 行间距,只作用在多行(`content` 配置为数组)情况下 */
3443
lineSpace: {
3544
type: Number,

0 commit comments

Comments
 (0)