Docs
API
Types
RouteApi

RouteApi Type

RouteApi는 특정 라우트 ID 및 관련 등록된 라우트 타입에 미리 바인딩된, useParams, useSearch, useRouteContext, useNavigate, useLoaderData, useLoaderDeps와 같은 공통 hook의 타입 안전한 버전을 제공하는 인스턴스를 설명합니다.

RouteApi properties and methods

RouteApi는 다음 속성과 메서드를 제공합니다:

useMatch method

  useMatch<TSelected = TAllContext>(opts?: {
    select?: (match: TAllContext) => TSelected
  }): TSelected
  • 라우트 ID에 미리 바인딩된 useMatch의 타입 안전한 버전.
  • 옵션
    • opts.select
      • 선택 사항
      • (match: RouteMatch) => TSelected
      • 제공된 경우, 이 함수는 라우트 매치와 함께 호출되며 반환 값은 useMatch에서 반환됩니다. 이 값은 얕은 비교를 사용하여 부모 컴포넌트를 다시 렌더링할지 결정하는 데에도 사용됩니다.
    • opts.structuralSharing
      • 선택 사항
      • boolean
      • select에서 반환된 값에 대한 구조적 공유를 활성화할지 설정.
      • 자세한 내용은 렌더링 최적화 가이드를 참조하세요.
  • 반환
    • select 함수가 제공된 경우, 해당 함수의 반환 값.
    • select 함수가 제공되지 않은 경우, RouteMatch 객체 또는 opts.strict가 false인 경우 느슨한 타입의 RouteMatch.

useRouteContext method

  useRouteContext<TSelected = TAllContext>(opts?: {
    select?: (search: TAllContext) => TSelected
  }): TSelected
  • 라우트 ID에 미리 바인딩된 useRouteContext의 타입 안전한 버전.
  • 옵션
    • opts.select
      • 선택 사항
      • (match: RouteContext) => TSelected
      • 제공된 경우, 이 함수는 라우트 매치와 함께 호출되며 반환 값은 useRouteContext에서 반환됩니다.
  • 반환
    • select 함수가 제공된 경우, 해당 함수의 반환 값.
    • select 함수가 제공되지 않은 경우, RouteContext 객체.

useSearch method

  useSearch<TSelected = TFullSearchSchema>(opts?: {
    select?: (search: TFullSearchSchema) => TSelected
  }): TSelected
  • 라우트 ID에 미리 바인딩된 useSearch의 타입 안전한 버전.
  • 옵션
    • opts.select
      • 선택 사항
      • (match: TFullSearchSchema) => TSelected
      • 제공된 경우, 이 함수는 라우트 매치와 함께 호출되며 반환 값은 useSearch에서 반환됩니다.
  • 반환
    • select 함수가 제공된 경우, 해당 함수의 반환 값.
    • select 함수가 제공되지 않은 경우, TFullSearchSchema 객체.

useParams method

  useParams<TSelected = TAllParams>(opts?: {
    select?: (params: TAllParams) => TSelected
  }): TSelected
  • 라우트 ID에 미리 바인딩된 useParams의 타입 안전한 버전.
  • 옵션
    • opts.select
      • 선택 사항
      • (match: TAllParams) => TSelected
      • 제공된 경우, 이 함수는 라우트 매치와 함께 호출되며 반환 값은 useParams에서 반환됩니다.
  • 반환
    • select 함수가 제공된 경우, 해당 함수의 반환 값.
    • select 함수가 제공되지 않은 경우, TAllParams 객체.

useLoaderData method

  useLoaderData<TSelected = TLoaderData>(opts?: {
    select?: (search: TLoaderData) => TSelected
  }): TSelected
  • 라우트 ID에 미리 바인딩된 useLoaderData의 타입 안전한 버전.
  • 반환
    • select 함수가 제공된 경우, 해당 함수의 반환 값.
    • select 함수가 제공되지 않은 경우, TLoaderData 객체.

useLoaderDeps method

  useLoaderDeps<TSelected = TLoaderDeps>(opts?: {
    select?: (search: TLoaderDeps) => TSelected
  }): TSelected
  • 라우트 ID에 미리 바인딩된 useLoaderDeps의 타입 안전한 버전.
  • 반환
    • select 함수가 제공된 경우, 해당 함수의 반환 값.
    • select 함수가 제공되지 않은 경우, TLoaderDeps 객체.

useNavigate method

  useNavigate(): // navigate function
  • 라우트 ID에 미리 바인딩된 useNavigate의 타입 안전한 버전.
RouteRouteMask