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/Slideover.vue

@@ -1,24 +1,12 @@
 <template>
   <TransitionRoot as="template" :appear="appear" :show="isOpen">
-    <Dialog :class="[wrapperClass, { 'justify-end': side === 'right' }]" @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, { 'justify-end': side === 'right' }]" @close="close">
+      <TransitionChild v-if="overlay" as="template" :appear="appear" v-bind="ui.overlay.transition">
+        <div :class="[ui.overlay.base, ui.overlay.background]" />
       </TransitionChild>
 
-      <TransitionChild
-        as="template"
-        :appear="appear"
-        v-bind="slideoverTransition"
-      >
-        <DialogPanel :class="slideoverClass">
-          <div v-if="$slots.header" :class="headerClass">
-            <slot name="header" />
-          </div>
+      <TransitionChild as="template" :appear="appear" v-bind="transitionClass">
+        <DialogPanel :class="[ui.base, ui.width, ui.background, ui.ring]">
           <slot />
         </DialogPanel>
       </TransitionChild>
@@ -26,116 +14,95 @@
   </TransitionRoot>
 </template>
 
-<script setup lang="ts">
-import { computed } from 'vue'
-import type { WritableComputedRef, PropType } from 'vue'
-import { Dialog, DialogPanel, TransitionRoot, TransitionChild } from '@headlessui/vue'
-import { classNames } from '../../utils'
-import $ui from '#build/ui'
-
-const props = defineProps({
-  modelValue: {
-    type: Boolean as PropType<boolean>,
-    default: false
-  },
-  appear: {
-    type: Boolean,
-    default: false
-  },
-  side: {
-    type: String,
-    default: 'left',
-    validator: (value: string) => ['left', 'right'].includes(value)
-  },
-  wrapperClass: {
-    type: String,
-    default: () => $ui.slideover.wrapper
-  },
-  baseClass: {
-    type: String,
-    default: () => $ui.slideover.base
-  },
-  backgroundClass: {
-    type: String,
-    default: () => $ui.slideover.background
-  },
-  overlay: {
-    type: Boolean,
-    default: true
-  },
-  overlayBackgroundClass: {
-    type: String,
-    default: () => $ui.slideover.overlay.background
-  },
-  overlayTransitionClass: {
-    type: Object,
-    default: () => $ui.slideover.overlay.transition
-  },
-  widthClass: {
-    type: String,
-    default: () => $ui.slideover.width
-  },
-  headerClass: {
-    type: String,
-    default: () => $ui.slideover.header
-  },
-  transition: {
-    type: Boolean,
-    default: true
-  },
-  transitionClass: {
-    type: Object,
-    default: () => $ui.slideover.transition
-  }
-})
-
-const emit = defineEmits(['update:modelValue', 'close'])
-
-const isOpen: WritableComputedRef<boolean> = computed({
-  get () {
-    return props.modelValue
-  },
-  set (value) {
-    emit('update:modelValue', value)
-  }
-})
-
-const slideoverClass = computed(() => {
-  return classNames(
-    props.baseClass,
-    props.widthClass,
-    props.backgroundClass
-  )
-})
-
-const overlayTransition = computed(() => {
-  if (!props.transition) {
-    return {}
-  }
-
-  return props.overlayTransitionClass
-})
-
-const slideoverTransition = computed(() => {
-  if (!props.transition) {
-    return {}
-  }
-
-  return {
-    enterFrom: props.side === 'left' ? '-translate-x-full' : 'translate-x-full',
-    enterTo: 'translate-x-0',
-    leaveFrom: 'translate-x-0',
-    leaveTo: props.side === 'left' ? '-translate-x-full' : 'translate-x-full',
-    ...props.transitionClass
-  }
-})
-
-function close (value: boolean) {
-  isOpen.value = value
-  emit('close')
-}
-</script>
-
 <script lang="ts">
-export default { name: 'USlideover' }
+import { computed, defineComponent } from 'vue'
+import type { WritableComputedRef, 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 as PropType<boolean>,
+      default: false
+    },
+    appear: {
+      type: Boolean,
+      default: false
+    },
+    side: {
+      type: String,
+      default: 'left',
+      validator: (value: string) => ['left', 'right'].includes(value)
+    },
+    overlay: {
+      type: Boolean,
+      default: true
+    },
+    transition: {
+      type: Boolean,
+      default: true
+    },
+    ui: {
+      type: Object as PropType<Partial<typeof appConfig.ui.slideover>>,
+      default: () => appConfig.ui.slideover
+    }
+  },
+  emits: ['update:modelValue', 'close'],
+  setup (props, { emit }) {
+    // TODO: Remove
+    const appConfig = useAppConfig()
+
+    const ui = computed<Partial<typeof appConfig.ui.slideover>>(() => defu({}, props.ui, appConfig.ui.slideover))
+
+    const isOpen: WritableComputedRef<boolean> = computed({
+      get () {
+        return props.modelValue
+      },
+      set (value) {
+        emit('update:modelValue', value)
+      }
+    })
+
+    const transitionClass = computed(() => {
+      if (!props.transition) {
+        return {}
+      }
+
+      return {
+        ...ui.value.transition,
+        enterFrom: props.side === 'left' ? '-translate-x-full' : 'translate-x-full',
+        enterTo: 'translate-x-0',
+        leaveFrom: 'translate-x-0',
+        leaveTo: props.side === 'left' ? '-translate-x-full' : 'translate-x-full'
+      }
+    })
+
+    function close (value: boolean) {
+      isOpen.value = value
+      emit('close')
+    }
+
+    return {
+      // eslint-disable-next-line vue/no-dupe-keys
+      ui,
+      isOpen,
+      transitionClass,
+      close
+    }
+  }
+})
 </script>