Dialog

모달 또는 비모달 방식으로 페이지 위에 포커스된 내용을 엽니다.

용법

모달

열린 대화상자 안에 포커스를 유지하고 닫을 때 실행 요소로 되돌립니다.

<!-- Dialog / Modal -->
<script setup lang="ts">
import { DialogRoot, DialogTrigger, DialogOverlay, DialogContent, DialogTitle, DialogDescription, DialogClose } from '@sectile/vue/dialog'
</script>

<template>
  <DialogRoot>
    <DialogTrigger>Open deployment</DialogTrigger>
    <DialogOverlay class="dialog-overlay" />
    <DialogContent>
      <DialogTitle>Deployment</DialogTitle>
      <DialogDescription>Review the release before continuing.</DialogDescription>
      <DialogClose>Close</DialogClose>
    </DialogContent>
  </DialogRoot>
</template>

비모달 모달

대화상자가 열려 있어도 주변 내용을 계속 조작할 수 있습니다.

<!-- Dialog / Non Modal -->
<script setup lang="ts">
import { DialogRoot, DialogTrigger, DialogContent, DialogTitle, DialogDescription, DialogClose } from '@sectile/vue/dialog'
</script>

<template>
  <DialogRoot :modal="false">
    <DialogTrigger>Open deployment details</DialogTrigger>
    <DialogContent>
      <DialogTitle>Deployment details</DialogTitle>
      <DialogDescription>
        Keep the page interactive while these details remain open.
      </DialogDescription>
      <DialogClose>Close</DialogClose>
    </DialogContent>
  </DialogRoot>
</template>

외부 상태 관리

현재 값은 부모가 관리하고, 허용된 변경을 컴포넌트에 다시 전달합니다.

<!-- Dialog / Controlled -->
<script setup lang="ts">
import { DialogRoot, DialogTrigger, DialogOverlay, DialogContent, DialogTitle, DialogDescription, DialogClose } from '@sectile/vue/dialog'
import { ref } from 'vue'

const open = ref(false)

</script>

<template>
  <DialogRoot v-model:open="open">
    <DialogTrigger>Open deployment</DialogTrigger>
    <DialogOverlay class="dialog-overlay" />
    <DialogContent>
      <DialogTitle>Deployment</DialogTitle>
      <DialogDescription>Review the release before continuing.</DialogDescription>
      <DialogClose>Close</DialogClose>
    </DialogContent>
  </DialogRoot>
</template>

외부 조작

closeOnInteractOutside로 콘텐츠 밖의 포인터 조작이 컴포넌트를 닫을지 정합니다. interactOutsideExclusions에 넣은 요소는 모달에서도 계속 조작할 수 있으며 외부 조작 판정에서 제외됩니다. 조건부로 유지하려면 interact-outside 이벤트에서 preventDefault()를 호출합니다.

template

<DialogRoot
  :interact-outside-exclusions="[ignoredElement]"
  @interact-outside="(event) => {
    if (event.isInside(temporarilyIgnoredElement)) event.preventDefault()
  }"
/>

API

Vue 패키지: @sectile/vue/dialog

컴포넌트

DialogRoot
DialogTrigger
DialogPortal
DialogOverlay
DialogContent
DialogTitle
DialogDescription
DialogClose

Props

`DialogRootProps`

align: 타입PositionAlign기본값'center'
기준 요소를 중심으로 팝업 내용을 정렬할 위치입니다.
arrowPadding: 타입number기본값8
화살표와 팝업 가장자리 사이에 둘 최소 간격입니다.
autoFocus: 타입boolean기본값true
열릴 때 컴포넌트 안으로 포커스를 옮길지 여부입니다.
avoidCollisions: 타입boolean기본값true
팝업이 화면 안에 남도록 위치를 뒤집거나 이동할지 여부입니다.
closeOnInteractOutside: 타입boolean기본값true
콘텐츠 밖을 조작하면 닫을지 여부입니다.
collisionBoundary: 타입PositionBoundary기본값undefined
팝업을 화면 안에 유지할 때 사용할 경계입니다.
collisionPadding: 타입PositionPadding기본값8
팝업과 충돌 경계 사이에 둘 간격입니다.
defaultOpen: 타입boolean기본값false
컴포넌트가 관리하는 초기 열림 상태입니다.
disabled: 타입boolean기본값false
사용자 조작을 막을지 여부입니다.
hideWhenDetached: 타입boolean기본값false
기준 요소가 레이아웃에서 벗어나면 팝업을 숨길지 여부입니다.
initialFocus: 타입HTMLElement기본값undefined
컴포넌트가 열릴 때 포커스를 받을 요소 또는 요소를 반환하는 함수입니다.
interactOutsideExclusions: 타입readonly HTMLElement[]기본값undefined
계속 조작할 수 있는 외부 조작 판정 제외 요소 목록입니다.
label: 타입string기본값undefined
보조 기술이 읽는 컨트롤 이름입니다.
modal: 타입boolean기본값true
열린 콘텐츠가 주변 페이지 조작을 막을지 여부입니다.
open: 타입boolean기본값undefined
연결된 팝업이나 펼침 영역이 열려 있는지 여부입니다.
restoreFocus: 타입boolean기본값true
열린 콘텐츠를 닫을 때 실행 요소로 포커스를 되돌릴지 여부입니다.
side: 타입PositionSide기본값'bottom'
기준 요소를 중심으로 팝업을 우선 배치할 방향입니다.
sideOffset: 타입number기본값8
팝업과 기준 요소 사이 거리입니다.
strategy: 타입PositionStrategy기본값'absolute'
기준 요소에 연결된 콘텐츠의 CSS 위치 전략입니다.
tracking: 타입PositionTracking기본값undefined
기준 요소에 연결된 콘텐츠가 열린 동안 위치를 갱신할 방식입니다.
trapFocus: 타입boolean기본값true
열린 콘텐츠 안에 키보드 포커스를 유지할지 여부입니다.
unmountOnExit: 타입boolean기본값false
닫힘 모션이 끝난 뒤 presence 관리 콘텐츠를 DOM에서 제거할지 여부입니다.

`DialogPartProps`

as: 타입PrimitiveAs기본값파트별로 다름
이 파트가 렌더링할 요소 또는 컴포넌트입니다.
asChild: 타입boolean기본값false
하나뿐인 자식 요소에 파트 속성을 직접 합칠지 여부입니다.

`DialogPortalProps`

defer: 타입boolean기본값false
Teleport 대상을 현재 mount 또는 update tick이 끝날 때 찾을지 여부입니다.
disabled: 타입boolean기본값false
사용자 조작을 막을지 여부입니다.
to: 타입string | HTMLElement기본값'body'
포털 콘텐츠를 옮길 대상입니다.

슬롯

`DialogRootSlotProps`

disabled: 타입boolean
사용자 조작을 막을지 여부입니다.
open: 타입boolean
연결된 팝업이나 펼침 영역이 열려 있는지 여부입니다.

기타 타입

`DialogOpenChangeHandler`

type DialogOpenChangeHandler = PopupFactoryOptions['onOpenChange']

`DialogInteractOutsideHandler`

type DialogInteractOutsideHandler = NonNullable<PopupFactoryOptions['onInteractOutside']>

파트

공통 범위: [data-scope="dialog"]. 컴포넌트 내부로 스타일을 제한할 때 파트 선택자와 함께 사용합니다.

파트	선택자	역할	추가 속성
`trigger`	`[data-part="trigger"]`	연결된 콘텐츠를 열고 닫거나 활성화합니다.	—
`overlay`	`[data-part="overlay"]`	모달이 열린 동안 주변 콘텐츠를 덮습니다.	—
`content`	`[data-part="content"]`	현재 상태에 맞는 컴포넌트 콘텐츠를 담습니다.	—
`title`	`[data-part="title"]`	연결된 콘텐츠의 제목을 표시합니다.	—
`description`	`[data-part="description"]`	연결된 콘텐츠나 결정 내용을 설명합니다.	—
`close`	`[data-part="close"]`	현재 화면을 닫거나 해제합니다.	—

키보드 동작

키	동작
`Enter` / `Space`	실행 요소나 포커스된 작업을 실행합니다.
`Tab` / `Shift+Tab`	사용 가능한 컨트롤 사이를 이동하며 모달 내용은 포커스를 내부에 유지합니다.
`Escape`	팝업을 닫고 설정된 경우 포커스를 복원합니다.

접근성

대화상자는 제목과 설명을 연결하고 모달 배경을 격리하며 포커스를 가두고 페이지 스크롤을 잠근 뒤 닫힐 때 포커스를 복원합니다.

관련 WAI-ARIA 패턴에서 호스트 접근성 규칙을 확인할 수 있습니다.

Dialog ​

용법 ​

모달 ​

비모달 모달 ​

외부 상태 관리 ​

외부 조작 ​

API ​

Props ​

DialogRootProps ​

DialogPartProps ​

DialogPortalProps ​

슬롯 ​

DialogRootSlotProps ​

기타 타입 ​

DialogOpenChangeHandler ​

DialogInteractOutsideHandler ​

파트 ​

키보드 동작 ​

접근성 ​