{"id":13880737,"url":"https://github.com/react-hook-form/devtools-extension","last_synced_at":"2025-05-01T10:31:24.166Z","repository":{"id":43889240,"uuid":"502324536","full_name":"react-hook-form/devtools-extension","owner":"react-hook-form","description":"📋 Chrome extension devtools to help debug forms.","archived":false,"fork":false,"pushed_at":"2024-11-19T22:58:24.000Z","size":153,"stargazers_count":27,"open_issues_count":5,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-21T01:29:59.225Z","etag":null,"topics":["chrome-extension","devtools","react","react-hook-form"],"latest_commit_sha":null,"homepage":"https://chrome.google.com/webstore/detail/react-hook-form-developer/cangfmbpembbepmmechnanpmddndpaji","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/react-hook-form.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-06-11T11:05:11.000Z","updated_at":"2024-11-28T15:40:12.000Z","dependencies_parsed_at":"2023-01-31T22:01:18.503Z","dependency_job_id":null,"html_url":"https://github.com/react-hook-form/devtools-extension","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/react-hook-form%2Fdevtools-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/react-hook-form%2Fdevtools-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/react-hook-form%2Fdevtools-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/react-hook-form%2Fdevtools-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/react-hook-form","download_url":"https://codeload.github.com/react-hook-form/devtools-extension/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250806500,"owners_count":21490323,"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":["chrome-extension","devtools","react","react-hook-form"],"created_at":"2024-08-06T08:03:26.360Z","updated_at":"2025-05-01T10:31:24.160Z","avatar_url":"https://github.com/react-hook-form.png","language":"TypeScript","readme":"[![Logo](https://raw.githubusercontent.com/react-hook-form/react-hook-form/master/docs/logo.png)![Screenshot](https://user-images.githubusercontent.com/10513364/178235861-ff786497-1b0c-4095-afc5-21c49adae560.png)](https://react-hook-form.com)\n\n## Requirement\n\n- [react-hook-form](https://github.com/react-hook-form/react-hook-form) \u003e= `7.33.1`\n- [@hookform/devtools](https://github.com/react-hook-form/devtools) \u003e= `4.2.2`\n\n## Usage\n\n1. Install extension in [Chrome Web Store](https://chrome.google.com/webstore/detail/react-hook-form-developer/cangfmbpembbepmmechnanpmddndpaji)  \n   _Or [build it yourself](#production) / download the [release](https://github.com/react-hook-form/devtools-extension/releases) file (then goto [Development Run **third step**](#run))_\n2. Install [devtools](https://github.com/react-hook-form/devtools) in your project\n\n```bash\nnpm install @hookform/devtools -D\n```\n\n3. Add [DevTool component](https://github.com/react-hook-form/devtools#quickstart) in your code  \n   _This won't show devtool component anymore! Just for extension detect your form_\n4. (Optional) Add custom form id: `\u003cDevTool id=\"YourFormId\" control={control} /\u003e`  \n   _If you don't add it manually, it will be auto generated by uuid_\n5. Enjoy!\n\n## Development\n\n### Install\n\n\u003e [!NOTE]  \n\u003e Use [pnpm](https://pnpm.io/) only\n\n```bash\npnpm install\n```\n\n### Run\n\n1. Run [example webpage](https://github.com/react-hook-form/devtools/tree/master/example)\n\n2. Run extension in development mode\n\n```bash\npnpm run dev\n```\n\n3. Open Chrome and navigate to `chrome://extensions`\n\n4. Enable **Developer mode**\n\n5. Click **Load unpacked** button and select `/dist`\n\n### Messaging Flow\n\n```mermaid\nsequenceDiagram\n  participant Webpage\n  participant Content Script\n  participant Background\n  participant Devtools\n  participant Popup\n  Background-\u003e\u003eBackground: Cleanup Cache\n  Content Script-\u003e\u003eWebpage: INIT\n  Note left of Webpage: Browser has devtools extension\n  Webpage-\u003e\u003eContent Script: WELCOME\n  Content Script-\u003e\u003eBackground: WELCOME\n  Note right of Background: Webpage has rhf\n  Background-\u003e\u003eBackground: Cache enabled tab\n  par\n    Popup-\u003e\u003eBackground: get-enable-status\n    Background--\u003e\u003ePopup: Enable Status (Callback)\n  and\n    Devtools-\u003e\u003eBackground: get-enable-status\n    Background--\u003e\u003eDevtools: Enable Status (Callback)\n  end\n  loop\n    Webpage-\u003e\u003eContent Script: UPDATE\n    Content Script-\u003e\u003eBackground: UPDATE\n    Note over Webpage,Background: Data\n  end\n  Background-\u003e\u003eBackground: Cache data\n  loop Every 100ms\n    Devtools-\u003e\u003eBackground: get-devtool-data\n    Background--\u003e\u003eDevtools: Data (Callback)\n  end\n  Background-\u003e\u003eBackground: Cleanup Cache\n```\n\n## Production\n\n1. (Optional) Update package and manifest version\n\n```bash\npnpm run update-version -- \u003cversion\u003e\n```\n\n2. Build\n\n```\npnpm run build\n```\n\n3. Production files can be found in `/dist`\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freact-hook-form%2Fdevtools-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freact-hook-form%2Fdevtools-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freact-hook-form%2Fdevtools-extension/lists"}