@gx-design-vue/pro-layout 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 gx12358
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+<div align="center"><a name="readme-top"></a>
+
+<img height="180" src="https://gx12358.cn/resource/img/favicon.ico">
+
+<h1>Pro Layout</h1>
+
+</div>
+
+## ✨ Features
+
+- 🌈 Enterprise-class UI designed for web applications.
+- 📦 A set of high-quality Vue3 components out of the box.
+- 🛡 Written in TypeScript with predictable static types.
+- ⚙️ Whole package of design resources and development tools.
+- 🌍 Internationalization support for dozens of languages.
+- 🎨 Powerful theme customization based on CSS-in-JS.
+
+## 🖥 Environment Support
+
+- Modern browsers
+- Server-side Rendering
+- [Electron](https://www.electronjs.org/)
+
+| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="Edge" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png" alt="Electron" width="24px" height="24px" />](https://godban.github.io/browsers-support-badges/)<br>Electron |
+| --- | --- | --- | --- | --- |
+| Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
+
+## 📦 Install
+
+```bash
+npm install @gx-design-vue/pro-layout
+```
+
+```bash
+yarn add @gx-design-vue/pro-layout
+```
+
+```bash
+pnpm add @gx-design-vue/pro-layout
+```
+
+```bash
+bun add @gx-design-vue/pro-layout
+```
+
+## Acknowledgements
+
+Antdv Next is inspired by and built upon the following open-source projects.
+
+- [Ant Design](https://ant.design/)
+- [Vue.js](https://vuejs.org/)
+- [Vite](https://vitejs.dev/)
+
+## Maintainer
+
+[@gx12358](https://github.com/gx12358/vue3-antd-admin)
+
+## Contributors
+
+<a href="https://github.com/gx12358/vue3-antd-admin/graphs/contributors">
+  <img alt="Contributors" src="https://contrib.rocks/image?repo=gx12358/vue3-antd-admin" />
+</a>
+
+## Special Thanks
+
+Thanks to the [vbenjs/vue-vben-admin](https://github.com/gx12358/vue3-antd-admin) project for providing inspiration and reference implementation.
+
+## License
+
+[MIT © gx12358-2021](./LICENSE)
+
+## `Star`
+
+Thank you very much for the stars from kind-hearted people, thank you for your support :heart:
+
+[![Stargazers repo roster for @gx12358/vue3-antd-admin](https://bytecrank.com/nastyox/reporoster/php/stargazersSVG.php?user=gx12358&repo=vue3-antd-admin)](https://github.com/gx12358/vue3-antd-admin/stargazers)

package/dist/Context/expose.d.ts

@@ -0,0 +1,6 @@
+import { ProLayoutInjextExpose } from "../types/typings.js";
+
+//#region src/Context/expose.d.ts
+declare const provideProLayoutExposeContext: (value: ProLayoutInjextExpose) => void, useProLayoutExposeContext: (injectDefaultValue?: ProLayoutInjextExpose) => ProLayoutInjextExpose;
+//#endregion
+export { provideProLayoutExposeContext, useProLayoutExposeContext };

package/dist/Context/expose.js

@@ -0,0 +1,7 @@
+import { useContext } from "@gx-design-vue/context";
+
+//#region src/Context/expose.ts
+const { provideContext: provideProLayoutExposeContext, useInjectContext: useProLayoutExposeContext } = useContext("pro-layout-expose");
+
+//#endregion
+export { provideProLayoutExposeContext, useProLayoutExposeContext };

package/dist/Context/index.d.ts

@@ -0,0 +1,43 @@
+import { Meta } from "../types/RouteTypings.js";
+import { BreadcrumbProps } from "../types/Breadcrumb.js";
+import { MenuPropsContext, ProLayoutMenuFunProps } from "../types/MenuTypings.js";
+import { LayoutPageContainer, PageContainerPropsType } from "../components/PageContainer/props.js";
+import { ShortcutKeyProps } from "../props/index.js";
+import { BasicLayoutProps, CollapsedProps, LayoutClassNamesType, LayoutContext, LayoutStylesType } from "../types/typings.js";
+import { ComputedRef, Ref } from "vue";
+import { CustomRender, PrefixCls, WithFalse } from "@gx-design-vue/pro-utils";
+
+//#region src/Context/index.d.ts
+declare const defaultContextKey: (keyof ProLayoutContextProps)[];
+interface ProLayoutContextProps {
+  getPrefixCls: (prefixCls: PrefixCls) => string;
+  setHasFooterToolbar: (value: boolean) => void;
+  zIndex: Ref<number>;
+  styles: Ref<LayoutStylesType>;
+  waterMarkProps: Ref<BasicLayoutProps['waterMarkProps']>;
+  classNames: Ref<LayoutClassNamesType>;
+  breadcrumb: ComputedRef<BreadcrumbProps>;
+  collapsed: Ref<boolean>;
+  hasFooterToolbar: Ref<boolean>;
+  collapsedEffect: ComputedRef<boolean>;
+  collapsedProps: ComputedRef<Partial<CollapsedProps>>;
+  openKeys: Ref<ProLayoutMenuFunProps['openKeys']>;
+  selectedKeys: Ref<ProLayoutMenuFunProps['openKeys']>;
+  renderRouterView: Ref<boolean>;
+  contentFullScreen: Ref<boolean>;
+  disableMobile?: Ref<boolean>;
+  fullScreenOnTabsHide: Ref<boolean>;
+  shortcutKey: Ref<ShortcutKeyProps>;
+  hasContentWide: ComputedRef<boolean>;
+  breadcrumbRender: Ref<WithFalse<(props: BreadcrumbProps) => CustomRender> | undefined>;
+  isMobile: ComputedRef<boolean>;
+  settings: ComputedRef<BasicLayoutProps['settings']>;
+  pageContainer: Ref<LayoutPageContainer>;
+  pageHeaderRender: ComputedRef<PageContainerPropsType['pageHeaderRender']>;
+  menu: ComputedRef<MenuPropsContext>;
+  currentMeta: Ref<Meta | undefined>;
+  layoutProps: ComputedRef<LayoutContext>;
+}
+declare const provideProLayoutContext: (value: ProLayoutContextProps) => void, useProLayoutContext: (injectDefaultValue?: ProLayoutContextProps) => ProLayoutContextProps;
+//#endregion
+export { ProLayoutContextProps, defaultContextKey, provideProLayoutContext, useProLayoutContext };

package/dist/Context/index.js

@@ -0,0 +1,18 @@
+import { useContext } from "@gx-design-vue/context";
+
+//#region src/Context/index.ts
+const defaultContextKey = [
+	"styles",
+	"zIndex",
+	"waterMarkProps",
+	"classNames",
+	"openKeys",
+	"selectedKeys",
+	"disableMobile",
+	"shortcutKey",
+	"pageContainer"
+];
+const { provideContext: provideProLayoutContext, useInjectContext: useProLayoutContext } = useContext("pro-layout");
+
+//#endregion
+export { defaultContextKey, provideProLayoutContext, useProLayoutContext };