{"id":13450554,"url":"https://github.com/ilyalesik/react-use-trigger","last_synced_at":"2025-03-16T19:31:26.876Z","repository":{"id":34858749,"uuid":"178592969","full_name":"ilyalesik/react-use-trigger","owner":"ilyalesik","description":"React Hook for trigger effect from any place of code","archived":false,"fork":false,"pushed_at":"2023-03-02T21:32:22.000Z","size":786,"stargazers_count":26,"open_issues_count":23,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-20T14:32:36.404Z","etag":null,"topics":["hook","hooks","react"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/ilyalesik.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-03-30T17:54:31.000Z","updated_at":"2023-12-01T17:02:29.000Z","dependencies_parsed_at":"2024-04-11T21:48:42.892Z","dependency_job_id":"252ba7ff-87c8-4fd8-af57-731eae8838ca","html_url":"https://github.com/ilyalesik/react-use-trigger","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilyalesik%2Freact-use-trigger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilyalesik%2Freact-use-trigger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilyalesik%2Freact-use-trigger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ilyalesik%2Freact-use-trigger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ilyalesik","download_url":"https://codeload.github.com/ilyalesik/react-use-trigger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221667254,"owners_count":16860581,"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":["hook","hooks","react"],"created_at":"2024-07-31T07:00:36.029Z","updated_at":"2024-10-27T11:09:30.570Z","avatar_url":"https://github.com/ilyalesik.png","language":"JavaScript","funding_links":[],"categories":["Packages"],"sub_categories":[],"readme":"# react-use-trigger\n\n[![Build Status](https://travis-ci.org/ilyalesik/react-use-trigger.svg?branch=master)](https://travis-ci.org/ilyalesik/react-use-trigger)\n[![npm version](https://img.shields.io/npm/v/react-use-trigger.svg)](https://www.npmjs.com/package/react-use-trigger)\n\nReact Hook for trigger effect from any place of code. It is an implementation a Pub-Sub strategy on React Hooks. \n\n* **Small** 305 bytes (minified and gzipped).\n* Both **Flow** and **TS** types included.\n\n```javascript\nimport createTrigger from \"react-use-trigger\";\nimport useTriggerEffect from \"react-use-trigger/useTriggerEffect\";\n\nconst fooTrigger = createTrigger();\n\nexport const Subscriber = () =\u003e {  \n    useTriggerEffect(() =\u003e {\n        // make some effect\n    }, fooTrigger);\n  \n    return \u003cdiv /\u003e;\n}\n\nexport const Sender = () =\u003e { \n    return \u003cbutton onClick={() =\u003e {\n        fooTrigger() // call trigger\n    }}\u003eSend\u003c/button\u003e\n}\n```\n\nAlso, `useTrigger` may be used for combine with other inputs:\n```javascript\nexport const Subscriber = (props) =\u003e {  \n    const fooTriggerValue = useTrigger(fooTrigger);\n    const [someState, setSomeState] = useState();\n    \n    useEffect(() =\u003e {\n        // make some effect\n    }, [fooTriggerValue, props.someProp, someState]);\n  \n    return \u003cdiv /\u003e;\n}\n```\n\n\u003ca href=\"https://lessmess.agency/?utm_source=react-use-trigger\"\u003e\n  \u003cimg src=\"https://lessmess.agency/badges/sponsored_by_lessmess.svg\"\n       alt=\"Sponsored by Lessmess\" width=\"236\" height=\"54\"\u003e\n\u003c/a\u003e\n\n## Installation\n\nInstall it with yarn:\n\n```\nyarn add react-use-trigger\n```\n\nOr with npm:\n\n```\nnpm i react-use-trigger --save\n``` \n\n## API\n\n#### `createTrigger(): TriggerWrapper;`\nCreate a trigger.\n`TriggerWrapper` is function, that update value of trigger. \n\n\n#### `useTrigger(triggerWrapper: TriggerWrapper): string;`\n\nReturns current value of trigger. A string, generated by [nanoid](https://github.com/ai/nanoid).\n\nCan be used for combine trigger with other inputs:\n```javascript\nimport useTrigger from \"react-use-trigger/useTrigger\";\n\nexport const Subscriber = (props) =\u003e {  \n    const fooTriggerValue = useTrigger(fooTrigger);\n    const [someState, setSomeState] = useState();\n    \n    useEffect(() =\u003e {\n        // make some effect\n    }, [fooTriggerValue, props.someProp, someState]);\n  \n    return \u003cdiv /\u003e;\n}\n```\n\n#### `useTriggerEffect(create: () =\u003e MaybeCleanUpFn, triggerWrapper: TriggerWrapper): void;`\n\nCall effect (from `create`) for every change of trigger.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filyalesik%2Freact-use-trigger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Filyalesik%2Freact-use-trigger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filyalesik%2Freact-use-trigger/lists"}