Files
Gnuboard7/docs/frontend/actions-handlers-navigation.md
T
HeuJung bd215bc586 feat(identity): NHN KCP 휴대폰 본인확인 플러그인 추가
메일 인증 대신 휴대폰 본인확인을 쓸 수 있게 하는 플러그인을 추가한다.
가입·비밀번호 재설정·성인인증 등 코어 IDV 가 강제하는 모든 지점에서 동작하며,
테스트 모드로 계약 없이 전 흐름을 확인할 수 있다.

구현·검수 과정에서 드러난 저장소 전역 결함을 함께 처리했다.

- 외래키 컬럼의 한국어 comment 가 방출되지 않던 문제 (소스 38건 교정 +
 기설치본 백필 업그레이드 스텝 7종). ->comment 를 ->constrained 뒤에
 체인하면 예외 없이 통과하면서 comment 가 조용히 사라진다
- 로케일 전환 후 확장 액션 핸들러가 소실되던 문제 (플러그인 3종에
 재등록 진입점 노출)
- 본인인증 상태 폴링 응답이 누적 시도 횟수를 함께 내보내던 문제
- 인증 안내 문구와 실제 진행 방식의 폭 경계 불일치 (768~1023px).
 엔진과 같은 값을 같은 방법으로 읽도록 교정
- transition_overlay_target 이 replace 없이 무효이던 관리자 목록 40곳.
 로딩 표시가 나오지 않아도 경고가 남지 않아 화면을 봐야만 알 수 있었다

두 인증 플러그인의 코어 최소 요구 버전을 7.0.6 으로 올린다. 운영 모드
자격증명 필수 검사가 7.0.6 의 설정 저장 검증 표면에 의존하며, 그보다 낮은
코어에서는 그 검사가 조용히 통과해 빈 자격증명으로 저장할 수 있었다.

재발 차단으로 정적 검사 룰 4종을 신설하고, 검사 도구가 미커밋 신규 확장을
"검사 파일 0" 으로 통과시키던 사각을 함께 막았다.
2026-07-31 00:32:46 +09:00

30 KiB

액션 핸들러 - 네비게이션

메인 문서: actions-handlers.md


목차

  1. navigate
  2. navigateBack
  3. openWindow
  4. reloadExtensions ⭐ NEW (engine-v1.38.0+)
  5. reloadRoutes (deprecated)
  6. refresh

navigate

페이지 이동을 처리합니다.

{
  "type": "click",
  "handler": "navigate",
  "params": {
    "path": "/admin/users/{{row.id}}"
  }
}

navigate params 구조

필드 타입 기본값 설명
path string - 이동할 경로. 목적지는 이 필드(없으면 액션 노드의 target)로만 정해진다 — url / href / to 같은 다른 이름으로 적으면 읽히지 않아 목적지가 undefined 가 되고, 예외도 404 도 없이 버튼만 동작하지 않는다
query object - 쿼리 파라미터 객체
mergeQuery boolean false 기존 쿼리 파라미터와 병합
replace boolean false URL만 변경 (페이지 리로드 없음)
transition_overlay_target string - replace: true 호출 시 transition_overlay.target 을 동적으로 override (engine-v1.36.0+)
scroll string | number | object "top" 이동 후 스크롤 위치 (engine-v1.37.0+). "top" / "preserve" / 숫자 / {x,y} / "#selector"
scrollBehavior string "instant" 스크롤 애니메이션 (engine-v1.37.0+). "instant" (즉시) / "smooth" (부드럽게). 기본값 "instant"는 템플릿 CSS의 scroll-behavior: smooth 전역 설정을 무시하고 페이지 전환 시 즉시 이동
fallback false | string | object "openWindow" 대상 경로가 현재 템플릿의 routes.json에 없을 때 실행할 fallback 핸들러 (engine-v1.40.0+). 기본값은 openWindow(새 창). false 시 비활성화(기존 동작), 문자열은 핸들러명만 지정, 객체는 {handler, params} 상세 지정. 관리자 ↔ 사용자 템플릿 교차 경로에 사용

transition_overlay_target 옵션 (engine-v1.36.0+)

replace: true 로 탭 전환/페이지네이션 시 updateQueryParams 경로에 진입할 때, 레이아웃의 transition_overlay.target 대신 이 호출에 한해 다른 영역에만 spinner 를 표시하도록 한다.

