{"id":18810128,"url":"https://github.com/agneym/react-loading","last_synced_at":"2025-04-13T20:30:45.912Z","repository":{"id":56230704,"uuid":"301086408","full_name":"agneym/react-loading","owner":"agneym","description":"Accessible and Simple Loading indicators in React","archived":false,"fork":false,"pushed_at":"2021-06-04T17:02:00.000Z","size":1771,"stargazers_count":64,"open_issues_count":0,"forks_count":12,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-09-30T10:08:01.000Z","etag":null,"topics":["react"],"latest_commit_sha":null,"homepage":"https://agneym.github.io/react-loading/","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/agneym.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}},"created_at":"2020-10-04T09:15:16.000Z","updated_at":"2024-07-31T16:01:58.000Z","dependencies_parsed_at":"2022-08-15T15:01:13.261Z","dependency_job_id":null,"html_url":"https://github.com/agneym/react-loading","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agneym%2Freact-loading","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agneym%2Freact-loading/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agneym%2Freact-loading/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agneym%2Freact-loading/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agneym","download_url":"https://codeload.github.com/agneym/react-loading/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223603011,"owners_count":17172018,"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":["react"],"created_at":"2024-11-07T23:19:01.121Z","updated_at":"2024-11-07T23:19:02.181Z","avatar_url":"https://github.com/agneym.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch2 align=\"center\"\u003eReact Loading\u003c/h2\u003e\n\u003cp align=\"center\"\u003e\nSimple and Accessible loading indicators with React.\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003ca href=\"https://www.npmjs.com/package/@agney/react-loading\"\u003e\n  \u003cimg src=\"https://badge.fury.io/js/%40agney%2Freact-loading.svg\" /\u003e\n\u003c/a\u003e\n\u003cimg src=\"https://img.shields.io/badge/module%20formats-cjs%2C%20esm-green.svg\" /\u003e\n\u003cbr /\u003e\n\u003ca href=\"https://github.com/agneym/react-loading/actions\"\u003e\n  \u003cimg src=\"https://github.com/agneym/react-loading/workflows/CI/badge.svg\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://prettier.io\"\u003e\n  \u003cimg alt=\"code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"http://makeapullrequest.com\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\" /\u003e\n\u003c/a\u003e\n\nComes bundled with React components of [Sam Herbert's animated SVG loaders](https://github.com/SamHerbert/SVG-Loaders) in a tree shakeable package.\n\n![Example of loading indicator SVGs](./example/indicator.gif)\n\n## Installation\n\n```bash\nnpm i @agney/react-loading\n# OR\nyarn add @agney/react-loading\n```\n\n[Demo](https://agneym.github.io/react-loading/)\n\n## Features\n\n- **Small Size**\n\n  The entire library is about [20kB minified](https://bundlephobia.com/result?p=@agney/react-loading). _But you would never need the whole bundle._\n\n  The library is build to be treeshakeable that when you use one or two of the bundled loaders, you would have **less than 1kB** in your bundle.\n\n  No dependencies either 😇\n\n- **Accessibility**\n\n  Provides accessibility attributes on your loading components and containers.\n\n  `aria-busy` is set to `true` on container on loading and progress indicators have `role=progressbar`.\n\n- **Specify a Global loader**\n\n  You probably don't want loader components mixed everywhere, so you can specify a `LoaderContext` that can be overridden later if necessary.\n\n- **Bring your own loader**\n\n  If you decide to bring your own loading indicator, library would support that as well, keeping all your logic the same.\n\n- TypeScript support. Zero extra CSS.\n\n## Usage\n\n```javascript\nimport { useLoading, Audio } from '@agney/react-loading';\n\nfunction Content() {\n  const { containerProps, indicatorEl } = useLoading({\n    loading: true,\n    indicator: \u003cAudio width=\"50\" /\u003e,\n  });\n\n  return (\n    {/* Accessibility props injected to container */}\n    \u003csection {...containerProps}\u003e\n      {indicatorEl} {/* renders only while loading */}\n    \u003c/section\u003e\n  );\n}\n```\n[Sample](https://codesandbox.io/s/agneyreact-loading-example-9jj7c)\n\n## Loaders\n\nThis library comes bundled with React components of [Sam Herbert's animated SVG loaders](https://github.com/SamHerbert/SVG-Loaders) in a tree shakeable package.\n\nEach loader is an SVG and all props passed shall be applied to the top SVG element. All SVGs are set to inherit `currentColor` from it's parents for fill/stroke.\n\nAvailable loaders are:\n\n```javascript\nimport {\n  Audio,\n  BallTriangle,\n  Bars,\n  Circles,\n  Grid,\n  Hearts,\n  Oval,\n  Puff,\n  Rings,\n  SpinningCircles,\n  TailSpin,\n  ThreeDots,\n} from '@agney/react-loading';\n```\n\nOnly the ones you use will be included in your bundle when you use a bundler like Webpack/Rollup.\n\n## Context\n\nYou can specify a single loading indicator reused across hooks with the `LoaderProvider`.\n\n```javascript\nimport { LoaderProvider, useLoading, BallTriangle } from '@agney/react-loading';\n\nfunction App() {\n  const { containerProps, indicatorEl } = useLoading({\n    loading: true,\n  });\n  return \u003csection {...containerProps}\u003e{indicatorEl}\u003c/section\u003e;\n}\n\nReactDOM.render(\n  \u003cLoaderProvider indicator={\u003cBallTriangle width=\"50\" /\u003e}\u003e\n    \u003cApp /\u003e\n  \u003c/LoaderProvider\u003e\n);\n```\n\nYou can use as many `LoaderProvider` provider elements as you like and React will pick the one closest to the hook you are rendering.\n\n[More on React Context](https://reactjs.org/docs/context.html)\n\n## Extra Props on Loader\n\nIf you want to provide specific props on a loader specifically when you use the hook:\n\n```javascript\nuseLoading({\n  loading: true,\n  loaderProps: {\n    // Any props here would be spread on to the indicator element.\n    style: {{ margin: '0 auto' }}\n  }\n});\n```\n\nWe also a provide a special key for `valueText`, that will be used as description for indicator:\n\n```javascript\nuseLoading({\n  loading: true,\n  loaderProps: {\n    valueText: 'Fetching video from the Great Internet',\n  },\n});\n\n// now this will generate:\n/* \u003csvg role=\"progressbar\" aria-valuetext=\"Fetching video from the Great Internet\"\u003e\u003c/svg\u003e*/\n```\n\n`aria-valuetext` will be read by screenreaders.\n\nYou could also provide `aria-valuenow` for indicators that display progress (but the prebundled ones are best for indeterminate progress indicators)\n\n[MDN for Reference on `progressbar`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_progressbar_role)\n\n## Bring your own loader\n\nJust switch the import to your own loading indicator (just make sure that it accepts props)\n\n```javascript\nimport { LoaderProvider, useLoading } from '@agney/react-loading';\n\nconst Loader = ({ ...rest }) =\u003e \u003cp {...rest}\u003eLoading...\u003c/p\u003e;\n\nfunction App() {\n  const { containerProps, indicatorEl } = useLoading({\n    loading: true,\n  });\n  return \u003csection {...containerProps}\u003e{indicatorEl}\u003c/section\u003e;\n}\n\nReactDOM.render(\n  \u003cLoaderProvider indicator={\u003cLoader /\u003e}\u003e\n    \u003cApp /\u003e\n  \u003c/LoaderProvider\u003e\n);\n```\n\n# Contributing\n\nAll PRs welcome.\n\n## Development\n\nWe use [`tsdx`](https://github.com/formium/tsdx) for generating boilerplate.\n\n**Install:**\n\n```bash\n# Library\nnpm i\n\n# Example\ncd example \u0026\u0026 npm i\n```\n\n**Development:**\n\n```bash\n# Running library dev\nnpm start\n\n# Running example\ncd example \u0026\u0026 npm start\n```\n\n**Testing:**\n\nTesting with `react-testing-library` and `jest`\n\n```bash\nnpm test\n```\n\nCommands are available in detail on tsdx repository.\n\n# Credits\n\n- [Sam Herbert](http://samherbert.net/) for the amazing SVGs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagneym%2Freact-loading","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagneym%2Freact-loading","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagneym%2Freact-loading/lists"}