{"id":29342559,"url":"https://github.com/impeterk/remix-toploader","last_synced_at":"2025-07-08T11:01:58.303Z","repository":{"id":257827481,"uuid":"873210366","full_name":"impeterk/remix-toploader","owner":"impeterk","description":"A Remix/React Router Top Loading Bar based on NProgress -- inspired by nextjs-toploader","archived":false,"fork":false,"pushed_at":"2025-01-30T23:14:36.000Z","size":81,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T22:51:01.394Z","etag":null,"topics":["progressbar","react-router","react-router-v7","remix","remix-run","toploader"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/remix-toploader","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/impeterk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-15T19:28:14.000Z","updated_at":"2025-03-15T16:59:05.000Z","dependencies_parsed_at":"2024-10-17T23:15:15.274Z","dependency_job_id":null,"html_url":"https://github.com/impeterk/remix-toploader","commit_stats":null,"previous_names":["impeterk/remix-toploader"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/impeterk/remix-toploader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impeterk%2Fremix-toploader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impeterk%2Fremix-toploader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impeterk%2Fremix-toploader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impeterk%2Fremix-toploader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/impeterk","download_url":"https://codeload.github.com/impeterk/remix-toploader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/impeterk%2Fremix-toploader/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263450555,"owners_count":23468268,"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":["progressbar","react-router","react-router-v7","remix","remix-run","toploader"],"created_at":"2025-07-08T11:01:10.713Z","updated_at":"2025-07-08T11:01:58.290Z","avatar_url":"https://github.com/impeterk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Remix / React Router TopLoader\n\n- A Remix and React Router Top Loading bar Component **heavily** inspired by [Next.js TopLoader](https://github.com/TheSGJ/nextjs-toploader). Based on [NProgress](https://www.npmjs.com/package/nprogress)\n\n\u003e :exclamation: This is my first package. Contributions are welcomed 👍\n\n![Remix/Router v7 Top Loader](https://github.com/user-attachments/assets/99723ebb-c35b-4d47-b14c-577aeaa5aa22)\n\n## Install\n\nusing npm:\n\n```bash\nnpm install remix-toploader\n```\n\nusing yarn:\n\n```bash\nyarn add remix-toploader\n```\n\nusing pnpm:\n\n```bash\npnpm add remix-toploader\n```\n\n## Usage\n\nimport using:\n\n```js\n// in Remix v2\nimport RemixTopLoader from \"remix-toploader\";\n// or\nimport { RemixTopLoader } from \"remix-toploader\";\n\n// in React Router v7\nimport { RouterTopLoader } from \"remix-toploader\";\n```\n\nNavigate to `root.tsx` of your app and add `\u003cRemixTopLoader /\u003e` to the `\u003cbody\u003e` tag.\n\n```js\nexport function Layout({ children }) {\n  return (\n    \u003chtml lang=\"en\"\u003e\n      \u003chead\u003e\n        \u003cmeta charSet=\"utf-8\" /\u003e\n        \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1\" /\u003e\n        \u003cMeta /\u003e\n        \u003cLinks /\u003e\n      \u003c/head\u003e\n      \u003cbody\u003e\n        {/* in Remix v2 */}\n        \u003cRemixTopLoader /\u003e\n        {/* in React Router v7 */}\n        \u003cRouterTopLoader /\u003e\n        {children}\n        \u003cScrollRestoration /\u003e\n        \u003cScripts /\u003e\n      \u003c/body\u003e\n    \u003c/html\u003e\n  );\n}\n```\n\n### Default Configuration\n\nDefault styles and configuration without any props passed\n\n```jsx\n\u003cRemixTopLoader\n  color=\"#2299DD\"\n  initialPosition={0.08}\n  crawlSpeed={200}\n  height={3}\n  crawl={true}\n  showSpinner={true}\n  easing=\"ease\"\n  speed={200}\n  shadow=\"0 0 10px #2299DD,0 0 5px #2299DD\"\n  template='\u003cdiv class=\"bar\" role=\"bar\"\u003e\u003cdiv class=\"peg\"\u003e\u003c/div\u003e\u003c/div\u003e \n  \u003cdiv class=\"spinner\" role=\"spinner\"\u003e\u003cdiv class=\"spinner-icon\"\u003e\u003c/div\u003e\u003c/div\u003e'\n  zIndex={1600}\n  showAtBottom={false}\n/\u003e\n```\n\n- `color`: to change the default color of TopLoader.\n- `initialPosition`: to change initial position for the TopLoader in percentage, : `0.08 = 8%`.\n- `crawlSpeed`: increment delay speed in `ms`.\n- `speed`: animation speed for the TopLoader in `ms`\n- `easing`: animation settings using easing (a CSS easing string).\n- `height`: height of TopLoader in `px`.\n- `crawl`: auto incrementing behavior for the TopLoader.\n- `showSpinner`: to show spinner or not.\n- `shadow`: a smooth shadow for the TopLoader. (set to `false` to disable it)\n- `template`: to include custom HTML attributes for the TopLoader.\n- `zIndex`: defines zIndex for the TopLoader.\n- `showAtBottom`: To show the TopLoader at bottom. (increase height for the TopLoader to ensure it's visibility at the mobile devices)\n\n#### `RemixTopLoaderProps`\n\n| **Name**            | **Type**          | **Default Value**                                                                                                                       |\n| ------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `color`             | `string`          | `\"#2299DD\"`                                                                                                                             |\n| `initialPosition`   | `number`          | `0.08`                                                                                                                                  |\n| `crawlSpeed`        | `number`          | `200`                                                                                                                                   |\n| `height`            | `number`          | `3`                                                                                                                                     |\n| `crawl`             | `boolean`         | `true`                                                                                                                                  |\n| `showSpinner`       | `boolean`         | `true`                                                                                                                                  |\n| `easing`            | `string`          | `\"ease\"`                                                                                                                                |\n| `speed`             | `number`          | `200`                                                                                                                                   |\n| `shadow`            | `string \\| false` | `\"0 0 10px #2299DD,0 0 5px #2299DD\"`                                                                                                    |\n| `template`          | `string`          | `\"\u003cdiv class=\"bar\" role=\"bar\"\u003e\u003cdiv class=\"peg\"\u003e\u003c/div\u003e\u003c/div\u003e\u003cdiv class=\"spinner\" role=\"spinner\"\u003e\u003cdiv class=\"spinner-icon\"\u003e\u003c/div\u003e\u003c/div\u003e\"` |\n| `zIndex`            | `number`          | `1600`                                                                                                                                  |\n| `showAtBottom`      | `boolean`         | `false`                                                                                                                                 |\n| `showForHashAnchor` | `boolean`         | `true`                                                                                                                                  |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimpeterk%2Fremix-toploader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimpeterk%2Fremix-toploader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimpeterk%2Fremix-toploader/lists"}