Este documento foi traduzido por IA. Para informações precisas, consulte a versão em inglês.
Informações de localização da rota atual, equivalente ao objeto location do React Router. Geralmente é usado em conjunto com ctx.router e ctx.route para ler o caminho atual, string de consulta (query string), hash e o estado (state) passado através da rota.
| Cenário | Descrição |
|---|---|
| JSBlock / JSField | Realiza renderização condicional ou ramificação lógica com base no caminho atual, parâmetros de consulta ou hash. |
| Regras de vinculação / Fluxo de eventos | Lê parâmetros de consulta da URL para filtragem vinculada ou determina a origem com base em location.state. |
| Processamento pós-navegação | Recebe dados passados da página anterior via ctx.router.navigate usando ctx.location.state na página de destino. |
Nota:
ctx.locationestá disponível apenas em ambientes RunJS com um contexto de roteamento (ex: JSBlock dentro de uma página, fluxos de eventos, etc.); pode ser nulo em contextos puramente de backend ou sem roteamento (ex: fluxos de trabalho).
Location vem de react-router-dom, consistente com o valor de retorno de useLocation() do React Router.
| Campo | Tipo | Descrição |
|---|---|---|
pathname | string | O caminho atual, começando com / (ex: /admin/users). |
search | string | A string de consulta, começando com ? (ex: ?page=1&status=active). |
hash | string | O fragmento hash, começando com # (ex: #section-1). |
state | any | Dados arbitrários passados via ctx.router.navigate(path, { state }), não refletidos na URL. |
key | string | Um identificador único para esta localização; a página inicial é "default". |
| Finalidade | Uso recomendado |
|---|---|
| Ler caminho, hash, state | ctx.location.pathname / ctx.location.hash / ctx.location.state |
| Ler parâmetros de consulta (como objeto) | ctx.urlSearchParams, que fornece o objeto analisado diretamente. |
| Analisar string de busca | new URLSearchParams(ctx.location.search) ou use ctx.urlSearchParams diretamente. |
ctx.urlSearchParams é analisado a partir de ctx.location.search. Se você precisar apenas dos parâmetros de consulta, usar ctx.urlSearchParams é mais conveniente.
state de ctx.router.navigate pode ser recuperado via ctx.location.state na página de destino.ctx.location.