{"id":18282819,"url":"https://github.com/danielkhakbaz/use-shared","last_synced_at":"2025-10-04T14:12:59.504Z","repository":{"id":233276956,"uuid":"786418991","full_name":"Danielkhakbaz/use-shared","owner":"Danielkhakbaz","description":"a Simple react-hook using contextAPI in order to share a state throughout the whole app.","archived":false,"fork":false,"pushed_at":"2024-11-02T12:26:05.000Z","size":265,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T05:30:32.581Z","etag":null,"topics":["react","react-hooks","react-library","react-package","state-management"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@danielkhakbaz/use-shared","language":"TypeScript","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/Danielkhakbaz.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2024-04-14T12:06:50.000Z","updated_at":"2024-11-02T12:26:09.000Z","dependencies_parsed_at":"2024-12-22T20:29:53.110Z","dependency_job_id":"cd3a2e2a-552c-4419-a356-af66f3f468c1","html_url":"https://github.com/Danielkhakbaz/use-shared","commit_stats":null,"previous_names":["danielkhakbaz/use-shared"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Danielkhakbaz/use-shared","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Danielkhakbaz%2Fuse-shared","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Danielkhakbaz%2Fuse-shared/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Danielkhakbaz%2Fuse-shared/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Danielkhakbaz%2Fuse-shared/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Danielkhakbaz","download_url":"https://codeload.github.com/Danielkhakbaz/use-shared/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Danielkhakbaz%2Fuse-shared/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278322146,"owners_count":25967874,"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","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","react-hooks","react-library","react-package","state-management"],"created_at":"2024-11-05T13:06:21.144Z","updated_at":"2025-10-04T14:12:59.486Z","avatar_url":"https://github.com/Danielkhakbaz.png","language":"TypeScript","readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/Danielkhakbaz/use-shared/blob/master/assets/use-shared-logo.jpeg\" alt=\"use shared's logo\" width=\"200\"\u003e\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n  Use-Shared Hook\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n\u003c/h1\u003e\n\n## Installation\n\nTo install the **use-shared** package in your React project, use **npm** or **yarn**:\n\n```jsx\nnpm install use-shared\n```\n\n\u003cp align=\"center\"\u003eor\u003c/p\u003e\n\n```jsx\nyarn add use-shared\n```\n\n## Usage\n\n### - Import SharedProvider\n\nBegin by importing the **SharedProvider** component from the **use-shared** package:\n\n```jsx\nimport { SharedProvider } from \"@danielkhakbaz/use-shared\";\n```\n\n### - Wrap Your App with SharedProvider\n\nWrap your React application's root component with the **SharedProvider** component. Pass an initial state object as a prop to the **SharedProvider**. This state object will be accessible throughout your entire application:\n\n```jsx\nconst state = {\n  name: \"Danial\",\n  lastName: \"Khakbaz\",\n  profession: \"Front-end Engineer\",\n};\n\nReactDOM.createRoot(document.getElementById(\"root\")).render(\n  \u003cReact.StrictMode\u003e\n    \u003cSharedProvider state={state}\u003e\n      \u003cApp /\u003e\n    \u003c/SharedProvider\u003e\n  \u003c/React.StrictMode\u003e\n);\n```\n\nIn any component within your application, import the **useShared** hook from **use-shared** to access the shared state provided by the **SharedProvider**:\n\n```jsx\nimport { useShared } from \"@danielkhakbaz/use-shared\";\n\nconst App = () =\u003e {\n  const { data, dispatch } = useShared();\n\n  return (\n    \u003cdiv\u003e{/* Access and modify shared state using data and dispatch */}\u003c/div\u003e\n  );\n};\n```\n\n`data: This object represents the current state from the SharedProvider.`\n\u003cbr /\u003e\n`dispatch: This function allows you to update the shared state.`\n\n### - Complete Example\n\n- **_main.jsx_**\n\n```jsx\nimport React from \"react\";\nimport ReactDOM from \"react-dom/client\";\nimport App from \"./App\";\nimport { SharedProvider } from \"@danielkhakbaz/use-shared\";\n\nconst state = {\n  name: \"Danial\",\n  lastName: \"Khakbaz\",\n  profession: \"Front-end Engineer\",\n};\n\nReactDOM.createRoot(document.getElementById(\"root\")).render(\n  \u003cReact.StrictMode\u003e\n    \u003cSharedProvider state={state}\u003e\n      \u003cApp /\u003e\n    \u003c/SharedProvider\u003e\n  \u003c/React.StrictMode\u003e\n);\n```\n\n- **_App.jsx_**\n\n```jsx\nimport { useShared } from \"@danielkhakbaz/use-shared\";\n\nconst App = () =\u003e {\n  const { data, dispatch } = useShared();\n\n  const handleClick = () =\u003e {\n    dispatch({ ...data, profession: \"Software Engineer\" });\n  };\n\n  return (\n    \u003cdiv\u003e\n      \u003cp\u003eName: {data.name}\u003c/p\u003e\n      \u003cp\u003eLast Name: {data.lastName}\u003c/p\u003e\n      \u003cp\u003eProfession: {data.profession}\u003c/p\u003e\n      \u003cbutton onClick={handleClick}\u003eChange Profession\u003c/button\u003e\n    \u003c/div\u003e\n  );\n};\n\nexport default App;\n```\n\n## License\n\nMIT\n\n---\n\u003ca href=\"https://danieloo.vercel.app/\" target=\"_blank\"\u003edanieloo.com\u003c/a\u003e \u0026nbsp;\u0026middot;\u0026nbsp; \u003ca href=\"https://github.com/Danielkhakbaz\" target=\"_blank\"\u003eDanial Khakbaz\u003c/a\u003e \u0026nbsp;\u0026middot;\u0026nbsp; \u003ca href=\"https://twitter.com/DanielKhakbaz\" target=\"_blank\"\u003e@danielkhakbaz\u003c/a\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielkhakbaz%2Fuse-shared","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielkhakbaz%2Fuse-shared","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielkhakbaz%2Fuse-shared/lists"}