yuang-framework-ui-pc 1.0.20 → 1.2.1

package/es/ele-pro-layout/props.ts

@@ -0,0 +1,255 @@
+import type { PropType, ExtractPropTypes, InjectionKey } from 'vue';
+import type { StyleValue } from '../ele-app/types';
+import type { EleMenusProps, EleBreadcrumbProps, EleDropdownProps, EleBacktopProps } from '../ele-app/plus';
+import type { ContextMenus } from '../ele-tabs/types';
+import type { BreadcrumbSeparator as Separator } from '../ele-breadcrumb/types';
+import type { Layout, SidebarLayout, HeaderStyle, SidebarStyle, TabStyle, TabBar, Maximized } from '../ele-admin-layout/types';
+import type { MenuItem, TabItem, MenuItemTrigger, MenuI18n, BeforeClick, TabItemEventOption, BodySizeChangeOption, ProLayoutProvide } from './types';
+type TextEllipsisTooltip = EleMenusProps['textEllipsisTooltip'];
+type ProLayoutKey = InjectionKey<ProLayoutProvide>;
+
+/**
+ * 属性
+ */
+export const proLayoutProps = {
+  /** 高度 */
+  height: {
+    type: [String, Number],
+    default: null
+  },
+  /** 菜单数据 */
+  menus: Array as PropType<MenuItem[] | null>,
+  /** 页签数据 */
+  tabs: Array as PropType<TabItem[] | null>,
+  /** 是否折叠侧栏 */
+  collapse: Boolean,
+  /** 双侧栏一级是否紧凑风格 */
+  compact: Boolean,
+  /** 内容区是否最大化 */
+  maximized: [Boolean, String] as PropType<Maximized>,
+  /** 是否需要页签栏 */
+  tabBar: {
+    type: [Boolean, String] as PropType<TabBar>,
+    default: true
+  },
+  /** 是否需要面包屑导航 */
+  breadcrumb: {
+    type: [Boolean, Object] as PropType<boolean | EleBreadcrumbProps>,
+    default: true
+  },
+  /** 是否需要返回顶部 */
+  backTop: {
+    type: [Boolean, Object] as PropType<boolean | EleBacktopProps>,
+    default: true
+  },
+  /** 布局类型 */
+  layout: String as PropType<Layout>,
+  /** 侧栏布局类型 */
+  sidebarLayout: String as PropType<SidebarLayout>,
+  /** 顶栏风格 */
+  headerStyle: String as PropType<HeaderStyle>,
+  /** 侧栏风格 */
+  sidebarStyle: {
+    type: String as PropType<SidebarStyle>,
+    default: 'dark'
+  },
+  /** 页签风格 */
+  tabStyle: {
+    type: String as PropType<TabStyle>,
+    default: 'simple'
+  },
+  /** 是否固定顶栏 */
+  fixedHeader: {
+    type: Boolean,
+    default: true
+  },
+  /** 是否固定侧栏 */
+  fixedSidebar: {
+    type: Boolean,
+    default: true
+  },
+  /** 是否固定内容区 */
+  fixedBody: {
+    type: Boolean,
+    default: true
+  },
+  /** 图标是否置于顶栏 */
+  logoInHeader: Boolean,
+  /** 是否需要固定的主页页签 */
+  fixedHome: {
+    type: Boolean,
+    default: true
+  },
+  /** 主页路由地址 */
+  homePath: String,
+  /** 刷新路由地址 */
+  redirectPath: {
+    type: String,
+    default: '/redirect'
+  },
+  /** 内容区是否撑满 */
+  fluid: {
+    type: Boolean,
+    default: true
+  },
+  /** 返回键退出内容区最大化 */
+  compressOnEsc: Boolean,
+  /** 固定主体时切换路由自动滚到顶部 */
+  autoScrollTop: {
+    type: Boolean,
+    default: true
+  },
+  /** 顶栏菜单触发模式 */
+  navTrigger: String as PropType<MenuItemTrigger>,
+  /** 双侧栏一级菜单触发模式 */
+  boxTrigger: String as PropType<MenuItemTrigger>,
+  /** 侧栏菜单触发模式 */
+  itemTrigger: String as PropType<MenuItemTrigger>,
+  /** hover模式的菜单切换超时 */
+  menuHoverTimeout: {
+    type: Number,
+    default: 600
+  },
+  /** 菜单点击事件前钩子 */
+  beforeClick: Function as PropType<BeforeClick>,
+  /** 是否支持内嵌缓存 */
+  keepAlive: Boolean,
+  /** 内嵌切换动画 */
+  transitionName: String,
+  /** 内嵌进入动画延迟时间 */
+  transitionDelay: {
+    type: Number,
+    default: 250
+  },
+  /** 是否开启响应式 */
+  responsive: {
+    type: Boolean,
+    default: true
+  },
+  /** 国际化语言 */
+  locale: String,
+  /** 菜单标题国际化方法 */
+  i18n: Function as PropType<MenuI18n>,
+  /** 是否支持页签右键菜单 */
+  tabContextMenu: [Boolean, Object] as PropType<boolean | EleDropdownProps>,
+  /** 右键菜单 */
+  tabContextMenus: [Array, Function] as PropType<ContextMenus>,
+  /** 是否支持页签拖动排序 */
+  tabSortable: Boolean,
+  /** 顶栏菜单标题插槽名称 */
+  headerTitleSlot: {
+    type: String,
+    default: 'title'
+  },
+  /** 顶栏菜单图标插槽名称 */
+  headerIconSlot: {
+    type: String,
+    default: 'icon'
+  },
+  /** 侧栏菜单标题插槽名称 */
+  sidebarTitleSlot: {
+    type: String,
+    default: 'title'
+  },
+  /** 侧栏菜单图标插槽名称 */
+  sidebarIconSlot: {
+    type: String,
+    default: 'icon'
+  },
+  /** 双侧栏一级菜单标题插槽名称 */
+  sideboxTitleSlot: {
+    type: String,
+    default: 'title'
+  },
+  /** 双侧栏一级菜单图标插槽名称 */
+  sideboxIconSlot: {
+    type: String,
+    default: 'icon'
+  },
+  /** 顶栏样式 */
+  headerCustomStyle: Object as PropType<StyleValue>,
+  /** 侧栏样式 */
+  sidebarCustomStyle: Object as PropType<StyleValue>,
+  /** 双侧栏一级样式 */
+  sideboxCustomStyle: Object as PropType<StyleValue>,
+  /** 页签栏样式 */
+  tabsCustomStyle: Object as PropType<StyleValue>,
+  /** 内容区样式 */
+  contentCustomStyle: Object as PropType<StyleValue>,
+  /** logo样式 */
+  logoStyle: Object as PropType<StyleValue>,
+  /** logo文字样式 */
+  logoTitleStyle: Object as PropType<StyleValue>,
+  /** 顶栏菜单样式 */
+  headerMenusStyle: Object as PropType<StyleValue>,
+  /** 侧栏菜单样式 */
+  sidebarMenusStyle: Object as PropType<StyleValue>,
+  /** 双侧栏一级菜单样式 */
+  sideboxMenusStyle: Object as PropType<StyleValue>,
+  /** 顶栏菜单属性 */
+  headerMenuProps: Object as PropType<EleMenusProps>,
+  /** 侧栏菜单属性 */
+  sidebarMenuProps: Object as PropType<EleMenusProps>,
+  /** 双侧栏一级菜单属性 */
+  sideboxMenuProps: Object as PropType<EleMenusProps>,
+  /** 顶栏菜单是否省略多余的子项 */
+  ellipsis: {
+    type: Boolean,
+    default: true
+  },
+  /** 顶栏菜单省略项的属性 */
+  ellipsisProps: Object as PropType<EleMenusProps['ellipsisProps']>,
+  /** 顶栏子菜单触发方式 */
+  menuTrigger: String as PropType<EleMenusProps['menuTrigger']>,
+  /** 侧栏默认展开的菜单 */
+  sidebarOpeneds: Array as PropType<string[]>,
+  /** 侧栏是否只保持一个子菜单展开 */
+  uniqueOpened: {
+    type: Boolean,
+    default: true
+  },
+  /** 侧栏菜单是否彩色图标 */
+  colorfulIcon: Boolean,
+  /** 菜单 tooltip 主题 */
+  tooltipEffect: String as PropType<EleMenusProps['popperEffect']>,
+  /** 是否开启菜单文本溢出提示 */
+  menuTextEllipsisTooltip: [Boolean, Object] as PropType<TextEllipsisTooltip>,
+  /** 内容区最大时不带页签栏 */
+  expanded: Boolean,
+  /** 面包屑导航分隔符 */
+  breadcrumbSeparator: [String, Object, Function] as PropType<Separator>,
+  /** 返回顶部可见的滚动高度 */
+  backTopVisibilityHeight: Number,
+  /** 返回顶部的右边距 */
+  backTopRight: Number,
+  /** 返回顶部的下边距 */
+  backTopBottom: Number,
+  /** 返回顶部的目标选择器 */
+  backTopTarget: String
+};
+
+export type ProLayoutProps = ExtractPropTypes<typeof proLayoutProps>;
+
+/**
+ * 事件
+ */
+export const proLayoutEmits = {
+  'update:collapse': (_collapse: boolean) => true,
+  'update:maximized': (_maximized: boolean) => true,
+  tabAdd: (_data: TabItem) => true,
+  tabClick: (_option: TabItemEventOption) => true,
+  tabRemove: (_option: TabItemEventOption) => true,
+  tabContextMenu: (_option: TabItemEventOption) => true,
+  tabSortChange: (_data: TabItem[]) => true,
+  logoClick: (_isHome: boolean, _e: MouseEvent) => true,
+  headMenuOpen: (_index: string, _indexPath: string[]) => true,
+  headMenuClose: (_index: string, _indexPath: string[]) => true,
+  sideMenuOpen: (_index: string, _indexPath: string[]) => true,
+  sideMenuClose: (_index: string, _indexPath: string[]) => true,
+  bodySizeChange: (_option: BodySizeChangeOption) => true
+};
+
+/**
+ * 共享数据key
+ */
+export const PRO_LAYOUT_KEY = Symbol('proLayout') as ProLayoutKey;