주 용도: 탭 속 서브 탭(환경설정 > 알림 탭 > 채널 탭 등) 클릭 시 서브 탭 콘텐츠 영역에만 spinner 가 표시되어야 할 때.

{
  "handler": "navigate",
  "params": {
    "path": "/admin/settings",
    "replace": true,
    "mergeQuery": true,
    "query": { "channel": "{{ch.id}}" },
    "transition_overlay_target": "notif_channel_content"
  }
}

동작:

  • 미지정 시: 레이아웃의 transition_overlay.target 사용 (탭 콘텐츠 wrapper 등)
  • 지정 시: 해당 ID 의 DOM 요소에만 spinner mount. 요소 미발견 시 transition_overlay.fallback_target → #app 순으로 3단계 폴백
  • replace: true 아닌 일반 navigate(다른 path)는 handleRouteChange 경로로 가며 이 옵션은 효과 없음

replace: true 는 이 옵션의 전제 조건이다. 같은 params 에 함께 두지 않으면 엔진이 값을 읽지 않아 오버레이가 표시되지 않는다. 키를 잘못 적은 것도 아니고 값이 틀린 것도 아니라 경고·예외가 전혀 남지 않으므로, 화면을 직접 보지 않으면 무효 상태를 알아차릴 수 없다. 검색·필터 변경처럼 목록을 다시 그리는 이동에도 동일하게 적용된다.

// ❌ 조용히 무시된다 — 오버레이가 뜨지 않는다
{ "handler": "navigate", "params": { "path": "/admin/users", "mergeQuery": true,
  "transition_overlay_target": "users_data_grid__body" } }

// ✅ replace 를 함께 선언
{ "handler": "navigate", "params": { "path": "/admin/users", "mergeQuery": true, "replace": true,
  "transition_overlay_target": "users_data_grid__body" } }

정적 검사가 이 조합을 강제한다. 의도적으로 오버레이를 끄려면 키 자체를 지우고, 예외가 필요하면 액션 노드 comment 에 audit:allow layout-transition-overlay-target-requires-replace <사유> 를 남긴다.

DataGrid body 영역 한정 spinner 컨벤션:

목록 페이지 페이지네이션 시 pagination 영역은 제외하고 그리드 본문만 spinner 를 표시하려면 transition_overlay_target 에 DataGrid 의 ${id}__body suffix 를 사용한다. DataGrid composite 컴포넌트는 root Div 에 id 를, 테이블/카드 목록을 감싸는 내부 wrapper Div 에 ${id}__body 를 자동으로 부여한다 (pagination 은 body wrapper 밖의 형제).

// DataGrid 컴포넌트 정의
{ "type": "composite", "name": "DataGrid", "id": "users_data_grid", "props": {...} }

// 페이지네이션 navigate
{
  "handler": "navigate",
  "params": {
    "path": "/admin/users",
    "replace": true,
    "mergeQuery": true,
    "query": { "page": "{{$args[0]}}" },
    "transition_overlay_target": "users_data_grid__body"
  }
}

이 컨벤션으로 pagination 버튼은 spinner 위에 표시되어 사용자가 연속 클릭 가능하다.

상세: layout-json-components-loading.md#wait_for — 데이터소스 가드

fallback 옵션 (engine-v1.40.0+)

대상 경로가 현재 템플릿의 routes.json에 등록되어 있지 않을 때(예: 관리자 화면에서 사용자 페이지 URL로 navigate 시도), 404 라우트가 아닌 다른 핸들러로 분기시킨다. 기본값은 openWindow — 미지정 시 자동으로 새 창에서 열림.

주 용도: 알림센터에서 알림 클릭 시 관리자 ↔ 사용자 템플릿 교차 경로 처리.

판정 흐름:

  1. params.fallback === false → fallback 비활성화 (SPA navigate 강행, 기존 동작)
  2. params.replace === true → 쿼리 갱신 전용이므로 fallback 미적용
  3. Router 미초기화 또는 routes 미로드 → fallback 미적용 (정상 navigate)
  4. Router.match(pathname) 성공 → fallback 미적용 (정상 navigate)
  5. 매칭 실패 → fallback 핸들러로 dispatch

파라미터 형태:

// 1. 미지정 (기본값: openWindow)
{ "handler": "navigate", "params": { "path": "/shop/products" } }

