{"id":22492708,"url":"https://github.com/tobysmith568/hook-adapter","last_synced_at":"2025-08-03T00:31:37.033Z","repository":{"id":262724449,"uuid":"888127995","full_name":"tobysmith568/hook-adapter","owner":"tobysmith568","description":"A lightweight adapter pattern for using React hooks in class components.","archived":false,"fork":false,"pushed_at":"2024-11-29T02:31:26.000Z","size":77,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-29T03:29:32.620Z","etag":null,"topics":["adapter","class-components","functional-components","hook","hooks","react"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/hook-adapter","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tobysmith568.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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-11-13T21:32:45.000Z","updated_at":"2024-11-29T02:31:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"72d3e8c1-9075-421a-999e-48a72cd49ea9","html_url":"https://github.com/tobysmith568/hook-adapter","commit_stats":null,"previous_names":["tobysmith568/hook-adapter"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobysmith568%2Fhook-adapter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobysmith568%2Fhook-adapter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobysmith568%2Fhook-adapter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tobysmith568%2Fhook-adapter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tobysmith568","download_url":"https://codeload.github.com/tobysmith568/hook-adapter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228508012,"owners_count":17931264,"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":["adapter","class-components","functional-components","hook","hooks","react"],"created_at":"2024-12-06T18:20:49.123Z","updated_at":"2024-12-06T18:20:50.153Z","avatar_url":"https://github.com/tobysmith568.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hook-adapter\n\n\u003ca href=\"https://www.npmjs.com/package/hook-adapter\"\u003e\n  \u003cimg alt=\"\" src=\"https://img.shields.io/npm/v/hook-adapter?logo=npm\"\u003e\n\u003c/a\u003e\n\n\u003ca href=\"https://license-cop.js.org\"\u003e\n  \u003cimg alt=\"Protected by: License-Cop\" src=\"https://license-cop.js.org/shield.svg\"\u003e\n\u003c/a\u003e\n\nA lightweight adapter pattern for using React hooks in class components.\n\nUseful while transitioning from class components to functional components.\n\nAllows you to wrap blocks of JSX within a class component with the result of a hook.\n\nAll hooks are supported, and all hook behaviors like re-renders, state updates, and side effects are preserved.\n\n## Installation\n\n```bash\nnpm install hook-adapter\n```\n\n## Usage\n\n### Hook without parameters\n\nWhen the hook requires no parameters, you can simply pass the hook function itself to the `hook` prop of the `HookAdapter` component.\n\nThe result of the hook is then passed to the children of the `HookAdapter` component via a function children prop.\n\n```jsx\nimport React, { Component } from \"react\";\nimport { HookAdapter } from \"hook-adapter\";\nimport { useMyHook } from \"./use-my-hook\";\n\nexport class MyComponent extends Component {\n  render() {\n    return (\n      \u003cdiv\u003e\n        \u003cHookAdapter hook={useMyHook}\u003e\n          {hookResult =\u003e \u003cAComponentThatNeedsTheHookResult data={hookResult} /\u003e}\n        \u003c/HookAdapter\u003e\n      \u003c/div\u003e\n    );\n  }\n}\n```\n\n### Hooks with parameters\n\nWhen the hook requires parameters, there are two approaches you can take:\n\n- Wrap the hook in a function that takes no parameters\n\n  ```jsx\n  import React, { Component } from \"react\";\n  import { HookAdapter } from \"hook-adapter\";\n  import { useMyHook } from \"./use-my-hook\";\n\n  export class MyComponent extends Component {\n    render() {\n      return (\n        \u003cdiv\u003e\n          \u003cHookAdapter hook={() =\u003e useMyHook(\"param1\", \"param2\")}\u003e\n            {hookResult =\u003e \u003cAComponentThatNeedsTheHookResult data={hookResult} /\u003e}\n          \u003c/HookAdapter\u003e\n        \u003c/div\u003e\n      );\n    }\n  }\n  ```\n\n- Pass in the parameters to the `HookAdapter` component via the `parameters` prop\n\n  ```jsx\n  import React, { Component } from \"react\";\n  import { HookAdapter } from \"hook-adapter\";\n  import { useMyHook } from \"./use-my-hook\";\n\n  export class MyComponent extends Component {\n    render() {\n      return (\n        \u003cdiv\u003e\n          \u003cHookAdapter hook={useMyHook} parameters={[\"param1\", \"param2\"]}\u003e\n            {hookResult =\u003e \u003cAComponentThatNeedsTheHookResult data={hookResult} /\u003e}\n          \u003c/HookAdapter\u003e\n        \u003c/div\u003e\n      );\n    }\n  }\n  ```\n\nBoth approaches are equivalent and are fully type-safe.\n\nYou may find that the latter approach works better with certain linting rules.\n\n## License\n\nhook-adapter is licensed under the [ISC license](./LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftobysmith568%2Fhook-adapter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftobysmith568%2Fhook-adapter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftobysmith568%2Fhook-adapter/lists"}