{"id":25161132,"url":"https://github.com/pedrovs3/react-router","last_synced_at":"2025-04-30T11:56:53.933Z","repository":{"id":212690083,"uuid":"731648045","full_name":"pedrovs3/react-router","owner":"pedrovs3","description":"This is a simple, lightweight, and flexible routing library for React applications. It provides a set of components and hooks to handle routing in your application, including support for dynamic routes with path parameters.","archived":false,"fork":false,"pushed_at":"2024-02-28T12:13:07.000Z","size":418,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-28T18:39:10.940Z","etag":null,"topics":["library","open-source","react","react-router","router","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@pedrovs3/react-router","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pedrovs3.png","metadata":{"files":{"readme":"README-PT.md","changelog":null,"contributing":"CONTRIBUTING-PT.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-14T14:52:35.000Z","updated_at":"2024-04-01T18:34:39.000Z","dependencies_parsed_at":"2024-01-16T15:33:45.377Z","dependency_job_id":"c60cc631-0b1d-4e04-a132-e224a6f6a483","html_url":"https://github.com/pedrovs3/react-router","commit_stats":{"total_commits":67,"total_committers":2,"mean_commits":33.5,"dds":0.04477611940298509,"last_synced_commit":"2b8d67b4d73be54656304bc574045cafd58bafc2"},"previous_names":["pedrovs3/react-router"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedrovs3%2Freact-router","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedrovs3%2Freact-router/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedrovs3%2Freact-router/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pedrovs3%2Freact-router/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pedrovs3","download_url":"https://codeload.github.com/pedrovs3/react-router/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237822071,"owners_count":19371827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library","open-source","react","react-router","router","typescript"],"created_at":"2025-02-09T02:18:06.308Z","updated_at":"2025-02-09T02:18:06.748Z","avatar_url":"https://github.com/pedrovs3.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @pedrovs3/react-router\n\n\n\u003cdetails\u003e\n    \u003csummary\u003eVeja em outra língua:\u003c/summary\u003e\n\n[![en](https://img.shields.io/badge/lang-en-red.svg)](https://github.com/pedrovs3/react-router/blob/main/README.md)\n\u003c/details\u003e\n\n\n![GitHub repo size](https://img.shields.io/github/repo-size/pedrovs3/react-router?style=for-the-badge)\n![GitHub language count](https://img.shields.io/github/languages/count/pedrovs3/react-router?style=for-the-badge)\n![GitHub forks](https://img.shields.io/github/forks/pedrovs3/react-router?style=for-the-badge)\n![Github open issues](https://img.shields.io/github/issues/pedrovs3/react-router?style=for-the-badge)\n![Github open pull requests](https://img.shields.io/github/issues-pr-raw/pedrovs3/react-router?style=for-the-badge)\n\n\u003cimg src=\"https://logos-world.net/wp-content/uploads/2023/08/React-Symbol.png\" alt=\"Exemplo imagem\"\u003e\n\n\u003e Esta é uma biblioteca de roteamento simples, leve e flexível para aplicações React. Ela fornece um conjunto de\ncomponentes e hooks para lidar com o roteamento em sua aplicação, incluindo suporte para rotas dinâmicas com parâmetros\nna URL.\n\n## 📝 Índice\n\n\u003c!-- TOC --\u003e\n* [@pedrovs3/react-router](#pedrovs3react-router)\n  * [📝 Índice](#-índice)\n  * [Sobre o projeto](#sobre-o-projeto)\n    * [Funcionalidades e recursos](#funcionalidades-e-recursos)\n    * [Ajustes e melhorias](#ajustes-e-melhorias)\n  * [💻 Pré-requisitos](#-pré-requisitos)\n  * [🚀 Instalando @pedrovs3/react-router](#-instalando-pedrovs3react-router)\n  * [☕ Usando @pedrovs3/react-router](#-usando-pedrovs3react-router)\n  * [📫 Contribuindo](#-contribuindo)\n  * [🤝 Colaboradores](#-colaboradores)\n  * [😄 Seja um dos contribuidores](#-seja-um-dos-contribuidores)\n  * [📝 Licença](#-licença)\n\u003c!-- TOC --\u003e\n\n## Sobre o projeto\n\nEssa biblioteca foi criada para aprender mais sobre o funcionamento de um Router para React e como criar uma\nbiblioteca para React. Ela foi inspirada no React Router e no React Router Dom, porém, possui uma API mais simples e\nflexível. Além disso, ela é mais leve e não possui dependencias externas.\n\n\n### Funcionalidades e recursos\n\n- [x] **API Simples**: Basta envolver a sua aplicação com o componente `Router` e usar o componente `Route` para definir as suas\n  rotas.\n- [x] **Rotas Dinâmicas**: Defina facilmente rotas com parâmetros de caminho, como \"/user/:id\". O componente `Route`\n  extrairá automaticamente esses parâmetros e os passará para o seu componente.\n- [x] **Query Params**: Acesse os query params de seus componentes com o hook `useRouterContext`.\n- [x] **Página 404**: Defina uma página 404 personalizada que será exibida quando nenhuma rota corresponder.\n- [x] **Guarded routes**: Defina rotas que só podem ser acessadas se o usuário estiver autenticado.\n- [x] **Hooks**: Possui hooks para acessar o histórico de navegação e o contexto do roteador.\n- [x] **Metadata**: Defina metadados para suas rotas, como, por exemplo, título da página e descrição para melhorar o `SEO`.\n- [x] **Lazy loading**: Suporte para carregamento assíncrono de componentes.\n- [x] **Suporte ao TypeScript**: Todos os componentes e hooks são totalmente tipados.\n- [x] **Documentação**: Documentação completa com exemplos de uso.\n- [x] **Testes**: Testes unitários e de integração.\n- [x] **Tamanho**: Tamanho menor do que outras libs.\n- [x] **Sem dependências**: Não possui dependências externas.\n- [x] **Compatibilidade**: Compatível com React 16.8.0 ou superior.\n\n### Ajustes e melhorias\n\nO projeto ainda está em desenvolvimento e as próximas atualizações serão voltadas nas seguintes tarefas:\n\n- [x] Otimização do código\n- [x] Melhorar a documentação\n- [ ] Adicionar mais exemplos de uso\n- [ ] Testar implementação com Next.js\n\n## 💻 Pré-requisitos\n\nAntes de começar, verifique se você atendeu aos seguintes requisitos:\n\n- Você instalou a versão mais recente de `\u003cNode / npm / yarn\u003e`\n- Você tem uma máquina `\u003cWindows / Linux / Mac\u003e`.\n- Você criou um projeto React com `\u003ccreate-react-app / Vite\u003e`.\n\n## 🚀 Instalando @pedrovs3/react-router\n\nPara instalar o react-router, siga estas etapas:\n\n**NPM**:\n\n```\nnpm i @pedrovs3/react-router\n```\n\n**YARN**:\n\n```\nyarn add @pedrovs3/react-router\n```\n\n**PNPM**:\n\n```\npnpm add @pedrovs3/react-router\n```\n\n## ☕ Usando @pedrovs3/react-router\n\nPara usar o router no seu projeto, siga estas etapas:\n\n**1.** Importe o componente `Router` e o componente `Route`:\n\n```typescriptreact\nimport { Router, Route } from '@pedrovs3/react-router';\n```\n\n**2.** Envolva a sua aplicação com o componente `Router`:\n\n```typescriptreact\nimport { Router } from '@pedrovs3/react-router';\n\nconst App = () =\u003e (\n  \u003cdiv className=\"App\"\u003e\n    \u003cRouter\u003e\n      {/* Rotas */}\n    \u003c/Router\u003e\n  \u003c/div\u003e\n);\n```\n\n**3.** Defina as suas rotas com o componente `Route`:\n\n```typescriptreact\nimport { Router, Route } from '@pedrovs3/react-router';\n\nconst App = () =\u003e (\n  \u003cdiv className=\"App\"\u003e\n    \u003cRouter\u003e\n      \u003cRoute path=\"/home\" component={Home} /\u003e\n      \u003cRoute path=\"/about\" component={About} /\u003e\n      \u003cRoute path=\"/user/:id\" component={User} /\u003e\n    \u003c/Router\u003e\n  \u003c/div\u003e\n);\n```\n\n\u003e Neste exemplo, `Home`, `About` e `User` são seus componentes. O componente `User` receberá uma prop `pathParams` com\no ‘id’ da URL.\n\n**4.** Utilizando lazy loading:\n\n**4.1** Importe `lazy` do React:\n\n```typescriptreact\nimport { Router, Route } from '@pedrovs3/react-router';\nimport { lazy } from 'react';\n```\n\n**4.2** Importe o componente que você deseja carregar de forma assíncrona:\n\n```typescriptreact\nimport { Router, Route } from '@pedrovs3/react-router';\nimport { lazy } from 'react';\n\n// Example with lazy loading\nconst About = lazy(() =\u003e import('./About'));\n```\n\n**4.3** Por fim, passe o componente importado para o componente `Route`:\n\n```typescriptreact\nimport { Router, Route } from '@pedrovs3/react-router';\nimport { lazy } from 'react';\n\n// Example with lazy loading\nconst About = lazy(() =\u003e import('./About'));\n\nconst App = () =\u003e (\n  \u003cRouter\u003e\n    \u003cRoute path=\"/home\" component={Home} /\u003e\n    \u003cRoute path=\"/about\" component={About} /\u003e\n    \u003cRoute path=\"/user/:id\" component={User} /\u003e\n  \u003c/Router\u003e\n);\n```\n\u003e O router cuida de todo o resto, como, por exemplo, carregar o componente de forma assíncrona e passar os parâmetros da\nURL para o componente.\n\n## 📫 Contribuindo\n\nPara contribuir com o projeto, siga estas etapas:\n\n1. Bifurque este repositório.\n2. Crie um branch: `git checkout -b \u003cnome_branch\u003e`.\n3. Faça as suas alterações e confirme-as: `git commit -m '\u003cmensagem_commit\u003e'`\n4. Envie para o branch original: `git push origin \u003cnome_do_projeto\u003e / \u003clocal\u003e`\n5. Crie a solicitação de pull.\n\nComo alternativa, consulte a documentação do GitHub em [como criar uma solicitação pull](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).\n\n## 🤝 Colaboradores\n\nAgradecemos às seguintes pessoas que contribuíram para este projeto:\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd style=\"text-align: center;\"\u003e\n      \u003ca href=\"https://github.com/pedrovs3\" title=\"Perfil do colaborador\"\u003e\n        \u003cimg src=\"https://avatars.githubusercontent.com/u/86010036\" style=\"border-radius: 50%\" width=\"100px;\" alt=\"Foto do Pedro Vieira no GitHub\"/\u003e\u003cbr\u003e\n        \u003csub\u003e\n          \u003cb\u003ePedro Vieira\u003c/b\u003e\n        \u003c/sub\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## 😄 Seja um dos contribuidores\n\nQuer fazer parte desse projeto? Clique [AQUI](CONTRIBUTING.md) e leia como contribuir.\n\n## 📝 Licença\n\nEsse projeto está sob licença MIT. Veja o arquivo [LICENÇA](LICENSE) para mais detalhes.\n\n[⬆ Voltar ao topo](#pedrovs3react-router)\u003cbr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedrovs3%2Freact-router","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpedrovs3%2Freact-router","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpedrovs3%2Freact-router/lists"}