// 2. 비활성화 (기존 동작 — 미등록 경로 그대로 SPA navigate)
{ "handler": "navigate", "params": { "path": "/admin/x", "fallback": false } }

// 3. 핸들러명만 지정 (string)
{ "handler": "navigate", "params": { "path": "/shop/products", "fallback": "openWindow" } }

// 4. 상세 지정 (object) — params는 finalPath 위에 merge
{
  "handler": "navigate",
  "params": {
    "path": "/shop/products",
    "fallback": { "handler": "openWindow", "params": { "target": "_blank" } }
  }
}

알림센터 클릭 패턴 (parallel + fallback):

알림센터에서 알림 클릭 시 mark-as-read API 호출과 navigate를 parallel로 묶어 동시 실행하면, openWindow fallback이 즉시 새 창을 열고 mark-as-read는 백그라운드에서 진행된다. sequence로 묶으면 mark-as-read 완료(1~2초)를 기다린 후에야 새 창이 열려 사용자 체감이 나빠진다.

{
  "event": "onNotificationClick",
  "handler": "parallel",
  "params": {
    "actions": [
      {
        "handler": "navigate",
        "params": { "path": "{{$args[0].url ?? '/admin/notification-logs'}}" }
      },
      {
        "handler": "apiCall",
        "target": "/api/admin/notifications/{{$args[0].id}}/read",
        "params": { "method": "PATCH" }
      }
    ]
  }
}

mergeQuery 옵션

기존 쿼리 파라미터를 유지하면서 새 파라미터를 병합합니다.

{
  "handler": "navigate",
  "params": {
    "path": "/admin/users",
    "mergeQuery": true,
    "query": {
      "page": "2"
    }
  }
}

params 형태별 결과는 다음과 같다. replaceUrl 도 동일하다.

params 형태 결과
mergeQuery: true + query: {} 현재 URL 쿼리 전부 유지
mergeQuery: true + query: {k: v} 유지 + k 만 덮어씀 (빈 문자열이면 k 제거)
mergeQuery: true + query 키 없음 전부 유지 (engine-v1.54.2+. 그 이전에는 병합이 no-op 이 되어 전부 소실)
query: {k: v} (mergeQuery 없음) k 외 전부 소실
query 키 자체가 없음 쿼리 전부 소실

목록 컨텍스트 왕복 규약

페이지네이션 목록 화면과 그에 딸린 상세 · 형제 상세(이전글/다음글) · 작성/수정 폼 · 확인 모달은 하나의 목록 클러스터다. 이 클러스터 안에서의 이동은 URL 목록 상태(page/search/category/filters[*]/정렬/per_page)를 손실 없이 보존해야 한다.

"params": { "path": "…", "mergeQuery": true, "query": {} }

