RouterLink
템플릿의 엘리먼트에 적용하면 해당 엘리먼트는 라우팅 규칙으로의 내비게이션을 시작하는 링크가 됩니다. 내비게이션은 페이지의 하나 이상의 <router-outlet> 위치에 라우팅된 컴포넌트를 엽니다.
constructor
RouterLinkstring | null | undefinedRouterLinkhref
string | null호스트 요소가 <a>/<area> 태그 또는 호환되는 사용자 정의 요소일 때 호스트 요소에 적용되는 href 속성값을 나타냅니다.
다른 태그의 경우 값은 null입니다.
href
string | nulltarget
string | undefined호스트 요소의 target 속성을 나타냅니다.
호스트 요소가 <a> 또는 <area> 태그이거나 호환되는 커스텀 요소일 때만 사용됩니다.
target
string | undefinedqueryParams
Params | null | undefinedUrlCreationOptions의 일부로 Router#createUrlTree에 전달됩니다.
queryParams
Params | null | undefinedfragment
string | undefinedUrlCreationOptions의 일부로 Router#createUrlTree에 전달됩니다.
fragment
string | undefinedqueryParamsHandling
QueryParamsHandling | null | undefinedUrlCreationOptions의 일부로 Router#createUrlTree에 전달됩니다.
queryParamsHandling
QueryParamsHandling | null | undefinedstate
{ [k: string]: any; } | undefinedNavigationBehaviorOptions의 일부로 Router#navigateByUrl에 전달합니다.
state
{ [k: string]: any; } | undefinedinfo
unknownNavigationBehaviorOptions의 일부로 Router#navigateByUrl에 전달합니다.
info
unknownrelativeTo
ActivatedRoute | null | undefinedUrlCreationOptions의 일부로 Router#createUrlTree에 전달합니다.
routerLink의 기본값인 현재 활성 라우팅 규칙을 사용하지 않으려면 값을 지정하세요.
undefined를 지정하면 routerLink의 기본값을 사용합니다.
relativeTo
ActivatedRoute | null | undefinedpreserveFragment
booleanUrlCreationOptions의 일부로 Router#createUrlTree에 전달됩니다.
preserveFragment
booleanskipLocationChange
booleanNavigationBehaviorOptions의 일부로 Router#navigateByUrl에 전달합니다.
skipLocationChange
booleanreplaceUrl
booleanNavigationBehaviorOptions의 일부로 Router#navigateByUrl에 전달합니다.
replaceUrl
booleanbrowserUrl
InputSignal<string | UrlTree | undefined>NavigationBehaviorOptions의 일부로 Router#navigateByUrl에 전달합니다.
scroll
InputSignal<"manual" | "after-transition" | undefined>NavigationBehaviorOptions의 일부로 Router#navigateByUrl에 전달합니다.
routerLink
string | readonly any[] | UrlTree | null | undefinedRouter#createUrlTree에 전달할 명령 또는 UrlTree입니다.
- 배열:
Router#createUrlTree에 전달할 명령입니다. - 문자열: 문자열 하나만 포함한 명령 배열의 축약형입니다. 예:
['/route']. - UrlTree: 명령과
UrlCreationOptions속성에 해당하는 다른 입력으로 링크를 만드는 대신, 이 링크의UrlTree를 직접 지정합니다. - null|undefined:
routerLink를 비활성화합니다.
설명
템플릿의 엘리먼트에 적용하면 해당 엘리먼트는 라우팅 규칙으로의 내비게이션을 시작하는 링크가 됩니다. 내비게이션은 페이지의 하나 이상의 <router-outlet> 위치에 라우팅된 컴포넌트를 엽니다.
라우팅 설정이 [{ path: 'user/:name', component: UserCmp }]인 경우 다음 코드는 해당 라우팅 규칙으로 연결되는 정적 링크를 만듭니다.
<a routerLink="/user/bob">link to user component</a>
동적 값으로 링크를 생성할 수 있습니다. 동적 링크에는 경로 세그먼트와 각 세그먼트의 파라미터를 순서대로 배열에 전달하세요. 예를 들어 ['/team', teamId, 'user', userName, {details: true}]는 /team/11/user/bob;details=true로 연결되는 링크를 생성합니다.
여러 정적 세그먼트를 한 항목으로 합쳐 동적 세그먼트와 함께 사용할 수 있습니다. 예: ['/team/11/user', userName, {details: true}].
링크에 전달한 입력은 현재 URL에 대한 변경분으로 처리합니다. 예를 들어 현재 URL이 /user/(box//aux:team)이면 <a [routerLink]="['/user/jim']">Jim</a> 링크가 만드는 URL은 /user/(jim//aux:team)입니다. 자세한 내용은 Router#createUrlTree를 참고하세요.
다음 모듈에서 내보냄
사용 시 참고사항
링크에서 절대 또는 상대 경로를 사용하고, 쿼리 파라미터를 설정하거나 처리 방식을 제어하고, 내비게이션 상태의 이력을 유지할 수 있습니다.
상대 링크 경로
첫 세그먼트 이름 앞에 /, ./, ../를 붙일 수 있습니다.
- 첫 세그먼트가
/로 시작하면 앱 루트부터 라우팅 규칙을 찾습니다. - 첫 세그먼트가
./로 시작하거나 슬래시로 시작하지 않으면 현재 활성 라우팅 규칙의 자식에서 찾습니다. - 첫 세그먼트가
../로 시작하면 라우팅 규칙 트리에서 한 단계 위로 올라갑니다.
쿼리 파라미터와 프래그먼트 설정 및 처리
다음 링크는 생성되는 URL에 쿼리 파라미터와 프래그먼트를 추가합니다.
<a [routerLink]="['/user/bob']" [queryParams]="{debug: true}"
fragment="education"> link to user component
</a>
기본적으로 디렉티브는 지정한 쿼리 파라미터로 새 URL을 만듭니다. 이 예제에서 생성되는 링크는 /user/bob?debug=true#education입니다.
링크에서 queryParamsHandling 옵션을 지정하면 쿼리 파라미터 처리 방식을 바꿀 수 있습니다. 사용할 수 있는 값은 다음과 같습니다.
'merge': 지정한queryParams를 현재 쿼리 파라미터에 병합합니다.'preserve': 현재 쿼리 파라미터를 유지합니다.
예를 들어 다음과 같이 사용합니다.
<a [routerLink]="['/user/bob']" [queryParams]="{debug: true}"
queryParamsHandling="merge"> link to user component
</a>
routerLink 입력이 UrlTree일 때는 queryParams, fragment, queryParamsHandling, preserveFragment, relativeTo를 사용할 수 없습니다.
UrlCreationOptions#queryParamsHandling을 참고하세요.
내비게이션 이력 보존하기
브라우저의 History.state 프로퍼티에 저장할 state 값을 지정할 수 있습니다. 예를 들어 다음과 같이 사용합니다.
<a [routerLink]="['/user/bob']" [state]="{tracingId: 123}">
link to user component
</a>
Router#currentNavigation을 사용해 저장된 내비게이션 상태 시그널 값을 가져옵니다. 예를 들어 NavigationStart 이벤트에서 tracingId를 가져오려면 다음과 같이 작성합니다.
// NavigationStart 이벤트를 가져옵니다.
router.events.pipe(filter(e => e instanceof NavigationStart)).subscribe(e => {
const navigation = router.currentNavigation();
tracingService.trace({id: navigation.extras.state.tracingId});
});
스크롤 제어하기
withInMemoryScrolling으로 스크롤 복원을 활성화하면 쿼리 파라미터만 변경하는 내비게이션을 포함해 모든 내비게이션에서 스크롤이 발생합니다. 페이지 아래쪽에 있는 탭 등 특정 링크에 적용하지 않으려면 scroll을 'manual'로 설정하세요.
<a routerLink="/products/42" [queryParams]="{tab: 'reviews'}" scroll="manual">Reviews</a>
RouterLink와 호환되는 커스텀 엘리먼트
커스텀 엘리먼트가 routerLink와 함께 동작하려면 href 속성을 구현하고 정적 프로퍼티 또는 getter인 observedAttributes 배열에 href를 포함해야 합니다.