Skip to content

AppSlope/ant-design-pro-angular

 
 

Repository files navigation

NPM version

Ant Design Pro Angular

image

开箱即用的中台前端/设计解决方案。此仓库是 Angular 版本的 Ant Design Pro 的 layout, 是为了方便快速的使用 layout 而开发。

样式对应 @ant-design/pro-layout:4.6.2

使用

npm i pro-layout --save
// or
yarn add pro-layout
import {ProLayoutModule} from "pro-layout";

@NgModule({
  imports: [ ProLayoutModule ]
})
export class AppModule {
}

API

x 标识的参数是对应于react版本未实现的属性,menuData为Angular版本新增属性

参数 说明 类型 默认值
[title] layout 的 左上角 的 title string | TemplateRef<void> 'Ant Design Pro'
[logo] layout 的 左上角 logo 的 url string | TemplateRef<void> -
[menuHeaderRender] 渲染 logo 和 title TemplateRef<void> -
(onMenuHeaderClick) menu 菜单的头部点击事件 EventEmitter<Event> -
[layout] layout 的菜单模式,sidemenu:右侧导航,topmenu:顶部导航 'sidemenu' | 'topmenu' 'sidemenu'
[contentWidth] layout 的内容模式,Fluid:定宽 1200px,Fixed:自适应 'Fluid' | 'Fixed' 'Fluid'
[navTheme] 导航的主题 'light' | 'dark' 'dark'
[fixedHeader] 是否固定 header 到顶部 boolean false
[fixSiderbar] 是否固定导航 boolean false
[autoHideHeader] 是否下滑时自动隐藏 header boolean false
[menu] x x x
[iconfontUrl] x x x
[locale] x x x
[settings] x x x
[siderWidth] 侧边菜单宽度 number 256
[collapsed] 控制菜单的收起和展开 boolean false
[onCollapse] 菜单的折叠收起事件 EventEmitter<boolean> -
[headerRender] 自定义头的 render 方法 TemplateRef<void> -
[rightContentRender] 自定义头右部的 render 方法 TemplateRef<void> -
[collapsedButtonRender] 自定义 collapsed button 的方法 TemplateRef<boolean> -
[footerRender] 自定义页脚的 render 方法 TemplateRef<void> false`
[menuData] 菜单数据 MenuDataItem[] -
[menuRender] x x x
[menuItemRender] x x x
[menuDataRender] x x x
[breadcrumbRender] x x x
[route] x x x
[disableMobile] x x x
[menuProps] x x x

SettingDrawer

SettingDrawer 提供了一个图形界面来设置 layout 的配置。不建议在正式环境中使用。

参数 说明 类型 默认值
settings layout 的设置 Settings Settings
onSettingChange Settings 发生更改事件 (settings: Settings ) => void -

PageHeaderWrapper

PageHeaderWrapper 封装了 ant design 的 PageHeader 组件,增加了 tabList,和 content。

参数 说明 类型 默认值
[content] 内容区 string | TemplateRef<void> -
[extraContent] 额外内容区,位于 content 的右侧 string | TemplateRef<void> -
[tabList] tab 标题列表 { key: string; tab: string; }[] -
[tabActiveKey] 当前高亮的 tab 项 string -
(onTabChange) 切换面板的回调 (key) => void -
[tabBarExtraContent] tab bar 上额外的元素 TemplateRef -

GridContent

GridContent 封装了 等宽流式 的逻辑。你可以在 preview 中查看预览效果。

参数 说明 类型 默认值
contentWidth 内容模式 'Fluid' | 'Fixed' -

数据结构

MenuDataItem

// 可以通过 import { MenuDataItem } from 'pro-layout'
// 来获取这个类型

export interface MenuDataItem {
  name?: string;
  icon?: string;
  locale?: string;
  path: string;
  guard?: ACLType;
  external?: boolean;
  children?: MenuDataItem[];
  [key: string]: any;
}

依赖项目

About

ant-design-pro-angular-layout

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 57.8%
  • HTML 30.8%
  • CSS 10.5%
  • JavaScript 0.9%