Skip to content

UnifiedModal

A Vue component.

File: src/components/shared/UnifiedModal.vue

Overview

Props

NameTypeDefaultRequiredDescription
modelValuebooleanundefinedNo description
titlestringundefinedNo description
subtitlestringundefinedNo description
iconanyundefinedNo description
sizeunion'md'No description
fullHeightbooleanundefinedNo description
hideHeaderbooleanundefinedNo description
showCloseButtonbooleantrueNo description
closeOnOverlaybooleantrueNo description
closeOnEscapebooleantrueNo description
persistentbooleanfalseNo description
containerClassstringundefinedNo description
actionsArrayundefinedNo description
closeButtonLabelstring'Close modal'No description
isProfilebooleanundefinedNo description
noPaddingbooleanundefinedNo description

Props Details

modelValue

No description available.

  • Type: boolean
  • Required: Yes
  • Default: undefined

title

No description available.

  • Type: string
  • Required: No
  • Default: undefined

subtitle

No description available.

  • Type: string
  • Required: No
  • Default: undefined

icon

No description available.

  • Type: any
  • Required: No
  • Default: undefined

size

No description available.

  • Type: union
  • Required: No
  • Default: 'md'

fullHeight

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

hideHeader

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

showCloseButton

No description available.

  • Type: boolean
  • Required: No
  • Default: true

closeOnOverlay

No description available.

  • Type: boolean
  • Required: No
  • Default: true

closeOnEscape

No description available.

  • Type: boolean
  • Required: No
  • Default: true

persistent

No description available.

  • Type: boolean
  • Required: No
  • Default: false

containerClass

No description available.

  • Type: string
  • Required: No
  • Default: undefined

actions

No description available.

  • Type: Array
  • Required: No
  • Default: undefined

closeButtonLabel

No description available.

  • Type: string
  • Required: No
  • Default: 'Close modal'

isProfile

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

noPadding

No description available.

  • Type: boolean
  • Required: No
  • Default: undefined

Events

NameParametersDescription
update:modelValuebooleanNo description
closeunknownNo description
openunknownNo description
actionModalActionNo description

Event Details

update:modelValue

No description available.

Parameters: boolean

close

No description available.

Parameters: unknown

open

No description available.

Parameters: unknown

action

No description available.

Parameters: ModalAction

Slots

NameScopedDescription
customHeaderNo description
iconNo description
header-contentNo description
defaultNo description
footerNo description

Slot Details

customHeader

No description available.

Scoped: No

icon

No description available.

Scoped: No

header-content

No description available.

Scoped: No

default

No description available.

Scoped: No

No description available.

Scoped: No

Methods

This component exposes no public methods.

Usage Example

vue
<template>
  <UnifiedModal
    :modelValue="true"
    @update:modelValue="handleUpdate:modelValue"
    @close="handleClose"
    @open="handleOpen"
    @action="handleAction">
    <template #customHeader>
      <!-- Slot content for customHeader -->
    </template>
    <template #icon>
      <!-- Slot content for icon -->
    </template>
    <template #header-content>
      <!-- Slot content for header-content -->
    </template>
    <template #default>
      <!-- Slot content for default -->
    </template>
    <template #footer>
      <!-- Slot content for footer -->
    </template>
  </UnifiedModal>
</template>

<script setup lang="ts">
const handleUpdate:modelValue = (data: boolean) => {
  // Handle update:modelValue event
}

const handleClose = (data: unknown) => {
  // Handle close event
}

const handleOpen = (data: unknown) => {
  // Handle open event
}

const handleAction = (data: ModalAction) => {
  // Handle action event
}
</script>

File Location

src/components/shared/UnifiedModal.vue


This documentation was automatically generated from the component source code.

Released under the AGPL-3.0 License.