APIs de navegação

Estas funções acionam atualizações de estado na sessão de histórico do navegador, permitindo a transição programática entre páginas.


goToPage

Adiciona uma nova entrada à pilha de histórico do navegador.

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

Exemplo

javascript
import { goToPage } from '@beforesemicolon/router'

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

replacePage

Atualiza a entrada atual da pilha de histórico em vez de criar uma nova. É ideal para redirecionamentos, pois evita que o botão Voltar do navegador prenda o usuário em um ciclo de redirecionamento.

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

Exemplo

javascript
import { replacePage } from '@beforesemicolon/router'

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

previousPage

Volta para a entrada anterior na sessão do navegador. Equivale a clicar no botão Voltar do navegador.

typescript
function previousPage(): void

nextPage

Avança para a próxima entrada na sessão do navegador. Equivale a clicar no botão Avançar do navegador.

typescript
function nextPage(): void
editar este documento