{"id":13826928,"url":"https://github.com/sambernard/react-preload","last_synced_at":"2025-07-09T02:32:46.848Z","repository":{"id":33268914,"uuid":"36913482","full_name":"sambernard/react-preload","owner":"sambernard","description":"Component to preload images before showing content","archived":false,"fork":false,"pushed_at":"2018-10-30T21:36:38.000Z","size":44,"stargazers_count":148,"open_issues_count":11,"forks_count":48,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-10T20:41:49.169Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/sambernard.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":"2015-06-05T05:20:49.000Z","updated_at":"2024-06-13T01:15:14.000Z","dependencies_parsed_at":"2022-09-02T09:21:09.999Z","dependency_job_id":null,"html_url":"https://github.com/sambernard/react-preload","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sambernard%2Freact-preload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sambernard%2Freact-preload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sambernard%2Freact-preload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sambernard%2Freact-preload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sambernard","download_url":"https://codeload.github.com/sambernard/react-preload/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225481060,"owners_count":17481144,"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":[],"created_at":"2024-08-04T09:01:46.898Z","updated_at":"2024-11-20T06:30:36.259Z","avatar_url":"https://github.com/sambernard.png","language":"JavaScript","readme":"# React Preload\n[![npm version](https://badge.fury.io/js/react-preload.svg)](http://badge.fury.io/js/react-preload)\n\nA React component to preload images. It renders a passed component during the loader phase, and renders its children once the images have been successfully fetched.\n\n\n## Installation\n\n### npm\n\n```bash\nnpm install react-preload --save\n```\n\n## Usage\n\n```javascript\nvar Preload = require('react-preload').Preload;\n```\n\n```javascript\nvar loadingIndicator = (\u003cdiv\u003eLoading...\u003c/div\u003e);\nvar images = [];\n\n\u003cPreload\n    loadingIndicator={loadingIndicator}\n    images={images}\n    autoResolveDelay={3000}\n    onError={this._handleImageLoadError}\n    onSuccess={this._handleImageLoadSuccess}\n    resolveOnError={true}\n    mountChildren={true}\n\u003e\n    {/* content to be rendered once loading is complete */}\n\u003c/Preload\u003e\n```\n\n## Prop types\n\n```javascript\npropTypes: {\n    // Rendered on success\n    children: PropTypes.element.isRequired,\n\n    // Rendered during load\n    loadingIndicator: PropTypes.node.isRequired, // Default: null\n\n    // Array of image urls to be preloaded\n    images: PropTypes.array, // Default: []\n\n    // If set, the preloader will automatically show\n    // the children content after this amount of time\n    autoResolveDelay: PropTypes.number,\n\n    // Error callback. Is passed the error\n    onError: PropTypes.func,\n\n    // Success callback\n    onSuccess: PropTypes.func,\n\n    // Whether or not we should still show the content\n    // even if there is a preloading error\n    resolveOnError: PropTypes.bool, // Default: true\n\n    // Whether or not we should mount the child content after\n    // images have finished loading (or after autoResolveDelay)\n    mountChildren: PropTypes.bool, // Default: true\n}\n```\n\n## Additional Details\n\nThis module also exposes `ImageCache` and `ImageHelper` which can be used to preload images\ndirectly, and can be accessed via `require('react-preload').ImageCache` and\n`require('react-preload').ImageHelper` respectively.\n\n## License\n\n[MIT][mit-license]\n\n[mit-license]: ./LICENSE\n","funding_links":[],"categories":["JavaScript","📦 Legacy \u0026 Inactive Projects"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsambernard%2Freact-preload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsambernard%2Freact-preload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsambernard%2Freact-preload/lists"}