API de navigation

Ces fonctions déclenchent des mises à jour d'état dans la session d'historique du navigateur, vous permettant de passer d'une page à l'autre par programmation.

goToPage

Ajoute une nouvelle entrée à la pile d'historique du navigateur.

function goToPage(
    pathname: string,
    pageData: Record<string, unknown> = {},
    title: string = document.title
): Promise<void>

Exemple

import { goToPage } from '@beforesemicolon/router'

await goToPage(
    '/users/42',
    { role: 'admin', scrollPosition: 0 },
    'User Profile'
)

replacePage

Met à jour l'entrée actuelle dans la pile d'historique au lieu d'en créer une nouvelle. C'est idéal pour les redirections, donc cliquer sur le bouton Précédent du navigateur ne piège pas l'utilisateur dans une boucle de redirection.

function replacePage(
    pathname: string,
    pageData: Record<string, unknown> = {},
    title: string = document.title
): Promise<void>

Exemple

import { replacePage } from '@beforesemicolon/router'

if (!isAuthenticated) {
    await replacePage('/login', { from: '/dashboard' }, 'Please Login')
}

previousPage

Revient à l’entrée précédente dans la session du navigateur. Identique à cliquer sur le bouton Précédent du navigateur.

function previousPage(): void

nextPage

Navigue vers l'entrée suivante dans la session du navigateur. Identique à cliquer sur le bouton Suivant du navigateur.

function nextPage(): void