# Tips

## RenderToolTip

### config
参数 | 说明 | 类型 | 默认值 | 是否必传 | 版本
---|---|---|---|---|---
text | 参数1，需要展示的内容文案 | string | 无 | 否 | 3.1.0
limit | 参数2，文案截取展示的最大字数 | number | 10 | 否 | 3.1.0
tipProps | 参数3，作用于 ToolTip 上的属性，具体参照 antd3 | object | { placement: 'top' } | 否 | 3.1.0


### 类型
```typescript
// tipProps（antd 3 antd/lib/tooltip）
interface AbstractTooltipProps {
    prefixCls?: string;
    overlayClassName?: string;
    style?: React.CSSProperties;
    className?: string;
    overlayStyle?: React.CSSProperties;
    placement?: TooltipPlacement;
    builtinPlacements?: Object;
    defaultVisible?: boolean;
    visible?: boolean;
    onVisibleChange?: (visible: boolean) => void;
    mouseEnterDelay?: number;
    mouseLeaveDelay?: number;
    transitionName?: string;
    trigger?: TooltipTrigger;
    openClassName?: string;
    arrowPointAtCenter?: boolean;
    autoAdjustOverflow?: boolean | AdjustOverflow;
    getTooltipContainer?: (triggerNode: HTMLElement) => HTMLElement;
    getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
    children?: React.ReactNode;
    align?: TooltipAlignConfig;
    /** Internal. Hide tooltip when hidden. This will be renamed in future. */
    destroyTooltipOnHide?: boolean;
}
interface TooltipPropsWithOverlay extends AbstractTooltipProps {
    title?: React.ReactNode | RenderFunction;
    overlay: React.ReactNode | RenderFunction;
}
interface TooltipPropsWithTitle extends AbstractTooltipProps {
    title: React.ReactNode | RenderFunction;
    overlay?: React.ReactNode | RenderFunction;
}
declare type TooltipProps = TooltipPropsWithTitle | TooltipPropsWithOverlay;
```

### example
```typescript
RenderToolTip('RenderToolTip测试一下')
```
```typescript
RenderToolTip('RenderToolTip测试一下', 8, { placement: 'bottom' })
```

## overstepToTooltip

### config
参数 | 说明 | 类型 | 默认值 | 是否必传 | 版本
---|---|---|---|---|---
text | 参数1，需要展示的内容文案 | string | 无 | 否 | 3.1.0
limit | 参数2，文案截取展示的最大字数 | number | 15 | 否 | 3.1.0
tipProps | 参数3，作用于 ToolTip 上的属性，具体参照 antd3 | object | { placement: 'top' } | 否 | 3.1.0


### 类型
```typescript
// tipProps（antd 3 antd/lib/tooltip）同 RenderToolTip
```

### example
```typescript
overstepToTooltip('overstepToTooltip测试一下')
```
```typescript
overstepToTooltip('overstepToTooltip测试一下', 10, { placement: 'left' })
```

## arrayOverstepToTooltip

### config
参数 | 说明 | 类型 | 默认值 | 是否必传 | 版本
---|---|---|---|---|---
arr | 参数1，需要展示的多个内容文案 | string[] | 无 | 否 | 3.1.0
limit | 参数2，数组中每个文案展示的最大字数 | number | 15 | 否 | 3.1.0
tipProps | 参数3，作用于 ToolTip 上的属性，具体参照 antd3 | object | { placement: 'top' } | 否 | 3.1.0

### 类型
```typescript
// tipProps（antd 3 antd/lib/tooltip）同 RenderToolTip
```

### example
```typescript
arrayOverstepToTooltip(['arrayOverstepToTooltip测试一下', '测试一下'])
```
```typescript
arrayOverstepToTooltip(['arrayOverstepToTooltip测试一下', '测试一下'], 10, { placement: 'left' })
```

## WrarnTips
* 注释：WrarnTips 存在命名错误，实际含义是 `WarnTips`，但由于已在多项目中应用，故不再修改

### config
参数 | 说明 | 类型 | 默认值 | 是否必传 | 版本
---|---|---|---|---|---
context | 提示文案内容 | string / number | 无 | 否 | 3.1.0
style | 组件行内样式 | object | 无 | 否 | 3.1.0
className | 组件的样式内明 | string | 无 | 否 | 3.1.0
iconColor | 提示图标颜色 | '' / 'info' / 'success' / 'warn'   'error' | '' | 否 | 3.1.0
children | - | React.Children | 无 | 否 | 3.1.0

### 类型
```typescript
type TipsType = {
    context?: string | number,
    style?: Object,
    className?: string,
    iconColor?: '' | 'info' | 'success' | 'warn' | 'error',
    [propName: string]: any
};
```

### example
```typescript
<WrarnTips>普通提示说明信息应该这样展示</WrarnTips>
```

## WrarnTips

### config
参数 | 说明 | 类型 | 默认值 | 是否必传 | 版本
---|---|---|---|---|---
context | 提示文案内容 | string / number | 无 | 否 | 3.1.0
style | 组件行内样式 | object | 无 | 否 | 3.1.0
className | 组件的样式内明 | string | 无 | 否 | 3.1.0
iconColor | 提示图标颜色 | '' / 'info' / 'success' / 'warn'   'error' | '' | 否 | 3.1.0
children | - | React.Children | 无 | 否 | 3.1.0

### 类型
```typescript
type TipsType = {
    context?: string | number,
    style?: Object,
    className?: string,
    iconColor?: '' | 'info' | 'success' | 'warn' | 'error',
    [propName: string]: any
};
```

### example
```typescript
<WrarnTips>警示信息应该这样展示</WrarnTips>
```