{"id":14957165,"url":"https://github.com/tam11a/react-use-access","last_synced_at":"2026-02-16T20:03:34.749Z","repository":{"id":64697697,"uuid":"577546488","full_name":"tam11a/react-use-access","owner":"tam11a","description":"Flexible \u0026 extensible modules with development friendly flexibility to maintain the forbidden areas for different types of users in ReactJS.","archived":false,"fork":false,"pushed_at":"2022-12-13T17:06:53.000Z","size":255,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-19T04:03:28.039Z","etag":null,"topics":["access","access-bounary","access-control","acl","reactjs","reactjs-library","typescript-library","use-access"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@tam11a/react-use-access","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/tam11a.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":"2022-12-13T01:19:15.000Z","updated_at":"2023-01-12T08:11:31.000Z","dependencies_parsed_at":"2022-12-13T18:52:31.985Z","dependency_job_id":null,"html_url":"https://github.com/tam11a/react-use-access","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"tam11a/react-package-boilerplate","purl":"pkg:github/tam11a/react-use-access","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tam11a%2Freact-use-access","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tam11a%2Freact-use-access/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tam11a%2Freact-use-access/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tam11a%2Freact-use-access/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tam11a","download_url":"https://codeload.github.com/tam11a/react-use-access/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tam11a%2Freact-use-access/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29516946,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T18:37:19.720Z","status":"ssl_error","status_checked_at":"2026-02-16T18:36:46.920Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["access","access-bounary","access-control","acl","reactjs","reactjs-library","typescript-library","use-access"],"created_at":"2024-09-24T13:14:16.694Z","updated_at":"2026-02-16T20:03:34.712Z","avatar_url":"https://github.com/tam11a.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-use-access\n\nReact Access Area Library\n\n[![Downloads](https://img.shields.io/npm/dm/@tam11a/react-use-access.svg)](https://www.npmjs.com/package/@tam11a/react-use-access) [![NPM](https://img.shields.io/npm/v/@tam11a/react-use-access.svg)](https://www.npmjs.com/package/@tam11a/react-use-access) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\nFlexible \u0026 extensible modules with development friendly flexibility to maintain the forbidden areas for different types of users in ReactJS.\n\n## Table of contents\n\n- [Getting started](#getting-started)\n- [API](#api)\n\n## Getting started\n\n### Installation\n\n```bash\nnpm install --save @tam11a/react-use-access\n```\n\n### Quick Start\n\nFirst, you need to wrap the application or private layouts with `\u003cAccessProvider\u003e` then you are ready to use `\u003cAccessMargin\u003e` and other modules.\n\n```jsx\nconst App = () =\u003e {\n  const permissions = [\"PRODUCT_VIEW\", \"PRODUCT_EDIT\", \"PRODUCT_DELETE\"];\n\n  return (\n    \u003cAccessProvider permissions={permissions}\u003e\n      \u003cYourApplicationRoutes /\u003e\n    \u003c/AccessProvider\u003e\n  );\n};\n```\n\nProtect UI Component\n\n```jsx\nconst Product = () =\u003e {\n  return (\n    \u003cAccessMargin to=\"PRODUCT_DELETE\"\u003e\n      \u003cbutton\u003eProduct Delete\u003c/button\u003e\n    \u003c/AccessMargin\u003e\n  );\n};\n```\n\nProtect UI Component with multiple permissions\n\n```jsx\nconst Product = ({ product }) =\u003e {\n  return (\n    \u003c\u003e\n      \u003cAccessMargin to={[\"PRODUCT_EDIT\", \"PRODUCT_VIEW\"]}\u003e\n        \u003cp\u003eProduct Name: {product.name}\u003c/p\u003e\n        \u003cAccessMargin to=\"PRODUCT_EDIT\"\u003e\n          \u003cbutton\u003eProduct Delete\u003c/button\u003e\n        \u003c/AccessMargin\u003e\n        \u003cAccessMargin to=\"PRODUCT_DELETE\"\u003e\n          \u003cbutton\u003eProduct Delete\u003c/button\u003e\n        \u003c/AccessMargin\u003e\n      \u003c/AccessMargin\u003e\n    \u003c/\u003e\n  );\n};\n```\n\nConditional render with useAccessContext from Context API\n\n```jsx\nconst { checkAccess } = useAccessContext();\n\nconsole.log(checkAccess(\"PRODUCT_EDIT\"));\n\nreturn \u003c\u003e{checkAccess(\"PRODUCT_EDIT\") \u0026\u0026 \u003cbutton\u003e\"Edit Product\"\u003c/button\u003e}\u003c/\u003e;\n```\n\n## API\n\n- [checkAccess](#checkAccess)\n- [useAccessContext](#useAccessContext)\n- [AccessMargin](#AccessMargin)\n- [AccessProvider](#AccessProvider)\n- [DefaultFallback](#DefaultFallback)\n\n## checkAccess\n\nFunction to check if passed string or list of strings have permission.\n\n### Arguments:\n\n`permission` - `string | string[]`\n\nPermission or Permission List to check for restriction\n\n### Returns: `boolean`\n\n#\n\n## useAccessContext\n\n### Returns:\n\n`permissions` - `string | string[]`\n\nCurrent Permission List\n\n`checkAccess` - The [checkAccess](#checkaccess) Function\n\n`addPermissions` - `function` to add new permissions with existing permissions\n\n```jsx\nconst { addPermissions } = useAccessContext();\n\naddPermissions(\"PRODUCT_UPDATE\");\n// or\naddPermissions([\"PRODUCT_UPDATE\", \"VIEW_PRODUCT_STATES\"]);\n```\n\n`resetPermissions` - `function` to reset permissions with passed permissions or to default permissions the provider initialized with.\n\n```jsx\nconst { resetPermissions } = useAccessContext();\n\nresetPermissions(); // to reset default\n// or\nresetPermissions([\"PRODUCT_UPDATE\", \"VIEW_PRODUCT_STATES\"]); // to set only these permissions\n```\n\n`removePermissions` - `function` to add remove permission/permissions from existing permissions\n\n```jsx\nconst { removePermissions } = useAccessContext();\n\nremovePermissions(\"PRODUCT_UPDATE\");\n// or\nremovePermissions([\"PRODUCT_UPDATE\", \"VIEW_PRODUCT_STATES\"]);\n```\n\n`defaultFallback` - `React.ReactNode`\n\nThe fallback component.\n\n#\n\n## AccessMargin\n\nWrapper to restrict areas or components.\n\n### Props:\n\n`to` - `string | string[]`\n\nPermission or Permission List for the Margin to check the wrapped areas restriction\n\n`defaultFallback` - `boolean`\n\nTo call the default fallback if the area is restricted\n\n`fallback` - `React.ReactNode`\n\nTo add customised fallback if the area is restricted\n\n#\n\n## AccessProvider\n\nContext Provider for the Context the entire module is using. you need to wrap the application or private layouts with `\u003cAccessProvider\u003e` to use other modules.\n\n### Props:\n\n`permissions` - `string | string[]`\n\nDefault Permission or Permission List\n\n`fallback` - `React.ReactNode`\n\nTo set customised fallback for the default fallback view when the defaultFallback is called in `\u003cAccessMargin\u003e`, `\u003cDefaultFallback /\u003e` and on other necessities.\n\n#\n\n## DefaultFallback\n\nThe default fallback component.\n\n#\n\n### License\n\nN/A © [tam11a](https://github.com/tam11a)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftam11a%2Freact-use-access","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftam11a%2Freact-use-access","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftam11a%2Freact-use-access/lists"}