@gx-design-vue/context 0.0.3 → 0.0.5-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

@@ -1,10 +1,76 @@
-# context
+<div align="center"><a name="readme-top"></a>
 
-```shell
+<img height="180" src="https://gx12358.cn/resource/img/favicon.ico">
+
+<h1>Context</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/context
+```
+
+```bash
+yarn add @gx-design-vue/context
+```
+
+```bash
 pnpm add @gx-design-vue/context
 ```
 
-```ts
-// 可全局引入，也可以单独引入
-import { Gcontext } from '@gx-design-vue/context'
+```bash
+bun add @gx-design-vue/context
 ```
+
+## 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/ContextProvider.d.ts

@@ -0,0 +1,45 @@
+import * as vue0 from "vue";
+import { PropType, SlotsType } from "vue";
+
+//#region src/context/ContextProvider.d.ts
+interface ContextProviderProps {
+  contextKey: string;
+  value: any;
+}
+interface ContextProviderSlots {
+  default?: () => any;
+}
+declare const contextProps: {
+  contextKey: {
+    type: PropType<ContextProviderProps["contextKey"]>;
+    required: boolean;
+  };
+  value: {
+    type: PropType<ContextProviderProps["value"]>;
+    required: boolean;
+  };
+};
+declare const ContextProvider: vue0.DefineComponent<vue0.ExtractPropTypes<{
+  contextKey: {
+    type: PropType<ContextProviderProps["contextKey"]>;
+    required: boolean;
+  };
+  value: {
+    type: PropType<ContextProviderProps["value"]>;
+    required: boolean;
+  };
+}>, () => any, {}, {}, {}, vue0.ComponentOptionsMixin, vue0.ComponentOptionsMixin, {}, string, vue0.PublicProps, Readonly<vue0.ExtractPropTypes<{
+  contextKey: {
+    type: PropType<ContextProviderProps["contextKey"]>;
+    required: boolean;
+  };
+  value: {
+    type: PropType<ContextProviderProps["value"]>;
+    required: boolean;
+  };
+}>> & Readonly<{}>, {}, SlotsType<ContextProviderSlots>, {}, {}, string, vue0.ComponentProvideOptions, true, {}, any>;
+declare function useContextProvider<T = any>(contextInjectKey: string, defaultValue?: T): T & {
+  contextId: string;
+};
+//#endregion
+export { ContextProvider, ContextProviderSlots, contextProps, useContextProvider };

package/dist/context/ContextProvider.js

@@ -0,0 +1,39 @@
+import { defineComponent, inject, provide, toRefs } from "vue";
+import { getRandomNumber, isObject } from "@gx-design-vue/pro-utils";
+
+//#region src/context/ContextProvider.tsx
+let contextId = null;
+function updateContextKey(key) {
+	if (contextId) return contextId;
+	contextId = Symbol(key);
+	return contextId;
+}
+const contextProps = {
+	contextKey: {
+		type: String,
+		required: true
+	},
+	value: {
+		type: Object,
+		required: true
+	}
+};
+const ContextProvider = /* @__PURE__ */ defineComponent({
+	name: "ContextProvider",
+	props: contextProps,
+	slots: Object,
+	setup: (props, { slots }) => {
+		if (props.contextKey && props.value && isObject(props.value)) provide(updateContextKey(props.contextKey), {
+			...toRefs(props.value),
+			contextId: `${props.contextKey}-${getRandomNumber().uuid(10)}`
+		});
+		else console.warn("[ContextProvider]: contextKey is required");
+		return () => slots.default?.();
+	}
+});
+function useContextProvider(contextInjectKey, defaultValue) {
+	if (typeof contextId === "symbol") return inject(updateContextKey(contextInjectKey), defaultValue || {});
+}
+
+//#endregion
+export { ContextProvider, contextProps, useContextProvider };

package/dist/context/index.d.ts

@@ -0,0 +1,10 @@
+import { InjectionKey } from "vue";
+
+//#region src/context/index.d.ts
+declare function useContext<T>(key: string, defaultValue?: T): {
+  provideContext: (value: T) => void;
+  useInjectContext: (injectDefaultValue?: T) => T;
+  contextInjectKey: InjectionKey<T>;
+};
+//#endregion
+export { useContext };

package/dist/context/index.js

@@ -0,0 +1,20 @@
+import { inject, provide } from "vue";
+
+//#region src/context/index.ts
+function useContext(key, defaultValue) {
+	const contextInjectKey = Symbol(key);
+	const provideContext = (value) => {
+		provide(contextInjectKey, value);
+	};
+	const useInjectContext = (injectDefaultValue) => {
+		return inject(contextInjectKey, injectDefaultValue || defaultValue || {});
+	};
+	return {
+		provideContext,
+		useInjectContext,
+		contextInjectKey
+	};
+}
+
+//#endregion
+export { useContext };