use-modal.ts 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. import type { ExtendedModalApi, ModalApiOptions, ModalProps } from './modal';
  2. import {
  3. defineComponent,
  4. h,
  5. inject,
  6. nextTick,
  7. provide,
  8. reactive,
  9. ref,
  10. } from 'vue';
  11. import { useStore } from '@vben-core/shared/store';
  12. import { ModalApi } from './modal-api';
  13. import VbenModal from './modal.vue';
  14. const USER_MODAL_INJECT_KEY = Symbol('VBEN_MODAL_INJECT');
  15. const DEFAULT_MODAL_PROPS: Partial<ModalProps> = {};
  16. export function setDefaultModalProps(props: Partial<ModalProps>) {
  17. Object.assign(DEFAULT_MODAL_PROPS, props);
  18. }
  19. export function useVbenModal<TParentModalProps extends ModalProps = ModalProps>(
  20. options: ModalApiOptions = {},
  21. ) {
  22. // Modal一般会抽离出来,所以如果有传入 connectedComponent,则表示为外部调用,与内部组件进行连接
  23. // 外部的Modal通过provide/inject传递api
  24. const { connectedComponent } = options;
  25. if (connectedComponent) {
  26. const extendedApi = reactive({});
  27. const isModalReady = ref(true);
  28. const Modal = defineComponent(
  29. (props: TParentModalProps, { attrs, slots }) => {
  30. provide(USER_MODAL_INJECT_KEY, {
  31. extendApi(api: ExtendedModalApi) {
  32. // 不能直接给 reactive 赋值,会丢失响应
  33. // 不能用 Object.assign,会丢失 api 的原型函数
  34. Object.setPrototypeOf(extendedApi, api);
  35. },
  36. consumed: false,
  37. options,
  38. async reCreateModal() {
  39. isModalReady.value = false;
  40. await nextTick();
  41. isModalReady.value = true;
  42. },
  43. });
  44. checkProps(extendedApi as ExtendedModalApi, {
  45. ...props,
  46. ...attrs,
  47. ...slots,
  48. });
  49. return () =>
  50. h(
  51. isModalReady.value ? connectedComponent : 'div',
  52. {
  53. ...props,
  54. ...attrs,
  55. },
  56. slots,
  57. );
  58. },
  59. // eslint-disable-next-line vue/one-component-per-file
  60. {
  61. name: 'VbenParentModal',
  62. inheritAttrs: false,
  63. },
  64. );
  65. return [Modal, extendedApi as ExtendedModalApi] as const;
  66. }
  67. let injectData = inject<any>(USER_MODAL_INJECT_KEY, {});
  68. // 这个数据已经被使用了,说明这个弹窗是嵌套的弹窗,不应该merge上层的配置
  69. if (injectData.consumed) {
  70. injectData = {};
  71. } else {
  72. injectData.consumed = true;
  73. }
  74. const mergedOptions = {
  75. ...DEFAULT_MODAL_PROPS,
  76. ...injectData.options,
  77. ...options,
  78. } as ModalApiOptions;
  79. mergedOptions.onOpenChange = (isOpen: boolean) => {
  80. options.onOpenChange?.(isOpen);
  81. injectData.options?.onOpenChange?.(isOpen);
  82. };
  83. const onClosed = mergedOptions.onClosed;
  84. mergedOptions.onClosed = () => {
  85. onClosed?.();
  86. if (mergedOptions.destroyOnClose) {
  87. injectData.consumed = false;
  88. injectData.reCreateModal?.();
  89. }
  90. };
  91. const api = new ModalApi(mergedOptions);
  92. const extendedApi: ExtendedModalApi = api as never;
  93. extendedApi.useStore = (selector) => {
  94. return useStore(api.store, selector);
  95. };
  96. const Modal = defineComponent(
  97. (props: ModalProps, { attrs, slots }) => {
  98. return () =>
  99. h(
  100. VbenModal,
  101. {
  102. ...props,
  103. ...attrs,
  104. modalApi: extendedApi,
  105. },
  106. slots,
  107. );
  108. },
  109. // eslint-disable-next-line vue/one-component-per-file
  110. {
  111. name: 'VbenModal',
  112. inheritAttrs: false,
  113. },
  114. );
  115. injectData.extendApi?.(extendedApi);
  116. return [Modal, extendedApi] as const;
  117. }
  118. async function checkProps(api: ExtendedModalApi, attrs: Record<string, any>) {
  119. if (!attrs || Object.keys(attrs).length === 0) {
  120. return;
  121. }
  122. await nextTick();
  123. const state = api?.store?.state;
  124. if (!state) {
  125. return;
  126. }
  127. const stateKeys = new Set(Object.keys(state));
  128. for (const attr of Object.keys(attrs)) {
  129. if (stateKeys.has(attr) && !['class'].includes(attr)) {
  130. // connectedComponent存在时,不要传入Modal的props,会造成复杂度提升,如果你需要修改Modal的props,请使用 useModal 或者api
  131. console.warn(
  132. `[Vben Modal]: When 'connectedComponent' exists, do not set props or slots '${attr}', which will increase complexity. If you need to modify the props of Modal, please use useVbenModal or api.`,
  133. );
  134. }
  135. }
  136. }