Instalação

@beforesemicolon/router funciona em aplicações empacotadas e diretamente em navegadores modernos por meio de tags de script CDN.

Gerenciadores de pacotes

Instale o pacote com seu gerenciador preferido para usá-lo com Vite, Webpack ou esbuild:

npm

npm install @beforesemicolon/router

yarn

yarn add @beforesemicolon/router

pnpm

pnpm add @beforesemicolon/router

CDN direto, sem build

Para protótipos HTML simples ou aplicações sem etapa de build, carregue os pacotes compilados diretamente de unpkg.com ou jsDelivr:

<!-- 1. Import the base web component library (Required dependency) -->
<script src="https://unpkg.com/@beforesemicolon/web-component/dist/client.js"></script>

<!-- 2. Import the router browser bundle -->
<script src="https://unpkg.com/@beforesemicolon/router/dist/client.js"></script>

Fixando versões

É altamente recomendado fixar a versão em ambientes de produção para evitar mudanças incompatíveis quando novas atualizações forem publicadas:

<script src="https://unpkg.com/@beforesemicolon/router@1.2.0/dist/client.js"></script>

Namespace global

Quando o pacote é carregado por uma tag de script, todas as classes, funções de roteamento e utilitários exportados ficam disponíveis no objeto global BFS da janela:

// Access router components and APIs
const { goToPage, onPage, registerRouteGuard } = BFS.ROUTER