diff --git a/src/components/NoticeIcon/NoticeIconTab.d.ts b/src/components/NoticeIcon/NoticeIconTab.d.ts index 5a577870e7b8cb3c83b96d3b3f79ab882cde2cfd..283c447fb70ee9e279815d90b55e4669017e9c91 100644 --- a/src/components/NoticeIcon/NoticeIconTab.d.ts +++ b/src/components/NoticeIcon/NoticeIconTab.d.ts @@ -14,6 +14,7 @@ export interface INoticeIconTabProps { emptyText?: React.ReactNode; emptyImage?: string; style?: React.CSSProperties; + hideClear?: boolean; } export default class NoticeIconTab extends React.Component {} diff --git a/src/components/NoticeIcon/NoticeList.js b/src/components/NoticeIcon/NoticeList.js index c107e2d99964f0d458d134fd3430ddedfd8589cd..d574a24bb6b6ce7ded236bb9d96c4d86453b88c6 100644 --- a/src/components/NoticeIcon/NoticeList.js +++ b/src/components/NoticeIcon/NoticeList.js @@ -11,6 +11,7 @@ export default function NoticeList({ locale, emptyText, emptyImage, + hideClear, }) { if (data.length === 0) { return ( @@ -51,10 +52,12 @@ export default function NoticeList({ ); })} -
- {locale.clear} - {title} -
+ {hideClear ? null : ( +
+ {locale.clear} + {title} +
+ )} ); } diff --git a/src/components/NoticeIcon/index.en-US.md b/src/components/NoticeIcon/index.en-US.md new file mode 100644 index 0000000000000000000000000000000000000000..ad0233d87106cefcb1767ade64e0ccccda175d28 --- /dev/null +++ b/src/components/NoticeIcon/index.en-US.md @@ -0,0 +1,43 @@ +--- +title: NoticeIcon +subtitle: Notification Menu +cols: 1 +order: 9 +--- + +用在导航工具栏上,作为整个产品统一的通知中心。 + +## API + +参数 | 说明 | 类型 | 默认值 +----|------|-----|------ +count | Total number of messages | number | - +loading | Popup card loading status | boolean | false +onClear | Click to clear button the callback | function(tabTitle) | - +onItemClick | Click on the list item's callback | function(item, tabProps) | - +onTabChange | Switching callbacks for tabs | function(tabTitle) | - +popupAlign | Popup card location configuration | Object [alignConfig](https://github.com/yiminghe/dom-align#alignconfig-object-details) | - +onPopupVisibleChange | Popup Card Showing or Hiding Callbacks | function(visible) | - +popupVisible | Popup card display state | boolean | - +locale | Default message text | Object | `{ emptyText: '暂无数据', clear: '清空' }` + +### NoticeIcon.Tab + +参数 | 说明 | 类型 | 默认值 +----|------|-----|------ +title | header for message Tab | string | - +list | List data, format refer to the following table | Array | `[]` +hideClear | Clear button display status | boolean | false +emptyText | message text when list is empty | ReactNode | - +emptyImage | image when list is empty | string | - + + +### Tab data + +参数 | 说明 | 类型 | 默认值 +----|------|-----|------ +avatar | avatar img url | string | - +title | title | ReactNode | - +description | description info | ReactNode | - +datetime | Timestamps | ReactNode | - +extra |Additional information in the upper right corner of the list item | ReactNode | - diff --git a/src/components/NoticeIcon/index.md b/src/components/NoticeIcon/index.zh-CN.md similarity index 95% rename from src/components/NoticeIcon/index.md rename to src/components/NoticeIcon/index.zh-CN.md index fefdbdcf544aac335905a040596b936ac480b0df..5777e96a7e8cbd65a10ddce5fd3f1195c217fa29 100644 --- a/src/components/NoticeIcon/index.md +++ b/src/components/NoticeIcon/index.zh-CN.md @@ -1,7 +1,5 @@ --- -title: - en-US: NoticeIcon - zh-CN: NoticeIcon +title: NoticeIcon subtitle: 通知菜单 cols: 1 order: 9 @@ -29,9 +27,11 @@ locale | 默认文案 | Object | `{ emptyText: '暂无数据', clear: '清空' } ----|------|-----|------ title | 消息分类的页签标题 | string | - list | 列表数据,格式参照下表 | Array | `[]` +hideClear | 是否显示清空按钮 | boolean | false emptyText | 针对每个 Tab 定制空数据文案 | ReactNode | - emptyImage | 针对每个 Tab 定制空数据图片 | string | - + ### Tab data 参数 | 说明 | 类型 | 默认值