element-plus
Version:
A Component Library for Vue 3
1 lines • 4.43 kB
Source Map (JSON)
{"version":3,"file":"index.mjs","names":[],"sources":["../../../../../packages/hooks/use-empty-values/index.ts"],"sourcesContent":["import { computed, getCurrentInstance, inject, ref } from 'vue'\nimport {\n buildProps,\n debugWarn,\n definePropType,\n isArray,\n isFunction,\n} from '@element-plus/utils'\nimport { isEqual } from 'lodash-unified'\n\nimport type { InjectionKey, Ref } from 'vue'\n\n// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\ntype ValueOnClear = string | number | boolean | Function | null\n\nexport interface UseEmptyValuesProps {\n /**\n * @description empty values supported by the component\n */\n emptyValues?: unknown[]\n /**\n * @description return value when cleared, if you want to set `undefined`, use `() => undefined`\n */\n valueOnClear?: ValueOnClear\n}\n\nexport const emptyValuesContextKey: InjectionKey<Ref<UseEmptyValuesProps>> =\n Symbol('emptyValuesContextKey')\nexport const SCOPE = 'use-empty-values'\nexport const DEFAULT_EMPTY_VALUES = ['', undefined, null]\nexport const DEFAULT_VALUE_ON_CLEAR = undefined\n\n/**\n * @deprecated Removed after 3.0.0, Use `UseEmptyValuesProps` instead.\n */\nexport const useEmptyValuesProps = buildProps({\n /**\n * @description empty values supported by the component\n */\n emptyValues: Array,\n /**\n * @description return value when cleared, if you want to set `undefined`, use `() => undefined`\n */\n valueOnClear: {\n /* eslint-disable-next-line @typescript-eslint/no-unsafe-function-type */\n type: definePropType<string | number | boolean | Function | null>([\n String,\n Number,\n Boolean,\n Function,\n ]),\n default: undefined,\n validator: (val: unknown) => {\n val = isFunction(val) ? val() : val\n if (isArray(val)) {\n return val.every((item) => !item)\n }\n return !val\n },\n },\n} as const)\n\nexport const useEmptyValues = (\n props: UseEmptyValuesProps,\n defaultValue?: null | undefined\n) => {\n const config = getCurrentInstance()\n ? inject(emptyValuesContextKey, ref<UseEmptyValuesProps>({}))\n : ref<UseEmptyValuesProps>({})\n\n const emptyValues = computed(\n () => props.emptyValues || config.value.emptyValues || DEFAULT_EMPTY_VALUES\n )\n\n const valueOnClear = computed(() => {\n // function is used for undefined cause undefined can't be a value of prop\n if (isFunction(props.valueOnClear)) {\n return props.valueOnClear()\n } else if (props.valueOnClear !== undefined) {\n return props.valueOnClear\n } else if (isFunction(config.value.valueOnClear)) {\n return config.value.valueOnClear()\n } else if (config.value.valueOnClear !== undefined) {\n return config.value.valueOnClear\n }\n return defaultValue !== undefined ? defaultValue : DEFAULT_VALUE_ON_CLEAR\n })\n\n const isEmptyValue = (value: unknown) => {\n let result = true\n if (isArray(value)) {\n result = emptyValues.value.some((emptyValue) => {\n return isEqual(value, emptyValue)\n })\n } else {\n result = emptyValues.value.includes(value)\n }\n return result\n }\n\n if (!isEmptyValue(valueOnClear.value)) {\n debugWarn(SCOPE, 'value-on-clear should be a value of empty-values')\n }\n\n return {\n emptyValues,\n valueOnClear,\n isEmptyValue,\n }\n}\n"],"mappings":";;;;;;AA0BA,MAAa,wBACX,OAAO,wBAAwB;AACjC,MAAa,QAAQ;AACrB,MAAa,uBAAuB;CAAC;CAAI,KAAA;CAAW;CAAK;AACzD,MAAa,yBAAyB,KAAA;;;;AAKtC,MAAa,sBAAsB,WAAW;;;;CAI5C,aAAa;;;;CAIb,cAAc;EAEZ,MAAM,eAA4D;GAChE;GACA;GACA;GACA;GACD,CAAC;EACF,SAAS,KAAA;EACT,YAAY,QAAiB;GAC3B,MAAM,WAAW,IAAI,GAAG,KAAK,GAAG;GAChC,IAAI,QAAQ,IAAI,EACd,OAAO,IAAI,OAAO,SAAS,CAAC,KAAK;GAEnC,OAAO,CAAC;;EAEX;CACF,CAAU;AAEX,MAAa,kBACX,OACA,iBACG;CACH,MAAM,SAAS,oBAAoB,GAC/B,OAAO,uBAAuB,IAAyB,EAAE,CAAC,CAAC,GAC3D,IAAyB,EAAE,CAAC;CAEhC,MAAM,cAAc,eACZ,MAAM,eAAe,OAAO,MAAM,eAAe,qBACxD;CAED,MAAM,eAAe,eAAe;EAElC,IAAI,WAAW,MAAM,aAAa,EAChC,OAAO,MAAM,cAAc;OACtB,IAAI,MAAM,iBAAiB,KAAA,GAChC,OAAO,MAAM;OACR,IAAI,WAAW,OAAO,MAAM,aAAa,EAC9C,OAAO,OAAO,MAAM,cAAc;OAC7B,IAAI,OAAO,MAAM,iBAAiB,KAAA,GACvC,OAAO,OAAO,MAAM;EAEtB,OAAO,iBAAiB,KAAA,IAAY,eAAA,KAAA;GACpC;CAEF,MAAM,gBAAgB,UAAmB;EACvC,IAAI,SAAS;EACb,IAAI,QAAQ,MAAM,EAChB,SAAS,YAAY,MAAM,MAAM,eAAe;GAC9C,OAAO,QAAQ,OAAO,WAAW;IACjC;OAEF,SAAS,YAAY,MAAM,SAAS,MAAM;EAE5C,OAAO;;CAGT,IAAI,CAAC,aAAa,aAAa,MAAM,EACnC,UAAU,OAAO,mDAAmD;CAGtE,OAAO;EACL;EACA;EACA;EACD"}