{"id":21033455,"url":"https://github.com/electerious/use-ackee","last_synced_at":"2025-04-10T05:10:06.621Z","repository":{"id":36012699,"uuid":"220793137","full_name":"electerious/use-ackee","owner":"electerious","description":"Use Ackee in React.","archived":false,"fork":false,"pushed_at":"2024-12-08T13:32:33.000Z","size":401,"stargazers_count":24,"open_issues_count":2,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-03T03:11:09.548Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electerious.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","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,"publiccode":null,"codemeta":null},"funding":{"github":"electerious","custom":["https://paypal.me/electerious","https://www.buymeacoffee.com/electerious"]}},"created_at":"2019-11-10T13:20:57.000Z","updated_at":"2025-01-19T05:03:16.000Z","dependencies_parsed_at":"2024-11-19T12:57:27.034Z","dependency_job_id":"b26ea213-cac2-4e19-acab-f56c486420f9","html_url":"https://github.com/electerious/use-ackee","commit_stats":{"total_commits":68,"total_committers":5,"mean_commits":13.6,"dds":"0.16176470588235292","last_synced_commit":"11975f4c3229eaebada36ea721e9481362f90c62"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electerious%2Fuse-ackee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electerious%2Fuse-ackee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electerious%2Fuse-ackee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electerious%2Fuse-ackee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electerious","download_url":"https://codeload.github.com/electerious/use-ackee/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161274,"owners_count":21057555,"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-19T12:57:13.834Z","updated_at":"2025-04-10T05:10:06.595Z","avatar_url":"https://github.com/electerious.png","language":"JavaScript","readme":"# use-ackee\n\n![Build](https://github.com/electerious/use-ackee/workflows/Build/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/electerious/use-ackee/badge.svg?branch=master)](https://coveralls.io/github/electerious/use-ackee?branch=master)\n\nUse [Ackee](https://github.com/electerious/Ackee) in React.\n\n## Install\n\n```\nnpm install use-ackee\n```\n\n*or*\n\n```\nyarn add use-ackee\n```\n\n## Usage\n\nImport and call `use-ackee` in a component responsible for the routing or inside your routes. Make sure that only one `use-ackee` hook is actively rendered to avoid redundant records.\n\n```js\nuseAckee('/current/path', {\n\tserver: 'https://example.com',\n\tdomainId: 'hd11f820-68a1-11e6-8047-79c0c2d9bce0'\n}, {\n\tdetailed: false,\n\tignoreLocalhost: true,\n\tignoreOwnVisits: true\n})\n```\n\nAckee will create a new record every time the `pathname` changes. An undefined or empty `pathname` will be skipped. Use `/` for the root instead.\n\nThis hook is a no-op on the server for safe usage during server-side rendering.\n\n## API\n\n### Parameters\n\n- `pathname` `{?String}` Current path.\n- `environment` `{Object}` An object that contains details about your [Ackee](https://github.com/electerious/Ackee) installation. The `server` property must not end with a slash.\n- `opts` `{?Object}` An object of [Ackee options](https://github.com/electerious/ackee-tracker#options).\n\n## Examples\n\n- [React Router](demos/react-router/README.md)","funding_links":["https://github.com/sponsors/electerious","https://paypal.me/electerious","https://www.buymeacoffee.com/electerious"],"categories":["🌐 Web Development - Frontend"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felecterious%2Fuse-ackee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felecterious%2Fuse-ackee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felecterious%2Fuse-ackee/lists"}