use-modal.ts 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  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. destroyOnClose: true,
  17. };
  18. export function setDefaultModalProps(props: Partial<ModalProps>) {
  19. Object.assign(DEFAULT_MODAL_PROPS, props);
  20. }
  21. export function useVbenModal<TParentModalProps extends ModalProps = ModalProps>(
  22. options: ModalApiOptions = {},
  23. ) {
  24. // Modal一般会抽离出来,所以如果有传入 connectedComponent,则表示为外部调用,与内部组件进行连接
  25. // 外部的Modal通过provide/inject传递api
  26. const { connectedComponent } = options;
  27. if (connectedComponent) {
  28. const extendedApi = reactive({});
  29. const isModalReady = ref(true);
  30. const Modal = defineComponent(
  31. (props: TParentModalProps, { attrs, slots }) => {
  32. provide(USER_MODAL_INJECT_KEY, {
  33. extendApi(api: ExtendedModalApi) {
  34. // 不能直接给 reactive 赋值,会丢失响应
  35. // 不能用 Object.assign,会丢失 api 的原型函数
  36. Object.setPrototypeOf(extendedApi, api);
  37. },
  38. options,
  39. async reCreateModal() {
  40. isModalReady.value = false;
  41. await nextTick();
  42. isModalReady.value = true;
  43. },
  44. });
  45. checkProps(extendedApi as ExtendedModalApi, {
  46. ...props,
  47. ...attrs,
  48. ...slots,
  49. });
  50. return () =>
  51. h(
  52. isModalReady.value ? connectedComponent : 'div',
  53. {
  54. ...props,
  55. ...attrs,
  56. },
  57. slots,
  58. );
  59. },
  60. {
  61. inheritAttrs: false,
  62. name: 'VbenParentModal',
  63. },
  64. );
  65. return [Modal, extendedApi as ExtendedModalApi] as const;
  66. }
  67. const injectData = inject<any>(USER_MODAL_INJECT_KEY, {});
  68. const mergedOptions = {
  69. ...DEFAULT_MODAL_PROPS,
  70. ...injectData.options,
  71. ...options,
  72. } as ModalApiOptions;
  73. mergedOptions.onOpenChange = (isOpen: boolean) => {
  74. options.onOpenChange?.(isOpen);
  75. injectData.options?.onOpenChange?.(isOpen);
  76. };
  77. mergedOptions.onClosed = () => {
  78. options.onClosed?.();
  79. if (mergedOptions.destroyOnClose) {
  80. injectData.reCreateModal?.();
  81. }
  82. };
  83. const api = new ModalApi(mergedOptions);
  84. const extendedApi: ExtendedModalApi = api as never;
  85. extendedApi.useStore = (selector) => {
  86. return useStore(api.store, selector);
  87. };
  88. const Modal = defineComponent(
  89. (props: ModalProps, { attrs, slots }) => {
  90. return () =>
  91. h(
  92. VbenModal,
  93. {
  94. ...props,
  95. ...attrs,
  96. modalApi: extendedApi,
  97. },
  98. slots,
  99. );
  100. },
  101. {
  102. inheritAttrs: false,
  103. name: 'VbenModal',
  104. },
  105. );
  106. injectData.extendApi?.(extendedApi);
  107. return [Modal, extendedApi] as const;
  108. }
  109. async function checkProps(api: ExtendedModalApi, attrs: Record<string, any>) {
  110. if (!attrs || Object.keys(attrs).length === 0) {
  111. return;
  112. }
  113. await nextTick();
  114. const state = api?.store?.state;
  115. if (!state) {
  116. return;
  117. }
  118. const stateKeys = new Set(Object.keys(state));
  119. for (const attr of Object.keys(attrs)) {
  120. if (stateKeys.has(attr) && !['class'].includes(attr)) {
  121. // connectedComponent存在时,不要传入Modal的props,会造成复杂度提升,如果你需要修改Modal的props,请使用 useModal 或者api
  122. console.warn(
  123. `[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.`,
  124. );
  125. }
  126. }
  127. }