generated from arvinxx/npm-template
-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
order: 1 | ||
title: ApiHeader 引用说明 | ||
atomId: ApiHeader | ||
description: 简要介绍模块 Api 的头部说明 | ||
group: 功能组件 | ||
--- | ||
|
||
## Demo | ||
|
||
<code src="./demos/ApiHeader"></code> | ||
|
||
:::info | ||
只有包裹在 `DumiSiteProvider` 里面才能正常使用。 | ||
::: | ||
|
||
## API | ||
|
||
| 属性名 | 描述 | 类型 | 默认值 | | ||
| ----------- | ------------------------------------ | ---------------------------------- | ----------- | | ||
| title | 标题 | `string` | `undefined` | | ||
| description | 描述 | `string` | `undefined` | | ||
| actions | 行动点,第一个 action 默认为 primary | `{ text: string; link: string }[]` | `undefined` | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
/** | ||
* iframe: true | ||
*/ | ||
import { ApiHeader, DumiSiteProvider } from 'dumi-theme-antd-style'; | ||
import { Flexbox } from 'react-layout-kit'; | ||
|
||
export default () => ( | ||
<DumiSiteProvider> | ||
<Flexbox padding={24}> | ||
<ApiHeader | ||
title={'Button 按钮'} | ||
pkg={'antd'} | ||
componentName={'Button'} | ||
description={'Ant Design 的按钮'} | ||
docsUrl={'https://ant.design/components/button-cn'} | ||
sourceUrl={ | ||
'https://github.com/ant-design/ant-design/blob/master/components/button/index.ts' | ||
} | ||
/> | ||
</Flexbox> | ||
</DumiSiteProvider> | ||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
f597ab0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
dumi-theme-antd-style – ./
dumi-theme-antd-style.vercel.app
dumi-theme-antd-style.arvinx.app
dumi-theme-antd-style-arvinxx.vercel.app
dumi-theme-antd-style-git-master-arvinxx.vercel.app