지켜야 할 점:

  • 모든 leg 에 동일 적용한다. 목록 진입 / 목록 복귀 / 형제 상세 이동 / 폼 취소 / 삭제 후 복귀 중 하나만 빠져도 그 지점에서 상태가 끊기고, 이후 '목록' 버튼은 복원할 상태가 없어 1페이지로 되돌아간다. 공개 이슈 #75 가 정확히 이 형태였다 — 행 클릭과 '목록' 버튼에는 규약이 적용됐지만 이전글/다음글만 누락됐다.
  • 현재 값을 그대로 다시 넘기는 키는 열거하지 않는다. {"del": "{{query.del ?? ''}}"} 같은 열거는 mergeQuery 가 이미 나르므로 중복이고, 나머지 키를 빠뜨리게 만드는 원인이 된다. 값을 바꿔야 하는 키만 남긴다.
  • 페이지를 되돌려야 하면 {"page": ""} 를 쓴다(빈 문자열 = 파라미터 제거 = 1페이지). 새 검색을 실행하는 버튼이 여기 해당한다.
  • 새로고침 버튼도 병합 대상이다. 새로고침은 보던 목록을 다시 부르는 동작이지 조건을 지우는 동작이 아니다.
  • mergeQuery 는 boolean 리터럴로 고정한다. "{{cond}}" 처럼 분기시키면 한쪽 분기에서만 상태가 조용히 사라진다.
  • path 에 인라인 쿼리스트링을 붙이지 않는다. buildMergedQueryPath 가 ? 이후를 잘라내므로 "/board/{{slug}}/write?parent_id={{id}}" 의 parent_id 는 병합 시 사라진다. query 객체로 옮긴다.
  • 목적지가 표현식이면 의도를 명시한다. "{{route.id ? '/board/' + route.slug + '/' + route.id : '/board/' + route.slug}}" 같은 취소 버튼은 문자열 리터럴로 목적지가 드러나므로 룰이 클러스터 소속을 판정한다. 그러나 "{{_global.shopBase}}/products" / "{{notification.url}}" 처럼 경로 전체가 런타임 값이면 정적으로는 알 수 없다. 클러스터 내 이동이면 mergeQuery: true 를, 밖으로 나가는 이동이면 아래 면제 주석을 남긴다.
  • path 를 생략한 액션도 병합 대상이다. path 없이 query 만 주면 "현재 주소를 유지한 채 쿼리만 바꾼다" 는 뜻이라 목록 화면 자신에게 작용한다. 그런데 mergeQuery 가 없으면 위 표의 마지막 두 행대로 쿼리가 통째로 대체되므로, 상세 화면의 탭 전환({"tab": "reviews"})이나 좌우 분할 목록의 항목 선택({"id": …, "mode": "view"}) 한 번에 방금 건 검색어·정렬·페이지가 사라진다. 목적지 문자열이 없어 경로 기반 판정이 닿지 않는 자리라 눈에 잘 띄지 않는다.
  • 병합은 값을 나르지 않는다. mergeQuery 는 "지금 URL 에 있는 값을 이어받는다" 는 뜻이지 "새 값을 만든다" 가 아니다. 검색 실행·페이지 이동처럼 값을 바꾸는 액션은 그 값을 query 에 직접 담아야 한다 ({"page": "{{$args[0]}}"}). query: {} 로 비우면 페이지 버튼이 아무 동작도 하지 않는다.

의도적 리셋은 예외다 — 검색 초기화 / 필터 초기화 / 탭 전환 / 프리셋 적용 / 다른 목록으로의 이동이 여기 해당한다. 이때는 액션 노드 comment 에 다음을 남겨 의도를 코드에 기록한다.

리셋 자리에 mergeQuery: true 를 넣으면 그 버튼은 화면상 아무 일도 하지 않는다 — 조건을 비우려고 이동하는데 병합이 방금 비운 조건을 URL 에서 되돌려놓기 때문이다. 면제 주석은 선언일 뿐 사실이 아니므로, "병합하지 않는다" 고 적어 두고 mergeQuery: true 를 함께 두는 자기모순이 생기지 않도록 주석과 params 를 함께 확인한다.

탭 전환은 특히 실수하기 쉽다. /admin/templates/user 와 /admin/templates/admin 처럼 탭마다 라우트가 갈리는 화면은 탭 각각이 자기 검색어·페이지를 갖는 별개의 목록이다. 여기에 병합을 붙이면 ?search=…&page=3 상태에서 다른 탭으로 넘어갈 때 남의 검색어로 걸러진 3페이지(대개 빈 화면)가 열린다. 마찬가지로 프리셋 적용은 조건 세트를 통째로 갈아끼우는 동작이므로, 병합하면 프리셋이 열거하지 않은 직전 조건이 화면에 보이지 않는 채 URL 에 남는다.

앞선 액션이 setState 로 로컬 필터를 비웠다면 URL 쪽 같은 키도 함께 비워야 한다. mergeQuery 는 그 키를 URL 에서 그대로 이어받으므로, 비우지 않으면 입력창은 비어 보이는데 조회는 옛 조건으로 걸리는 어긋남이 생긴다 ({"search_keyword": ""} — 빈 문자열 = 파라미터 제거).

{
  "comment": "audit:allow layout-list-context-navigate-merge-query 검색 초기화 — 조건을 전부 비우는 것이 목적",
  "handler": "navigate",
  "params": { "path": "/board/{{route.slug}}", "mergeQuery": false }
}

자동 차단: 정적 검사 대상 (위반 시 차단). 목록 라우트는 저장소에서 자동 도출하므로 화이트리스트를 관리할 필요가 없다. 도출 근거는 두 가지다.

  1. query 에 page 키가 등장하는 navigate 목적지
  2. 화면이 실제로 페이지네이션 UI(onPageChange 액션 / Pagination 컴포넌트)를 갖고 있는지 — partial 을 따라 전파한다
  3. 데이터소스 params 가 URL 에서 페이지를 읽는지 ("page": "{{query.page}}") — 페이저를 같은 파일에 그리지 않는 목록까지 포함
  4. 데이터소스 params 가 URL 에서 목록 필터를 읽는지 (search/category/sort/status/filters) — 페이지가 URL 이 아니라 클라이언트 상태(무한스크롤)로 관리되는 목록도 필터는 URL 에 있으므로 그 목록의 새로고침·왕복이 필터를 보존해야 한다

