use-current-url.ts File Reference

Variables
	import { usePage } from '@inertiajs/react'
export type	IsCurrentOrParentUrlFn
export type	IsCurrentUrlFn
import	type { InertiaLinkProps } from '@inertiajs/react'
export type	UseCurrentUrlReturn
export type	WhenCurrentUrlFn

Variable Documentation

import

import { usePage } from '@inertiajs/react'

IsCurrentOrParentUrlFn

export type IsCurrentOrParentUrlFn

Initial value:

= (
    urlToCheck: NonNullable<InertiaLinkProps['href']>,
    currentUrl?: string,
) => boolean

IsCurrentUrlFn

export type IsCurrentUrlFn

Initial value:

= (
    urlToCheck: NonNullable<InertiaLinkProps['href']>,
    currentUrl?: string,
    startsWith?: boolean,
) => boolean

type

import type { InertiaLinkProps } from '@inertiajs/react'

UseCurrentUrlReturn

export type UseCurrentUrlReturn

Initial value:

= {
    currentUrl: string;
    isCurrentUrl: IsCurrentUrlFn;
    isCurrentOrParentUrl: IsCurrentOrParentUrlFn;
    whenCurrentUrl: WhenCurrentUrlFn;
}

WhenCurrentUrlFn

export type WhenCurrentUrlFn

Initial value:

= <TIfTrue, TIfFalse = null>(
    urlToCheck: NonNullable<InertiaLinkProps['href']>,
    ifTrue: TIfTrue,
    ifFalse?: TIfFalse,
) => TIfTrue | TIfFalse