{"id":19529894,"url":"https://github.com/loopmode/react-async-state","last_synced_at":"2025-02-26T02:43:12.783Z","repository":{"id":140399804,"uuid":"100951828","full_name":"loopmode/react-async-state","owner":"loopmode","description":"A wrapper component that indicates pending status of promises returned by callbacks of the wrapped child","archived":false,"fork":false,"pushed_at":"2018-04-19T14:42:17.000Z","size":287,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-09T19:02:57.589Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/loopmode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2017-08-21T12:48:17.000Z","updated_at":"2018-04-19T14:42:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"1172a422-2161-430c-a180-aa42b22d542f","html_url":"https://github.com/loopmode/react-async-state","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loopmode%2Freact-async-state","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loopmode%2Freact-async-state/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loopmode%2Freact-async-state/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loopmode%2Freact-async-state/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loopmode","download_url":"https://codeload.github.com/loopmode/react-async-state/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240783109,"owners_count":19856776,"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-11-11T01:28:03.426Z","updated_at":"2025-02-26T02:43:12.747Z","avatar_url":"https://github.com/loopmode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# async-state\n\nA wrapper component that indicates the pending state of a child callback.\n\nIt works as a plain wrapper around anything with a click handler that returns a promise.\nWhile the promise is pending, the wrapped components receives one or more flags to indicate that (default: `isPending` and `disabled`).\n\n\u003cimg src=\"https://github.com/loopmode/react-async-state/raw/master/react-async-state-success.gif\" /\u003e\n\n\u003cimg src=\"https://github.com/loopmode/react-async-state/raw/master/react-async-state-error.gif\" /\u003e\n\n\nWhat's needed on your side is\n- the click callback returns a promise\n- the wrapped component understands how to show pending state (e.g. show a spinner when it receives the prop `showSpinner`)\n- the wrapped component understands how to show success or error state based on CSS classes (e.g `success`: show in green, `danger`: show in red)\n\n```javascript\nrender() {\n    return (\n        \u003cdiv\u003e\n            ...\n            \u003cAsyncState\u003e\n                \u003cbutton onClick={this.refresh}\u003erefresh\u003c/button\u003e\n            \u003c/AsyncState\u003e\n            ...\n        \u003c/div\u003e\n    );\n}\nasync refresh() {\n    // have the handle function be async, or return a promise\n    // return new Promise((resolve) =\u003e setTimeout(resolve, 1000))\n}\n    \n```\n\n## Why\n\nWhy would you need this? Because you don't want to manually keep pending states all over the place.\n\nNow you can write:\n\n```javascript\nimport React, { Component } from 'react';\nimport AsyncState from '@loopmode/react-async-state';\n\nexport class MyComponent extends Component {\n    render() {\n        return (\n            \u003cdiv\u003e\n                \u003cAsyncState\u003e\n                    \u003cbutton onClick={this.load}\u003eload\u003c/button\u003e\n                \u003c/AsyncState\u003e\n                \u003cAsyncState\u003e\n                    \u003cbutton onClick={this.save}\u003esave\u003c/button\u003e\n                \u003c/AsyncState\u003e\n            \u003c/div\u003e\n        );\n    }\n    load = () =\u003e someApi.load();\n    save = () =\u003e someApi.save();\n}\n\n```\n\nCompare that to manual handling of pending state:\n\n```javascript\nimport React, { Component } from 'react';\n\nexport class MyComponent extends Component {\n    state = {\n        isLoading: false,\n        showLoadSuccess: false,\n        showLoadError: false,\n        isSaving: false,\n        showSaveSuccess: false,\n        showSaveError: false,\n    }\n    componentDidMount() {\n        this._isMounted = true;\n    }\n    componentWillUnmount() {\n        this._isMounted = false;\n    }\n    render() {\n        return (\n            \u003cdiv\u003e\n                \u003cbutton onClick={this.load}\u003eload\u003c/button\u003e\n                \u003cbutton onClick={this.save}\u003esave\u003c/button\u003e\n            \u003c/div\u003e\n        );\n    }\n    load = () =\u003e {\n        this.setState({\n            isLoading: true\n            showLoadSuccess: false,\n            showLoadError: false\n        });\n        someApi.load()\n            .then(() =\u003e {\n                this._isMounted \u0026\u0026 this.setState({\n                    isLoading: false,\n                    showLoadSuccess: true\n                });\n                setTimeout(() =\u003e {\n                    this._isMounted \u0026\u0026 this.setState({\n                        showLoadSuccess: false,\n                    })\n                }, 1000)\n            })\n            .catch(error =\u003e {\n                this._isMounted \u0026\u0026 this.setState({\n                    isLoading: false,\n                    showLoadError: true\n                });\n                setTimeout(() =\u003e {\n                    this._isMounted \u0026\u0026 this.setState({\n                        showLoadError: false,\n                    })\n                }, 1000)\n            })\n    }\n    save = () =\u003e {\n        this.setState({\n            isSaving: true\n            showSaveSuccess: false,\n            showSaveError: false\n        });\n        someApi.save()\n            .then(() =\u003e {\n                this._isMounted \u0026\u0026 this.setState({\n                    isSaving: false,\n                    showSaveSuccess: true\n                });\n                setTimeout(() =\u003e {\n                    this._isMounted \u0026\u0026 this.setState({\n                        showSaveSuccess: false,\n                    })\n                }, 1000)\n            })\n            .catch(error =\u003e {\n                this._isMounted \u0026\u0026 this.setState({\n                    isSaving: false,\n                    showSaveError: true\n                });\n                setTimeout(() =\u003e {\n                    this._isMounted \u0026\u0026 this.setState({\n                        showSaveError: false,\n                    })\n                }, 1000)\n            })\n    }\n}\n\n```\n\n\n\n## TODO\n\n- proper documentation\n- add tests\n- add examples","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floopmode%2Freact-async-state","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floopmode%2Freact-async-state","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floopmode%2Freact-async-state/lists"}