두 번째 근거가 없으면 "이미 규약을 적용한 화면일수록 감시 대상이 된다" 는 순환이 생겨, 아직 고치지 않은 화면이 오히려 탐지에서 빠진다. 네 번째 근거가 없으면 무한스크롤 목록의 검색어가 새로고침에서 조용히 사라지는 결함이 빠진다.

정적 검사는 반대 방향도 본다 — 탭 전환(onTabChange)에 mergeQuery: true 를 붙이거나, 자기 클러스터와 상하 관계가 전혀 없는 다른 목록 라우트로 나가면서 병합하면 위반으로 잡는다. "병합 누락"만 보면 이 방향이 통째로 사각지대가 된다.

한계 — 정적 검사는 레이아웃 JSON 만 스캔한다. navigate leg 이 컴포넌트 코드(.tsx)에 있으면(예: ProductCard 의 카드 클릭) 룰의 시야 밖이다. 목록 항목으로 렌더되는 컴포넌트가 상세로 이동할 때는 컴포넌트가 직접 mergeQuery 를 실어야 한다(ProductCard 의 preserveListQuery prop 참조).

배열 쿼리 파라미터

버전: engine-v1.10.0+

배열 값은 자동으로 key[]=value1&key[]=value2 형태로 변환됩니다.

{
  "handler": "navigate",
  "params": {
    "path": "/admin/products",
    "mergeQuery": true,
    "query": {
      "sales_status[]": "{{_local.salesStatus}}"
    }
  }
}

입력 예시:

  • _local.salesStatus = ["on_sale", "sold_out"]

생성되는 쿼리스트링:

  • sales_status[]=on_sale&sales_status[]=sold_out
중요: 배열 값이 빈 배열([])이거나 null이면 해당 파라미터는 쿼리스트링에서 제거됩니다.

백엔드 Enum 값과 일치 필수:

프론트엔드 필터에서 사용하는 값은 반드시 백엔드 Enum의 value와 동일해야 합니다.

// 백엔드 Enum (ProductSalesStatus.php)
enum ProductSalesStatus: string
{
    case OnSale = 'on_sale';
    case Suspended = 'suspended';
    case SoldOut = 'sold_out';
    case ComingSoon = 'coming_soon';
}
// ✅ 올바른 사용 (Enum 값과 일치)
"salesStatus": "{{(_local.salesStatus || []).includes('sold_out') ? ... }}"

// ❌ 잘못된 사용 (Enum에 없는 값)
"salesStatus": "{{(_local.salesStatus || []).includes('out_of_stock') ? ... }}"

번역 키도 Enum과 일관되게 사용:

// ✅ 권장: Enum 기반 번역 키
"text": "$t:sirsoft-ecommerce.enums.sales_status.sold_out"

// 비권장: 별도의 필터용 번역 키
"text": "$t:sirsoft-ecommerce.admin.product.filter.sales_status_options.out_of_stock"

replace 옵션

버전: engine-v1.3.0+ (engine-v1.12.0에서 동작 방식 변경)

replace: true를 사용하면 컴포넌트 리마운트 없이 URL을 변경하고 데이터를 갱신합니다. 같은 페이지 내에서 검색/필터/정렬/페이지네이션 등의 쿼리 파라미터만 변경할 때 사용합니다.

{
  "handler": "navigate",
  "params": {
    "path": "/admin/products",
    "mergeQuery": true,
    "replace": true,
    "query": {
      "page": "{{_local.page}}",
      "sort": "{{_local.sortField}}",
      "order": "{{_local.sortOrder}}"
    }
  }
}

동작 방식 (engine-v1.12.0+):

  1. window.history.replaceState()로 URL 업데이트 (히스토리 교체)
  2. 내부 쿼리 컨텍스트 (query) 업데이트
  3. auto_fetch: true인 모든 데이터 소스 자동 refetch
  4. UI 리렌더링 (컴포넌트 리마운트 없음)

