feat: rewrite to use app config and rework docs (#143)

Co-authored-by: Daniel Roe <daniel@roe.dev>
Co-authored-by: Sébastien Chopin <seb@nuxt.com>

src/runtime/components/overlays/Modal.vue

@@ -1,39 +1,15 @@
 <template>
   <TransitionRoot :appear="appear" :show="isOpen" as="template">
-    <Dialog :class="wrapperClass" @close="close">
-      <TransitionChild
-        v-if="overlay"
-        as="template"
-        :appear="appear"
-        v-bind="overlayTransition"
-      >
-        <div class="fixed inset-0 transition-opacity" :class="overlayBackgroundClass" />
+    <Dialog :class="ui.wrapper" @close="close">
+      <TransitionChild v-if="overlay" as="template" :appear="appear" v-bind="ui.overlay.transition">
+        <div :class="[ui.overlay.base, ui.overlay.background]" />
       </TransitionChild>
 
-      <div :class="innerClass" :style="innerStyle">
-        <div :class="containerClass">
-          <TransitionChild
-            as="template"
-            :appear="appear"
-            v-bind="modalTransition"
-          >
-            <DialogPanel :class="modalClass">
-              <Card
-                base-class=""
-                background-class=""
-                shadow-class=""
-                ring-class=""
-                rounded-class=""
-                v-bind="$attrs"
-              >
-                <template v-if="$slots.header" #header>
-                  <slot name="header" />
-                </template>
-                <slot />
-                <template v-if="$slots.footer" #footer>
-                  <slot name="footer" />
-                </template>
-              </Card>
+      <div :class="ui.inner">
+        <div :class="[ui.container, ui.spacing]">
+          <TransitionChild as="template" :appear="appear" v-bind="ui.transition">
+            <DialogPanel :class="[ui.base, ui.width, ui.height, ui.background, ui.ring, ui.rounded, ui.shadow]">
+              <slot />
             </DialogPanel>
           </TransitionChild>
         </div>
@@ -42,131 +18,75 @@
   </TransitionRoot>
 </template>
 
-<script setup lang="ts">
-import { computed } from 'vue'
-import { Dialog, DialogPanel, TransitionRoot, TransitionChild } from '@headlessui/vue'
-import { classNames } from '../../utils'
-import Card from '../layout/Card.vue'
-import $ui from '#build/ui'
-
-const props = defineProps({
-  modelValue: {
-    type: Boolean,
-    default: false
-  },
-  appear: {
-    type: Boolean,
-    default: false
-  },
-  wrapperClass: {
-    type: String,
-    default: () => $ui.modal.wrapper
-  },
-  innerClass: {
-    type: String,
-    default: () => $ui.modal.inner
-  },
-  innerStyle: {
-    type: Object,
-    default: () => ({})
-  },
-  containerClass: {
-    type: String,
-    default: () => $ui.modal.container
-  },
-  baseClass: {
-    type: String,
-    default: () => $ui.modal.base
-  },
-  backgroundClass: {
-    type: String,
-    default: () => $ui.modal.background
-  },
-  overlay: {
-    type: Boolean,
-    default: true
-  },
-  overlayBackgroundClass: {
-    type: String,
-    default: () => $ui.modal.overlay.background
-  },
-  overlayTransitionClass: {
-    type: Object,
-    default: () => $ui.modal.overlay.transition
-  },
-  shadowClass: {
-    type: String,
-    default: () => $ui.modal.shadow
-  },
-  ringClass: {
-    type: String,
-    default: () => $ui.modal.ring
-  },
-  roundedClass: {
-    type: String,
-    default: () => $ui.modal.rounded
-  },
-  widthClass: {
-    type: String,
-    default: () => $ui.modal.width
-  },
-  transition: {
-    type: Boolean,
-    default: true
-  },
-  transitionClass: {
-    type: Object,
-    default: () => $ui.modal.transition
-  }
-})
-
-const emit = defineEmits(['update:modelValue', 'close'])
-
-const isOpen = computed({
-  get () {
-    return props.modelValue
-  },
-  set (value) {
-    emit('update:modelValue', value)
-  }
-})
-
-const modalClass = computed(() => {
-  return classNames(
-    props.baseClass,
-    props.widthClass,
-    props.backgroundClass,
-    props.shadowClass,
-    props.ringClass,
-    props.roundedClass
-  )
-})
-
-const overlayTransition = computed(() => {
-  if (!props.transition) {
-    return {}
-  }
-
-  return props.overlayTransitionClass
-})
-
-const modalTransition = computed(() => {
-  if (!props.transition) {
-    return {}
-  }
-
-  return props.transitionClass
-})
-
-function close (value: boolean) {
-  isOpen.value = value
-  emit('close')
-}
-</script>
-
 <script lang="ts">
-export default {
-  name: 'UModal',
-  inheritAttrs: false
-}
+import { computed, defineComponent } from 'vue'
+import type { PropType } from 'vue'
+import { defu } from 'defu'
+import { Dialog, DialogPanel, TransitionRoot, TransitionChild } from '@headlessui/vue'
+import { useAppConfig } from '#imports'
+// TODO: Remove
+// @ts-expect-error
+import appConfig from '#build/app.config'
+
+// const appConfig = useAppConfig()
+
+export default defineComponent({
+  components: {
+    // eslint-disable-next-line vue/no-reserved-component-names
+    Dialog,
+    DialogPanel,
+    TransitionRoot,
+    TransitionChild
+  },
+  props: {
+    modelValue: {
+      type: Boolean,
+      default: false
+    },
+    appear: {
+      type: Boolean,
+      default: false
+    },
+    overlay: {
+      type: Boolean,
+      default: true
+    },
+    transition: {
+      type: Boolean,
+      default: true
+    },
+    ui: {
+      type: Object as PropType<Partial<typeof appConfig.ui.modal>>,
+      default: () => appConfig.ui.modal
+    }
+  },
+  emits: ['update:modelValue', 'close'],
+  setup (props, { emit }) {
+    // TODO: Remove
+    const appConfig = useAppConfig()
+
+    const ui = computed<Partial<typeof appConfig.ui.modal>>(() => defu({}, props.ui, appConfig.ui.modal))
+
+    const isOpen = computed({
+      get () {
+        return props.modelValue
+      },
+      set (value) {
+        emit('update:modelValue', value)
+      }
+    })
+
+    function close (value: boolean) {
+      isOpen.value = value
+      emit('close')
+    }
+
+    return {
+      // eslint-disable-next-line vue/no-dupe-keys
+      ui,
+      isOpen,
+      close
+    }
+  }
+})
 </script>