@iyulab/router 0.3.0 → 0.5.0

package/dist/{main.d.ts → index.d.ts}

@@ -29,7 +29,7 @@ declare interface BaseRouteConfig {
      * }
      * ```
      */
-    render: (info: RouteInfo) => HTMLElement | ReactElement | TemplateResult<1>;
+    render?: (info: RouteInfo) => Promise<RenderResult> | RenderResult;
     /**
      * 중첩 라우트
      */
@@ -94,9 +94,7 @@ export declare class Link extends LitElement {
     private dispatchHashchange;
     /** 기본 a 태그의 클릭 이벤트를 막습니다. */
     private preventClickEvent;
-    /** 외부 링크인지 확인합니다. */
-    private checkExternalLink;
-    /** a 태그의 href 값을 계산합니다. */
+    /** a 태그에 주입할 href 값을 계산합니다. */
     private getAnchorHref;
     static styles: CSSResult;
 }
@@ -152,9 +150,11 @@ declare interface PathRouteConfig extends BaseRouteConfig {
 declare interface RenderOption {
     id?: string;
     force?: boolean;
-    content: HTMLElement | ReactElement | TemplateResult<1>;
+    content: RenderResult;
 }
 
+declare type RenderResult = HTMLElement | ReactElement | TemplateResult<1>;
+
 /**
  * 라우트 시작 이벤트
  */
@@ -286,6 +286,9 @@ export declare interface RouteInfo {
     hash?: string;
 }
 
+/**
+ * `lit-element`와 `react-component` 기반의 클라이언트 사이드 라우터
+ */
 export declare class Router {
     private readonly _rootElement;
     private readonly _basepath;
@@ -294,29 +297,26 @@ export declare class Router {
     private _requestID?;
     /** 현재 라우팅 정보 */
     private _routeInfo?;
-    /** 현재 라우팅 시도 카운터 */
-    private _counter;
     constructor(config: RouterConfig);
+    /** 초기 라우팅 처리, TODO: 제거 */
+    private waitConnected;
+    /** 객체를 정리하고 이벤트 리스너를 제거합니다. */
+    destroy(): void;
+    /** 라우터의 기본 경로 반환 */
     get basepath(): string;
+    /** 등록된 라우트 반환 */
     get routes(): RouteConfig[];
+    /** 현재 라우팅 정보 반환 */
     get routeInfo(): RouteInfo | undefined;
     /**
      * 지정한 경로의 클라이언트 라우팅을 수행합니다. 상대경로일 경우 basepath와 조합되어 이동합니다.
      * @param href 이동할 경로
      */
     go(href: string): Promise<void>;
-    /** 초기 라우팅 처리, TODO: 제거 */
-    private initiate;
     /** 브라우저 히스토리 이벤트가 발생시 라우팅 처리 */
-    private handlePopstate;
-    /** 라우트를 재설정합니다. */
-    private setRoutes;
-    /** URLPattern을 사용하여 경로와 일치하는 라우트들을 자식 라우트까지 포함하여 반환합니다. */
-    private getRoutes;
-    /** Outlet 엘리먼트를 찾아 반환합니다. */
-    private findOutlet;
-    /** Outlet 엘리먼트를 찾아 반환합니다. 없으면 에러를 던집니다. */
-    private findOutletOrThrow;
+    private handleWindowPopstate;
+    /** 클릭 이벤트에서 라우터로 처리할 앵커를 찾아 클라이언트 라우팅 수행 */
+    private handleRootClick;
 }
 
 /**
@@ -340,6 +340,11 @@ export declare interface RouterConfig {
      * - 라우트는 렌더링할 엘리먼트 또는 컴포넌트를 지정합니다.
      */
     routes: RouteConfig[];
+    /**
+     * `a` 태그 클릭 시 클라이언트 라우팅을 수행할지 여부를 설정합니다.
+     * @default true
+     */
+    useIntercept?: boolean;
 }
 
 export declare const ULink: ReactWebComponent<Link, {}>;
@@ -347,3 +352,20 @@ export declare const ULink: ReactWebComponent<Link, {}>;
 export declare const UOutlet: ReactWebComponent<Outlet, {}>;
 
 export { }
+
+declare global {
+  interface Window {
+    route: RouteInfo;
+  }
+
+  interface WindowEventMap {
+    'route-begin': RouteBeginEvent;
+    'route-done': RouteDoneEvent;
+    'route-error': RouteErrorEvent;
+  }
+
+  interface HTMLElementTagNameMap {
+    'u-link': Link;
+    'u-outlet': Outlet;
+  }
+}