@veltra/utils 1.1.2 → 1.1.3

package/dist/index.d.ts

@@ -16,5 +16,5 @@ import { extractNormalVNodes, isComment, isFragment, isTemplate, isTextNode, sha
 import { middleProxy } from "./reactive/proxy.js";
 import { DeconstructValue, DefineEvent, Index, Null, RenderReturn, Undef } from "./types/helper.js";
 import { BreakpointName, ColorType, ComponentProps, ComponentSize, FormComponentProps, PropsWithServerQuery } from "./types/component-common.js";
-import { FormContextInjectProps } from "./types/form-context.js";
-export { AnimeConfig, BEM, BEMFactory, BreakpointName, CLS_PREFIX, ColorType, ComponentProps, ComponentSize, Data, DeconstructValue, DefineEvent, ExpandTransition, ExpandTransitionOptions, FORM_EMPTY_CONTENT, FormComponentProps, FormContextInjectProps, Index, NAME_SPACE, Null, PresetRule, PropsWithServerQuery, RenderReturn, Tween, TweenConfig, Undef, ValidateRule, Validator, ValidatorConfig, addClass, bem, createIncrease, createToggle, extractNormalVNodes, getHighlightChunks, getNearestScrollParent, getScrollParents, isComment, isFragment, isTemplate, isTextNode, makeBEM, middleProxy, nextFrame, removeClass, removeStyles, scrollIntoContainerView, setStyles, shallowComputed, withUnit, zIndex };
+import { FormContextModel, FormContextProps, injectFormContext, provideFormContext } from "./types/form-context.js";
+export { AnimeConfig, BEM, BEMFactory, BreakpointName, CLS_PREFIX, ColorType, ComponentProps, ComponentSize, Data, DeconstructValue, DefineEvent, ExpandTransition, ExpandTransitionOptions, FORM_EMPTY_CONTENT, FormComponentProps, FormContextModel, FormContextProps, Index, NAME_SPACE, Null, PresetRule, PropsWithServerQuery, RenderReturn, Tween, TweenConfig, Undef, ValidateRule, Validator, ValidatorConfig, addClass, bem, createIncrease, createToggle, extractNormalVNodes, getHighlightChunks, getNearestScrollParent, getScrollParents, injectFormContext, isComment, isFragment, isTemplate, isTextNode, makeBEM, middleProxy, nextFrame, provideFormContext, removeClass, removeStyles, scrollIntoContainerView, setStyles, shallowComputed, withUnit, zIndex };

package/dist/index.js

@@ -13,4 +13,5 @@ import { Tween } from "./helper/tween.js";
 import { nextFrame } from "./helper/frame.js";
 import { extractNormalVNodes, isComment, isFragment, isTemplate, isTextNode, shallowComputed } from "./helper/vue.js";
 import { middleProxy } from "./reactive/proxy.js";
-export { CLS_PREFIX, ExpandTransition, FORM_EMPTY_CONTENT, NAME_SPACE, Tween, Validator, addClass, bem, createIncrease, createToggle, extractNormalVNodes, getHighlightChunks, getNearestScrollParent, getScrollParents, isComment, isFragment, isTemplate, isTextNode, makeBEM, middleProxy, nextFrame, removeClass, removeStyles, scrollIntoContainerView, setStyles, shallowComputed, withUnit, zIndex };
+import { injectFormContext, provideFormContext } from "./types/form-context.js";
+export { CLS_PREFIX, ExpandTransition, FORM_EMPTY_CONTENT, NAME_SPACE, Tween, Validator, addClass, bem, createIncrease, createToggle, extractNormalVNodes, getHighlightChunks, getNearestScrollParent, getScrollParents, injectFormContext, isComment, isFragment, isTemplate, isTextNode, makeBEM, middleProxy, nextFrame, provideFormContext, removeClass, removeStyles, scrollIntoContainerView, setStyles, shallowComputed, withUnit, zIndex };

package/dist/types/form-context.d.ts

@@ -1,6 +1,34 @@
+import { ComponentSize } from "./component-common.js";
+
 //#region src/types/form-context.d.ts
-/** 表单 provide/inject 上下文（完整 props 见 @veltra/desktop/types/form） */
-type FormContextInjectProps = Record<string, unknown>;
+interface FormContextModel {
+  errors: Map<any, string[] | undefined>;
+  fields: Record<string, {
+    required?: unknown;
+  }>;
+}
+interface FormContextProps {
+  /** 表单列宽 */
+  labelWidth?: string | number;
+  /** 表单尺寸 */
+  size?: ComponentSize;
+  /** 是否禁用 */
+  disabled?: boolean;
+  /** 是否只读 */
+  readonly?: boolean;
+  /** 是否隐藏提示 */
+  noTips?: boolean;
+  /** 表单数据模型 */
+  model?: FormContextModel;
+}
+type FormPropsLike = Partial<FormContextProps> & Record<string, any>;
+type DIContext = {
+  /** 表单属性 */formProps: FormPropsLike;
+};
+declare function provideFormContext<T extends FormPropsLike>(props: T): void;
+declare function injectFormContext(): {
+  /** 是否在表单中 */inForm: boolean;
+} & Partial<DIContext>;
 //#endregion
-export { FormContextInjectProps };
+export { FormContextModel, FormContextProps, injectFormContext, provideFormContext };
 //# sourceMappingURL=form-context.d.ts.map

package/dist/types/form-context.js

@@ -0,0 +1,17 @@
+import { inject, provide } from "vue";
+//#region src/types/form-context.ts
+const FormComponentDIKey = Symbol("FormComponentDIKey");
+function provideFormContext(props) {
+	if (props) provide(FormComponentDIKey, { formProps: props });
+}
+function injectFormContext() {
+	const context = inject(FormComponentDIKey, void 0) || {};
+	return {
+		inForm: !!context,
+		...context
+	};
+}
+//#endregion
+export { injectFormContext, provideFormContext };
+
+//# sourceMappingURL=form-context.js.map

package/dist/types/form-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-context.js","names":[],"sources":["../../src/types/form-context.ts"],"sourcesContent":["import { type InjectionKey, inject, provide } from 'vue'\n\nimport type { ComponentSize } from './component-common'\n\nexport interface FormContextModel {\n  errors: Map<any, string[] | undefined>\n  fields: Record<string, { required?: unknown }>\n}\n\nexport interface FormContextProps {\n  /** 表单列宽 */\n  labelWidth?: string | number\n  /** 表单尺寸 */\n  size?: ComponentSize\n  /** 是否禁用 */\n  disabled?: boolean\n  /** 是否只读 */\n  readonly?: boolean\n  /** 是否隐藏提示 */\n  noTips?: boolean\n  /** 表单数据模型 */\n  model?: FormContextModel\n}\n\ntype FormPropsLike = Partial<FormContextProps> & Record<string, any>\n\ntype DIContext = {\n  /** 表单属性 */\n  formProps: FormPropsLike\n}\n\nconst FormComponentDIKey: InjectionKey<DIContext> = Symbol('FormComponentDIKey')\n\nexport function provideFormContext<T extends FormPropsLike>(props: T): void {\n  if (props) {\n    provide(FormComponentDIKey, { formProps: props })\n  }\n}\n\nexport function injectFormContext(): {\n  /** 是否在表单中 */\n  inForm: boolean\n} & Partial<DIContext> {\n  const context = inject(FormComponentDIKey, undefined) || {}\n  return { inForm: !!context, ...context }\n}\n"],"mappings":";;AA+BA,MAAM,qBAA8C,OAAO,qBAAqB;AAEhF,SAAgB,mBAA4C,OAAgB;AAC1E,KAAI,MACF,SAAQ,oBAAoB,EAAE,WAAW,OAAO,CAAC;;AAIrD,SAAgB,oBAGO;CACrB,MAAM,UAAU,OAAO,oBAAoB,KAAA,EAAU,IAAI,EAAE;AAC3D,QAAO;EAAE,QAAQ,CAAC,CAAC;EAAS,GAAG;EAAS"}

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import { Data, PresetRule, ValidateRule, ValidatorConfig } from "./utils/form/validate.js";
 import { DeconstructValue, DefineEvent, Index, Null, RenderReturn, Undef } from "./helper.js";
 import { BreakpointName, ColorType, ComponentProps, ComponentSize, FormComponentProps, PropsWithServerQuery } from "./component-common.js";
-import { FormContextInjectProps } from "./form-context.js";
-export { BreakpointName, ColorType, ComponentProps, ComponentSize, Data, DeconstructValue, DefineEvent, FormComponentProps, FormContextInjectProps, Index, Null, PresetRule, PropsWithServerQuery, RenderReturn, Undef, ValidateRule, ValidatorConfig };
+import { FormContextModel, FormContextProps, injectFormContext, provideFormContext } from "./form-context.js";
+export { BreakpointName, ColorType, ComponentProps, ComponentSize, Data, DeconstructValue, DefineEvent, FormComponentProps, FormContextModel, FormContextProps, Index, Null, PresetRule, PropsWithServerQuery, RenderReturn, Undef, ValidateRule, ValidatorConfig, injectFormContext, provideFormContext };

package/dist/types/index.js

@@ -0,0 +1,2 @@
+import { injectFormContext, provideFormContext } from "./form-context.js";
+export { injectFormContext, provideFormContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veltra/utils",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "files": [
     "dist",
     "src"

package/src/types/form-context.ts

@@ -1,2 +1,46 @@
-/** 表单 provide/inject 上下文（完整 props 见 @veltra/desktop/types/form） */
-export type FormContextInjectProps = Record<string, unknown>
+import { type InjectionKey, inject, provide } from 'vue'
+
+import type { ComponentSize } from './component-common'
+
+export interface FormContextModel {
+  errors: Map<any, string[] | undefined>
+  fields: Record<string, { required?: unknown }>
+}
+
+export interface FormContextProps {
+  /** 表单列宽 */
+  labelWidth?: string | number
+  /** 表单尺寸 */
+  size?: ComponentSize
+  /** 是否禁用 */
+  disabled?: boolean
+  /** 是否只读 */
+  readonly?: boolean
+  /** 是否隐藏提示 */
+  noTips?: boolean
+  /** 表单数据模型 */
+  model?: FormContextModel
+}
+
+type FormPropsLike = Partial<FormContextProps> & Record<string, any>
+
+type DIContext = {
+  /** 表单属性 */
+  formProps: FormPropsLike
+}
+
+const FormComponentDIKey: InjectionKey<DIContext> = Symbol('FormComponentDIKey')
+
+export function provideFormContext<T extends FormPropsLike>(props: T): void {
+  if (props) {
+    provide(FormComponentDIKey, { formProps: props })
+  }
+}
+
+export function injectFormContext(): {
+  /** 是否在表单中 */
+  inForm: boolean
+} & Partial<DIContext> {
+  const context = inject(FormComponentDIKey, undefined) || {}
+  return { inForm: !!context, ...context }
+}