사용 사례:

  • 검색 버튼 클릭 시 필터 적용 (깜빡임 없이 데이터만 갱신)
  • 정렬 드롭다운 변경 시 목록 갱신
  • 페이지당 표시 개수 변경
  • 페이지네이션 (같은 페이지 내 이동)

replace vs 일반 navigate 비교:

특성 replace: false (기본값) replace: true
컴포넌트 리마운트 발생 (전체 라우트 전환) 발생 안 함
데이터 소스 refetch 라우트 전환 시 자동 즉시 자동 refetch
히스토리 스택 새 항목 추가 현재 항목 교체
UI 깜빡임 발생 가능 없음
쿼리 컨텍스트 업데이트 React Router 통해 자동 내부적으로 즉시 반영

주의사항:

replace: true는 같은 페이지 내에서만 사용
   다른 페이지로 이동할 때는 replace: false (기본값) 사용

✅ 사용 권장: 검색, 필터, 정렬, 페이지네이션
❌ 사용 금지: 다른 페이지로 이동, 상세 페이지 진입

검색 필터 예시:

{
  "id": "search_button",
  "type": "basic",
  "name": "Button",
  "text": "$t:common.search",
  "actions": [
    {
      "type": "click",
      "handler": "navigate",
      "params": {
        "path": "/admin/products",
        "replace": true,
        "mergeQuery": true,
        "query": {
          "page": 1,
          "search_field": "{{_local.filter.searchField}}",
          "search_keyword": "{{_local.filter.searchKeyword}}"
        }
      }
    }
  ]
}

정렬 드롭다운 예시:

{
  "type": "basic",
  "name": "Select",
  "props": {
    "value": "{{query.sort || 'created_at'}}",
    "options": [
      { "value": "created_at", "label": "$t:common.sort.created_at" },
      { "value": "name", "label": "$t:common.sort.name" }
    ]
  },
  "actions": [
    {
      "type": "change",
      "handler": "navigate",
      "params": {
        "path": "/admin/products",
        "replace": true,
        "mergeQuery": true,
        "query": {
          "sort": "{{$event.target.value}}"
        }
      }
    }
  ]
}

scroll 옵션

버전: engine-v1.37.0+

페이지 이동 후 스크롤 위치를 제어합니다. 기본값은 "top" 으로, 일반적인 하이퍼링크 이동 UX와 동일하게 새 페이지가 최상단에서 시작됩니다.

단축 문법

값 동작
"top" (기본) #app 내부의 모든 스크롤 컨테이너 + window를 상단으로 리셋
"preserve" 이전 스크롤 위치 유지 (엔진이 건드리지 않음)
number window를 해당 Y 좌표로 이동
{ x, y } window를 특정 좌표로 이동
"#selector" / ".class" 해당 엘리먼트로 scrollIntoView({ block: 'start' })

확장 객체 문법

특정 스크롤 컨테이너를 지정하거나, sticky 헤더 오프셋, scrollIntoView의 block 위치 등을 세밀하게 제어할 때 사용합니다.

{
  container?: string;                       // 스크롤 컨테이너 선택자 (생략 시 window)
  to?: string | number | { x?, y? } | "top"; // 이동 대상 (생략 시 "top")
  block?: "start" | "center" | "end" | "nearest"; // scrollIntoView block (기본 "start")
  offset?: number;                          // sticky 헤더 보정 (px, 양수 = 위쪽 여유)
}
필드 타입 기본값 설명
container string window 스크롤 컨테이너 CSS 선택자. 관리자 템플릿처럼 내부 div가 실제 스크롤 영역인 경우 지정 (예: "#right_content_area")
to string / number / object / "top" "top" 이동 대상. 엘리먼트 선택자 / Y 좌표 / {x, y} 좌표 / "top"
block string "start" to가 엘리먼트 선택자일 때 스크롤 위치 지정. 네이티브 scrollIntoView와 동일한 의미
offset number 0 최종 스크롤 위치에서 차감할 픽셀 수. sticky 헤더가 있는 경우 헤더 높이만큼 지정하면 대상이 헤더 아래로 가려지지 않음

