{"id":19529896,"url":"https://github.com/loopmode/events","last_synced_at":"2025-02-26T02:43:11.029Z","repository":{"id":57127160,"uuid":"149707267","full_name":"loopmode/events","owner":"loopmode","description":"Unified global event handling","archived":false,"fork":false,"pushed_at":"2018-11-09T07:48:48.000Z","size":214,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-09T02:05:10.734Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/loopmode.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-21T03:54:44.000Z","updated_at":"2018-11-09T07:48:50.000Z","dependencies_parsed_at":"2022-08-24T14:59:38.400Z","dependency_job_id":null,"html_url":"https://github.com/loopmode/events","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loopmode%2Fevents","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loopmode%2Fevents/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loopmode%2Fevents/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loopmode%2Fevents/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loopmode","download_url":"https://codeload.github.com/loopmode/events/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240783109,"owners_count":19856776,"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":[],"created_at":"2024-11-11T01:28:03.713Z","updated_at":"2025-02-26T02:43:10.997Z","avatar_url":"https://github.com/loopmode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @loopmode/events\n\nUnified global event handling.\n\nRegisters no more than a single listener per event type, invokes all registered callbacks.\nThe event listener is created when needed and removed again when obsolete.\n\n-   Safe support for passive events via [detect-passive-events](https://github.com/rafrex/detect-passive-events)\n-   Currently, only `window`, `document` and `body` are supported as event targets (Default is `window`)\n\n\u003cbr /\u003e\nSupports the same signature as [addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener),\nso it should be safe to search and replace in your code as follows:\n\n-   `window.addEventListener` -\u003e `Events.on`\n-   `document.addEventListener('mousedown', this.handleMouseDown)` -\u003e `Events.on.document('mousedown', this.handleMouseDown)`\n-   `document.addEventListener('mousedown', this.handleMouseDown)` -\u003e `Events.on('mousedown', this.handleMouseDown, {target: document})`\n-   `window.removeEventListener` -\u003e `Events.off`\n-   ...\n\n## Documentation\n\nSee [https://loopmode.github.io/events/](https://loopmode.github.io/events/)\n\n## Motivation\n\nKeep the number of global event listeners low, especially when using in react components that are rendered dozens or hundrets of time on the screen.\nSupport passive events, stay as light-weight as possible.\n\n## Installation\n\n```\nyarn add @loopmode/events\n```\n\n## Usage\n\nThe default export is a singleton instance of the class. Typically, that's what you want.\n\nBasic usage:\n\n```\nimport Events from '@loopmode/events';\n\nfunction onResize(event) {\n    console.log('resize', event)\n}\n\nEvents.on('resize', onResize);\nEvents.off('resize', onResize);\n\n\n// remember to pass the same options when removing listeners:\nEvents.on('resize', onResize, {capture: true});\nEvents.off('resize', onResize, {capture: true})\n\n\n// alternatively, use returned object with dispose function:\nconst listener = Events.on('mousemove', onResize, {capture: true, target: document.body, passive: true})\n// no need to provide any arguments\nlistener.dispose();\n```\n\nIn react component, with passive option:\n\n```\nimport React, { PureComponent } from 'react';\nimport Events from '@loopmode/events';\n\nexport class MyComponent extends PureComponent {\n    state = {\n        delta: 0\n    };\n    componentDidMount() {\n        this.wheelListener = Events.on('wheel', this.handleWheel, { passive: true })\n    }\n    componentWillUnmount() {\n        // same as Events.off('wheel', this.handleWheel, { passive: true })\n        this.wheelListener.dispose();\n    }\n    handleWheel = (event) =\u003e {\n        this.setState({\n            delta: event.deltaY\n        })\n    };\n    render() {\n        return (\n            \u003cdiv\u003e{this.state.delta}\u003c/div\u003e\n        );\n    }\n}\n```\n\nIf you need additional instances, use the named `Events` export:\n\n```\nimport { Events } from '@loopmode/events';\n\nconst myEvents = new Events();\n\nfunction onResize(event) {\n    console.log('resize', event)\n}\n\nmyEvents.on('resize', onResize);\n```\n\nEvery instance may register up to one global event listener per event type.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floopmode%2Fevents","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floopmode%2Fevents","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floopmode%2Fevents/lists"}