{"id":21660248,"url":"https://github.com/bryaneaton13/react-pull-to-refresh","last_synced_at":"2025-05-16T08:04:29.703Z","repository":{"id":57135352,"uuid":"46529198","full_name":"bryaneaton13/react-pull-to-refresh","owner":"bryaneaton13","description":"React component for web pull to refresh","archived":false,"fork":false,"pushed_at":"2023-03-22T14:11:09.000Z","size":654,"stargazers_count":482,"open_issues_count":5,"forks_count":74,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-09T07:43:44.653Z","etag":null,"topics":["pull-down-refresh","pull-to-refresh","react","reactjs","web"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/react-pull-to-refresh","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/bryaneaton13.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2015-11-20T00:38:52.000Z","updated_at":"2025-04-30T00:07:48.000Z","dependencies_parsed_at":"2024-06-18T14:06:54.455Z","dependency_job_id":null,"html_url":"https://github.com/bryaneaton13/react-pull-to-refresh","commit_stats":{"total_commits":41,"total_committers":6,"mean_commits":6.833333333333333,"dds":"0.24390243902439024","last_synced_commit":"f0e07ec55ebce71b906e84c7a6d50861c425e5e5"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryaneaton13%2Freact-pull-to-refresh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryaneaton13%2Freact-pull-to-refresh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryaneaton13%2Freact-pull-to-refresh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryaneaton13%2Freact-pull-to-refresh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bryaneaton13","download_url":"https://codeload.github.com/bryaneaton13/react-pull-to-refresh/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254493378,"owners_count":22080126,"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":["pull-down-refresh","pull-to-refresh","react","reactjs","web"],"created_at":"2024-11-25T09:32:33.021Z","updated_at":"2025-05-16T08:04:24.684Z","avatar_url":"https://github.com/bryaneaton13.png","language":"TypeScript","readme":"# react-pull-to-refresh\n\n`npm install react-pull-to-refresh -S`\n\nA pull to refresh component for the web.\n\nBased on Andy Peatling's [Pull to Refresh for the Web](https://github.com/apeatling/web-pull-to-refresh)\n\n![Demo GIF](https://github.com/bryaneaton13/react-pull-to-refresh/blob/master/docs/demo.gif)\n\n## Usage\n\nYour refresh handler function takes in `resolve` and `reject` to tell the PullToRefresh component when it's finished.\n\n```typescript\nasync handleRefresh() {\n  await asyncCode();\n}\n\n```\n\nWhere you want to render the component:\n\n```typescript\n\u003cReactPullToRefresh onRefresh={handleRefresh} className=\"your-own-class-if-you-want\" style={{ textAlign: 'center' }}\u003e\n  \u003ch3\u003ePull down to refresh\u003c/h3\u003e\n  \u003cdiv\u003e{items}\u003c/div\u003e\n  \u003cdiv\u003eetc.\u003c/div\u003e\n\u003c/ReactPullToRefresh\u003e\n```\n\n## CSS\n\nUse the CSS from [the example](https://github.com/bryaneaton13/react-pull-to-refresh/blob/master/playground/app.css) as a starting point.\n\n## All props\n\n```typescript\nexport interface ReactPullToRefreshProps extends HTMLAttributes\u003cHTMLDivElement\u003e {\n  onRefresh: () =\u003e Promise\u003cvoid\u003e;\n  icon?: ReactNode;\n  loading?: ReactNode;\n  disabled?: boolean;\n  distanceToRefresh?: number;\n  resistance?: number;\n  hammerOptions?: {\n    cssProps?: CssProps | undefined;\n    domEvents?: boolean | undefined;\n    enable?: boolean | ((manager:  HammerManager) =\u003e boolean) | undefined;\n    preset?: RecognizerTuple[] | undefined;\n    touchAction?: string | undefined;\n    recognizers?: RecognizerTuple[] | undefined;\n    inputClass?: HammerInput | undefined;\n    inputTarget?: EventTarget | undefined;\n  }\n```\n\n- **onRefresh**: `() =\u003e Promise\u003cvoid\u003e`\n- **icon**: `ReactNode`\n  - _default:_\n  ```html\n  \u003cspan className=\"genericon genericon-next\"\u003e\u003c/span\u003e\n  ```\n- **loading**: `ReactNode`\n  - _default:_\n  ```html\n  \u003cdiv className=\"loading\"\u003e\n    \u003cspan className=\"loading-ptr-1\"\u003e\u003c/span\u003e\n    \u003cspan className=\"loading-ptr-2\"\u003e\u003c/span\u003e\n    \u003cspan className=\"loading-ptr-3\"\u003e\u003c/span\u003e\n  \u003c/div\u003e\n  ```\n- **disabled**: `boolean`\n- **className**: `string`\n- **style**: `object`\n- **distanceToRefresh**: `number`\n  - _default_: `70`\n- **resistance**: `number`\n  - _default_: `2.5`\n- **hammerOptions**: `HammerOptions`\n  ```typescript\n  interface HammerOptions {\n    cssProps?: CssProps | undefined;\n    domEvents?: boolean | undefined;\n    enable?: boolean | ((manager: HammerManager) =\u003e boolean) | undefined;\n    preset?: RecognizerTuple[] | undefined;\n    touchAction?: string | undefined;\n    recognizers?: RecognizerTuple[] | undefined;\n    inputClass?: HammerInput | undefined;\n    inputTarget?: EventTarget | undefined;\n  }\n  ```\n\n## Running the code\n\n1. Checkout the repo\n2. Run `npm install`\n3. Run `npm run play` to open the code from `/playground`\n\n## Thanks\n\n[Andy Peatling](http://apeatling.com/)\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryaneaton13%2Freact-pull-to-refresh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryaneaton13%2Freact-pull-to-refresh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryaneaton13%2Freact-pull-to-refresh/lists"}