package/es/ele-pro-layout/style/index.scss

@@ -0,0 +1,41 @@
+@use '../../style/themes/default.scss' as *;
+@use '../../style/util.scss' as *;
+
+.ele-pro-layout {
+  /* logo */
+  & > .ele-admin-side {
+    & > .ele-admin-sidebox > .ele-admin-logo > img + h1 {
+      display: none;
+    }
+  }
+
+  /* 面包屑导航 */
+  &.is-mobile > .ele-admin-main > .ele-admin-header > .ele-admin-breadcrumb {
+    display: none;
+  }
+}
+
+/* iframe */
+.ele-admin-iframe-wrap {
+  flex-shrink: 0;
+  position: absolute;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  width: 100%;
+  height: 100%;
+  display: flex;
+  flex-direction: column;
+  pointer-events: none;
+  overflow: hidden;
+}
+
+.ele-admin-iframe {
+  flex-shrink: 0;
+  width: 100%;
+  height: 100%;
+  border: none;
+  box-sizing: border-box;
+  pointer-events: auto;
+}

package/es/ele-pro-layout/style/index.ts

@@ -0,0 +1,2 @@
+import '../../ele-admin-layout/style/index';
+import './index.scss';

package/es/ele-pro-layout/types.ts

@@ -0,0 +1,212 @@
+import type { EleMenuItemProps } from '../ele-app/plus';
+export type { Layout, SidebarLayout, HeaderStyle, SidebarStyle, TabStyle, TabBar } from '../ele-admin-layout/types';
+
+/**
+ * 菜单元数据
+ */
+export interface MenuMeta extends Record<string, any> {
+  /** 菜单标题 */
+  title?: string;
+  /** 菜单图标 */
+  icon?: any;
+  /** 菜单是否隐藏 */
+  hide?: boolean;
+  /** 选中其它菜单 */
+  active?: string;
+  /** 是否隐藏页脚 */
+  hideFooter?: boolean;
+  /** 是否隐藏顶栏 */
+  hideHeader?: boolean;
+  /** 是否隐藏侧栏 */
+  hideSidebar?: boolean;
+  /** 是否隐藏双侧栏一级 */
+  hideSidebox?: boolean;
+  /** 是否隐藏页签栏 */
+  hideTabs?: boolean;
+  /** 页签是否可关闭 */
+  closable?: boolean;
+  /** 页签不同参数是否合并 */
+  tabUnique?: boolean;
+  /** 页签是否缓存 */
+  keepAlive?: boolean;
+  /** 是否在面包屑中显示 */
+  breadcrumb?: boolean;
+  /** 菜单组件其它属性 */
+  props?: Record<string, any>;
+  /** 是否需要外层布局 */
+  layout?: boolean;
+  /** 路由地址 */
+  routePath?: string;
+  /** 内嵌地址, 内部属性 */
+  iframe?: string;
+}
+
+/**
+ * 菜单数据
+ */
+export interface MenuItem {
+  /** 路由名称 */
+  name?: string;
+  /** 菜单地址 */
+  path: string;
+  /** 路由组件 */
+  component?: string;
+  /** 路由重定向 */
+  redirect?: string;
+  /** 路由元数据 */
+  meta?: MenuMeta;
+  /** 子路由 */
+  children?: Array<MenuItem>;
+  /** 临时子路由数据, 内部属性 */
+  tempChildren?: Array<MenuItem>;
+}
+
+/**
+ * 页签数据
+ */
+export interface TabItem {
+  /** 页签标题 */
+  title?: string;
+  /** 页签标识 */
+  key?: string;
+  /** 路由地址 */
+  path?: string;
+  /** 路由完整地址 */
+  fullPath?: string;
+  /** 是否可关闭 */
+  closable?: boolean;
+  /** 是否是主页 */
+  home?: boolean;
+  /** 组件名称 */
+  components?: string[];
+  /** 是否为刷新状态 */
+  refresh?: boolean;
+  /** 路由元数据 */
+  meta?: MenuMeta;
+}
+
+/**
+ * 面包屑导航数据
+ */
+export interface LevelItem {
+  /** 标题 */
+  title: string;
+  /** 地址 */
+  path: string;
+}
+
+/**
+ * 菜单标题国际化方法参数
+ */
+export interface MenuI18nOption {
+  /** 当前语言 */
+  locale?: string;
+  /** 菜单地址 */
+  path: string;
+  /** 菜单数据 */
+  menu?: MenuItem;
+  /** 页签数据 */
+  tab?: TabItem;
+  /** 面包屑数据 */
+  level?: LevelItem;
+}
+
+/**
+ * 菜单标题国际化方法
+ */
+export type MenuI18n = (option: MenuI18nOption) => string | undefined | null | void;
+
+/**
+ * 页签事件参数
+ */
+export interface TabItemEventOption {
+  /** 页签标识 */
+  key?: string;
+  /** 页签数据 */
+  item?: TabItem;
+  /** 当前选中页签的标识 */
+  active?: string;
+  /** 事件标识 */
+  command?: string;
+}
+
+/**
+ * 获取路由对应菜单的结果
+ */
+export interface MatchedResult {
+  /** 选中地址 */
+  active: string;
+  /** 菜单标题 */
+  title?: string;
+  /** 匹配的菜单数据 */
+  matched?: MenuItem[];
+  /** 是否选中非本身 */
+  activeOther?: boolean;
+}
+
+/**
+ * 内容区尺寸改变事件参数
+ */
+export interface BodySizeChangeOption {
+  /** 内容区宽度 */
+  width?: number;
+  /** 内容区高度 */
+  height?: number;
+  /** 是否是移动端小屏幕 */
+  mobile?: boolean;
+}
+
+/**
+ * 混合导航菜单切换模式
+ */
+export type MenuItemTrigger = 'route' | 'click' | 'hover';
+
+/**
+ * 子菜单项点击前钩子
+ */
+export type BeforeClick = (item: EleMenuItemProps, e: MouseEvent) => boolean;
+
+/**
+ * 内嵌数据
+ */
+export interface IframeItem {
+  /** id */
+  id: string;
+  /** 地址 */
+  src: string;
+  /** 是否是刷新状态 */
+  refresh?: boolean;
+}
+
+/**
+ * 状态数据
+ */
+export interface LayoutState {
+  navActive?: string;
+  sideActive?: string;
+  boxActive?: string;
+  navData: MenuItem[];
+  sideData: MenuItem[];
+  boxData: MenuItem[];
+  isHover?: boolean;
+  contentWidth?: number;
+  contentHeight?: number;
+}
+
+/**
+ * 共享数据
+ */
+export interface ProLayoutProvide {
+  /** 是否支持内嵌缓存 */
+  keepAlive?: boolean;
+  /** 是否开启响应式 */
+  responsive?: boolean;
+}
+
+/**
+ * 带响应式开关的组件属性
+ */
+export interface ResponsiveProps extends Record<keyof any, any> {
+  /** 是否开启响应式 */
+  responsive?: boolean;
+}