동작 방식:

  • 스크롤은 requestAnimationFrame을 통해 다음 tick에 적용되어 새 레이아웃이 DOM에 반영된 뒤 정확한 위치로 이동합니다
  • replace: true 분기 (updateQueryParams)에도 동일하게 기본 "top"이 적용됩니다. 검색/필터/페이지네이션에서 스크롤 유지를 원하면 "preserve" 명시
  • scrollBehavior: "smooth"와 조합하면 부드러운 스크롤 애니메이션이 적용됩니다
  • 관리자 템플릿(sirsoft-admin_basic)처럼 html/body가 overflow: hidden이고 내부 div(#right_content_area)가 실제 스크롤 컨테이너인 구조에서는 "top" 단축 문법이 자동으로 모든 스크롤 컨테이너를 리셋합니다. 숫자/좌표/선택자 단축 문법은 window만 스크롤하므로, 내부 컨테이너 제어가 필요하면 확장 객체 문법에서 container 지정

예시

검색 필터에서 스크롤 유지:

{
  "handler": "navigate",
  "params": {
    "path": "/admin/products",
    "replace": true,
    "mergeQuery": true,
    "query": { "search_keyword": "{{_local.keyword}}" },
    "scroll": "preserve"
  }
}

특정 엘리먼트로 이동 (단축):

{
  "handler": "navigate",
  "params": {
    "path": "/admin/docs",
    "scroll": "#section-api"
  }
}

관리자 템플릿 내부 컨테이너의 Y 좌표로 이동 (확장):

{
  "handler": "navigate",
  "params": {
    "path": "/admin/users",
    "scroll": {
      "container": "#right_content_area",
      "to": 500
    }
  }
}

sticky 헤더가 있는 페이지에서 섹션으로 이동 (확장):

{
  "handler": "navigate",
  "params": {
    "path": "/admin/docs",
    "scroll": {
      "to": "#section-api",
      "offset": 80
    }
  }
}

특정 엘리먼트를 화면 중앙에 위치 (확장):

{
  "handler": "navigate",
  "params": {
    "path": "/admin/report",
    "scroll": {
      "container": "#right_content_area",
      "to": "#chart-revenue",
      "block": "center"
    }
  }
}

openWindow

버전: engine-v1.19.0+

새 브라우저 탭/창에서 URL을 엽니다. window.open(path, '_blank')을 호출합니다.

{
  "type": "click",
  "handler": "openWindow",
  "params": {
    "path": "/admin/users/{{row.created_by}}"
  }
}

openWindow params 구조

필드 타입 기본값 설명
path string - 새 창에서 열 경로 (필수)

사용 사례

  • 회원 정보를 새 창에서 조회
  • 외부 링크를 새 탭에서 열기
  • 현재 페이지를 유지하면서 다른 페이지 참조

navigate와의 차이

특성 navigate openWindow
현재 페이지 유지 X (이동) O (유지)
새 탭/창 X O
히스토리 현재 탭 히스토리 변경 변경 없음

예시: 등록자 정보 새 창으로 보기

{
  "type": "basic",
  "name": "Button",
  "props": {
    "variant": "ghost",
    "size": "sm"
  },
  "text": "$t:common.view_member",
  "actions": [
    {
      "type": "click",
      "handler": "openWindow",
      "params": {
        "path": "/admin/users/{{row.created_by}}"
      }
    }
  ]
}

navigateBack

브라우저 히스토리에서 뒤로 이동합니다. window.history.back()을 호출합니다.

{
  "type": "click",
  "handler": "navigateBack"
}

사용 사례

  • 상세 페이지에서 목록으로 돌아가기
  • 폼 페이지에서 취소 버튼 클릭 시 이전 페이지로 이동
{
  "id": "back_button",
  "type": "basic",
  "name": "Button",
  "actions": [
    {
      "type": "click",
      "handler": "navigateBack"
    }
  ],
  "children": [
    {
      "type": "basic",
      "name": "Icon",
      "props": { "name": "arrow-left", "className": "w-4 h-4" }
    },
    {
      "type": "basic",
      "name": "Span",
      "text": "$t:common.back"
    }
  ]
}

reloadExtensions

버전: engine-v1.38.0+

확장(모듈/플러그인/템플릿) install/activate/deactivate/uninstall 직후 onSuccess 체인에서 호출하여 페이지 전체 새로고침 없이 확장 상태를 원자적으로 재동기화합니다.

내부적으로 다음을 순차 수행합니다:

  1. /api/templates/{id}/config.json 에서 최신 cache_version 획득
  2. localStorage 의 확장 캐시 버전 갱신
  3. Router.loadRoutes(newVersion) — 신 버전 쿼리로 routes.json 재fetch
  4. LayoutLoader 캐시 버전 갱신 및 클리어
  5. TranslationEngine 재로드 — 활성 사전은 원자 교체되어 $t: 해석 경합 없음
{
  "handler": "reloadExtensions"
}

선택 파라미터 (모듈/플러그인 에셋 동적 로드/제거)

모듈 또는 플러그인의 JS/CSS 에셋을 동시에 로드/제거하려면 moduleInfo 또는 pluginInfo 와 action 을 전달합니다.

{
  "handler": "reloadExtensions",
  "params": {
    "moduleInfo": "{{result}}",
    "action": "add"
  }
}
파라미터 타입 설명
moduleInfo object 모듈 activate/deactivate API 응답 ({{result}}) — identifier 및 assets 포함
pluginInfo object 플러그인 activate/deactivate API 응답
action 문자열 "add" 또는 "remove" — 에셋 로드 또는 제거

사용 사례

  • 모듈/플러그인/템플릿 install/activate/deactivate/uninstall onSuccess
  • 관리자가 같은 세션 안에서 확장을 활성화한 뒤 새 라우트로 즉시 이동하는 UX
  • 전체 페이지 새로고침(refresh) 을 SPA 친화적으로 대체

올바른 사용

"onSuccess": [
  { "handler": "toast", "params": { "type": "success", "message": "$t:admin.modules.activate_success" } },
  { "handler": "refetchDataSource", "params": { "dataSourceId": "modules" } },
  {
    "handler": "reloadExtensions",
    "params": {
      "moduleInfo": "{{result}}",
      "action": "add"
    }
  }
]

주의

  • 기존에 3~4건을 병렬 호출하던 reloadRoutes + reloadTranslations + reloadModuleHandlers / reloadPluginHandlers 패턴을 이 단일 핸들러로 대체하세요.
  • 템플릿 activate/force_activate 에서 refresh(전체 새로고침)로 해결하던 케이스도 reloadExtensions 로 교체 가능.

reloadRoutes

Deprecated (engine-v1.38.0+): reloadExtensions 사용을 권장합니다. 하위 호환을 위해 유지되며 내부적으로 reloadExtensions 와 동일한 TemplateApp.reloadExtensionState() 로 위임됩니다.

라우트(routes.json)를 다시 로드합니다.

{
  "handler": "reloadRoutes"
}

사용 사례

  • (deprecated) 모듈/플러그인 설치 후 새 라우트 적용 → reloadExtensions 사용
  • (deprecated) 동적으로 라우트 설정이 변경된 경우

refresh

현재 페이지를 새로고침합니다.

{
  "handler": "refresh"
}

사용 사례

  • 전체 페이지 새로고침이 필요한 경우
  • 상태 초기화가 필요한 경우

replaceUrl

버전: engine-v1.18.0+

URL만 변경하고 데이터소스 refetch나 컴포넌트 리마운트를 수행하지 않습니다. 리스트 항목 선택 시 URL에 상태를 반영할 때 사용합니다.

{
  "handler": "replaceUrl",
  "params": {
    "path": "/admin/menus",
    "query": { "menu": "{{$args[0].slug}}", "mode": "view" }
  }
}

replaceUrl params 구조

필드 타입 기본값 설명
path string 현재 경로 변경할 경로 (생략 시 window.location.pathname)
query object - 쿼리 파라미터 객체
mergeQuery boolean false 기존 쿼리 파라미터와 병합

replaceUrl vs navigate replace 비교

특성 navigate (replace: true) replaceUrl
URL 변경 O O
데이터소스 refetch O (auto_fetch 전체) X
컴포넌트 리마운트 X X
히스토리 현재 항목 교체 현재 항목 교체

사용 사례

  • 리스트 항목 선택 시 URL에 선택 상태 반영 (깜빡임 없이)
  • 편집/보기 모드 전환 시 URL 업데이트
  • URL 복사/공유 시 현재 상태 복원 가능하도록

path 생략 예시

path를 생략하면 현재 페이지 경로가 자동으로 사용됩니다.

{
  "handler": "replaceUrl",
  "params": {
    "query": { "id": "{{$args[0].id}}", "mode": "view" }
  }
}

관련 문서