Skip to content

Commit

Permalink
docs(watermark): 完善文档
Browse files Browse the repository at this point in the history
  • Loading branch information
wangxingkang committed Nov 4, 2020
1 parent 5697f3a commit 0045868
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 9 deletions.
1 change: 0 additions & 1 deletion packages/watermark/demos/demo-01.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import React from 'react';
import { Button } from 'antd';
// @ts-ignore
import Watermark from '@pansy/react-watermark';

export default () => {
Expand Down
1 change: 0 additions & 1 deletion packages/watermark/demos/demo-04.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import React, { useState } from 'react';
import { Button } from 'antd';
// @ts-ignore
import Watermark from '@pansy/react-watermark';

export default () => {
Expand Down
1 change: 0 additions & 1 deletion packages/watermark/demos/demo-05.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import React from 'react';
// @ts-ignore
import Watermark from '@pansy/react-watermark';

export default () => {
Expand Down
1 change: 0 additions & 1 deletion packages/watermark/demos/demo-06.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import React from 'react';
// @ts-ignore
import Watermark from '@pansy/react-watermark';

export default () => {
Expand Down
24 changes: 24 additions & 0 deletions packages/watermark/demos/demo-07.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* title: 错行展示
* desc: 设置 mode = 'interval' 开启
*/
import React, { useState } from 'react';
import { Button } from 'antd';
import Watermark from '@pansy/react-watermark';
import { WatermarkComponentProps } from '@pansy/react-watermark/es';

export default () => {
const [mode, setMode] = useState<WatermarkComponentProps['mode']>('interval');

return (
<div style={{ position: 'relative', width: '100%', height: 500 }}>
<Watermark text="测试水印" width={211} height={211} mode={mode} />

<Button
onClick={() => { mode === 'interval' ? setMode('repeat') : setMode('interval') }}
>
{mode === 'interval' ? '重复' : '间隔'}
</Button>
</div>
)
}
14 changes: 9 additions & 5 deletions packages/watermark/docs/watermark.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ group:

<code src="../demos/demo-06.tsx" background="#f0f2f5" />

### 错行展示

<code src="../demos/demo-07.tsx" background="#f0f2f5" />

### 定制样式

<code src="../demos/demo-02.tsx" background="#f0f2f5" />
Expand All @@ -48,12 +52,12 @@ group:

| 参数 | 说明 | 类型 | 默认值 | 版本 |
| ------------ | --------------| ------------------- | ------ | ---- |
| zIndex | 水印层级 | `number` | `9999` | 1.0.2 |
| monitor | 监听水印元素是否被篡改,被修改或者删除等操作,则重新渲染水印 | `boolean` | `true` | -- |
| mode | 渲染模式 | `interval` \| `repeat` | `interval` | `2.1.0` |
| monitor | 监听水印元素是否被篡改,被修改或者删除等操作,则重新渲染水印 | `boolean` | `true` | -- |
| text | 水印文本 | `string` \| `string[]` | -- | -- |
| options | 水印配置 | `object` | `{...}` | -- |
| width | 单个水印区域宽度 | `number` | `160` | -- |
| height | 单个水印区域高度 | `number` | `80` | -- |
| zIndex | 水印层级 | `number` | `9999` | `1.0.2` |
| width | 单个水印区域宽度 | `number` | `320` | -- |
| height | 单个水印区域高度 | `number` | `160` | -- |
| opacity | 透明度 | `number` | `0.2` | -- |
| rotate | 旋转的角度 | `number` | `20` | -- |
| fontSize | 字体大小 | `number` | `14` | -- |
Expand Down

1 comment on commit 0045868

@vercel
Copy link

@vercel vercel bot commented on 0045868 Nov 4, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.