Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
P
pro-layout
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
packages
pro-layout
Commits
a22e5d4b
Unverified
Commit
a22e5d4b
authored
Nov 05, 2019
by
Sendya
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: add README.md
parent
d46ded81
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
90 additions
and
1 deletion
+90
-1
README.md
README.md
+44
-1
README.zh-CN.md
README.zh-CN.md
+46
-0
No files found.
README.md
View file @
a22e5d4b
# pro-layout
English |
[
简体中文
](
./README.zh-CN.md
)
\ No newline at end of file
<h1
align=
"center"
>
Ant Design Pro Layout
</h1>
## Usage
```
bash
npm i @vue-component/pro-layout
--save
// or
yarn add @vue-component/pro-layout
```
```
jsx
import
ProLayout
from
'@vue-component/pro-layout'
export
default
{
name
:
'BasicLayout'
,
render
()
{
return
(
<
ProLayout
>
<
router
-
view
/>
</
ProLayout
>
)
}
}
```
## API
### ProLayout
| Property | Description | Type | Default Value |
| --- | --- | --- | --- |
| title | layout in the upper left corner title | VNode
\|
String |
`'Ant Design Pro'`
|
| logo | layout top left logo url | VNode
\|
render | - |
| layout | layout menu mode, sidemenu: right navigation, topmenu: top navigation | 'sidemenu'
\|
'topmenu' |
`'sidemenu'`
|
| contentWidth | content mode of layout, Fluid: fixed width 1200px, Fixed: adaptive | true
\|
false |
`false`
|
| theme | Navigation menu theme | 'light'
\|
'dark' |
`'dark'`
|
| menus | vue-router
`routes`
prop | Object |
`[{}]`
|
| collapsed | control menu's collapse and expansion | boolean | true |
| handleCollapse | folding collapse event of menu | (collapsed: boolean) => void | - |
| headerRender | custom header render method | (props: BasicLayoutProps) => VNode | - |
| rightContentRender | header right content render method | (props: HeaderViewProps) => VNode | - |
| collapsedButtonRender | custom collapsed button method | (collapsed: boolean) => VNode | - |
README.zh-CN.md
0 → 100644
View file @
a22e5d4b
[
English
](
./README.md
)
| 简体中文
<h1
align=
"center"
>
Ant Design Pro Layout
</h1>
## 使用
```
bash
npm i @vue-component/pro-layout
--save
// or
yarn add @vue-component/pro-layout
```
```
jsx
import
ProLayout
from
'@vue-component/pro-layout'
export
default
{
name
:
'BasicLayout'
,
render
()
{
return
(
<
ProLayout
>
<
router
-
view
/>
</
ProLayout
>
)
}
}
```
## API
### ProLayout
| Property | Description | Type | Default Value |
| --- | --- | --- | --- |
| title | layout in the upper left corner title | VNode
\|
String |
`'Ant Design Pro'`
|
| logo | layout top left logo url | VNode
\|
render | - |
| layout | layout menu mode, sidemenu: right navigation, topmenu: top navigation | 'sidemenu'
\|
'topmenu' |
`'sidemenu'`
|
| contentWidth | content mode of layout, Fluid: fixed width 1200px, Fixed: adaptive | true
\|
false |
`false`
|
| theme | Navigation menu theme | 'light'
\|
'dark' |
`'dark'`
|
| menus | vue-router
`routes`
prop | Object |
`[{}]`
|
| collapsed | control menu's collapse and expansion | boolean | true |
| handleCollapse | folding collapse event of menu | (collapsed: boolean) => void | - |
| headerRender | custom header render method | (props: BasicLayoutProps) => VNode | - |
| rightContentRender | header right content render method | (props: HeaderViewProps) => VNode | - |
| collapsedButtonRender | custom collapsed button method | (collapsed: boolean) => VNode | - |
> 由于文档正在编写,可能与实际 API 不一致,如需请参考 `/example/` 下例子
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment