Skip to content

Show Overlay

Show Overlay는 화면에 Overlay를 표시하여 사용자 입력을 차단하는 Action이다.
Overlay는 로딩 중 사용자 행동을 제한하거나, 시스템 메시지를 표시하는 용도로 사용한다.

[그림 1. Component 단위의 Overlay 예시] Show Overlay Component 단위

해당 Action은 반드시 overlayKey를 설정하여 Overlay의 시작과 종료를 명확히 식별할 수 있도록 한다. Overlay를 종료하려면 Hide Overlay를 사용하며, 표시 중 메시지나 아이콘을 변경하려면 Change Overlay를 사용한다.

ShowOverlay Action 화면

개요

Show Overlay는 Component 또는 화면 단위로 Overlay를 띄우는 기능을 수행한다.
사용자는 Overlay를 통해 작업 진행 중 상태를 안내하거나, 일시적으로 UI 상호작용을 제한할 수 있다.

설정 방법

  • Action Parameter 유형: fixedData, fixedDataSelect만 사용 가능하다.
  • Overlay 표시는 overlayKey를 기준으로 제어하며, 동일 키를 사용하여 Hide 또는 Change 처리가 가능하다.
Parameter Key설명
overlayKeyOverlay 제어를 위한 고유 식별자. Show, Change, Hide 모두 동일하게 입력해야 한다.
displayAreaOverlay 표출 영역. Layout, Screen, Component 중 하나를 선택한다.
displayTargetIddisplayArea가 Component인 경우, 적용 대상 Component의 ID를 지정한다.
messageOverlay 위에 표시할 텍스트 메시지를 입력한다.
iconTypeOverlay에 표시할 아이콘 유형을 설정한다.

[그림 2. Show Overlay - overlayKey 설정 화면]
ShowOverlay Action Detail

[그림 3. Show Overlay - displayArea 설정 화면]
ShowOverlay Action Detail

INFO

displayArea를 설정하지 않으면, 기본적으로 현재 Action이 등록된 Component를 대상으로 Overlay가 표시된다.

iconType 목록

iconType아이콘 예시
basicIcon-basic
cloudIcon-cloud
ellipsisIcon-ellipsis
gearIcon-gear
straightIcon-straitgh