{"id":21997641,"url":"https://github.com/dansmaculotte/nuxt-segment","last_synced_at":"2025-04-30T21:05:30.224Z","repository":{"id":34573036,"uuid":"184736453","full_name":"dansmaculotte/nuxt-segment","owner":"dansmaculotte","description":"Nuxt.js module for Segment Analytics.js","archived":false,"fork":false,"pushed_at":"2023-01-27T10:22:41.000Z","size":3337,"stargazers_count":20,"open_issues_count":9,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-30T21:05:20.176Z","etag":null,"topics":["nuxt","nuxt-module","segment"],"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/dansmaculotte.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-03T10:19:16.000Z","updated_at":"2023-11-29T07:02:45.000Z","dependencies_parsed_at":"2023-02-15T08:01:41.881Z","dependency_job_id":null,"html_url":"https://github.com/dansmaculotte/nuxt-segment","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dansmaculotte%2Fnuxt-segment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dansmaculotte%2Fnuxt-segment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dansmaculotte%2Fnuxt-segment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dansmaculotte%2Fnuxt-segment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dansmaculotte","download_url":"https://codeload.github.com/dansmaculotte/nuxt-segment/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251782760,"owners_count":21642986,"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":["nuxt","nuxt-module","segment"],"created_at":"2024-11-29T22:17:33.007Z","updated_at":"2025-04-30T21:05:30.181Z","avatar_url":"https://github.com/dansmaculotte.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nuxt-segment\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![Dependencies][david-dm-src]][david-dm-href]\n[![Standard JS][standard-js-src]][standard-js-href]\n\n\u003e Nuxt.js module for Segment Analytics\n\nThis module uses [vue-segment](https://github.com/dansmaculotte/vue-segment) to add Segment Analytics to a Nuxt.js app.\n\n[📖 **Release Notes**](./CHANGELOG.md)\n\n## Setup\n\n- Add `@dansmaculotte/nuxt-segment` dependency using yarn or npm to your project\n- Add `@dansmaculotte/nuxt-segment` to `modules` section of `nuxt.config.js`\n3. Configure it:\n\n```js\n{\n  modules: [\n    // Simple usage\n    '@dansmaculotte/nuxt-segment',\n\n    // With options\n    [\n      '@dansmaculotte/nuxt-segment',\n      { /* module options */ }\n    ],\n  ],\n\n  // Or with global options\n  segment: {\n    writeKey: '',\n    disabled: false,\n    useRouter: true\n  }\n\n  // Or with publicRuntimeConfig\n\n  publicRuntimeConfig: {\n    SEGMENT_WRITE_KEY: process.env.SEGMENT_WRITE_KEY_FROM_SERVER || '',\n    SEGMENT_DISABLED: process.env.SEGMENT_DISBLED_FROM_SERVER || false,\n    SEGMENT_USE_ROUTER: process.env.SEGMENT_USE_ROUTER_FROM_SERVER || true,\n  }\n}\n```\n\n## Options\n\n### writeKey\n\n- Type: `String`\n  - Default: `process.env.SEGMENT_WRITE_KEY || publicRuntimeConfig.SEGMENT_WRITE_KEY`\n\n### disabled\n\n- Type: `Boolean`\n  - Default: `process.env.SEGMENT_DISABLED || publicRuntimeConfig.SEGMENT_DISABLED || false`\n\n### useRouter\n\n- Type: `Boolean`\n  - Default: `process.env.SEGMENT_USE_ROUTER || publicRuntimeConfig.SEGMENT_USE_ROUTER || true`\n\n## Usage\n\nInside a Vue component, the Segment `analytics` object is available as `this.$segment`:\n\n```js\nexport default {\n  mounted () {\n    this.$segment.identify('f4ca124298', {\n      name: 'Michael Bolton',\n      email: 'mbolton@initech.com'\n    });\n    this.$segment.track('Signed Up', { plan: 'Enterprise' });\n    this.$segment.page('Pricing');\n  }\n}\n```\n\n`$segment` is also injected into the [Nuxt context](https://nuxtjs.org/api/context/) so you can access it within your Vuex stores:\n\n```js\nexport default {\n  LOGOUT({ dispatch }) {\n    return this.$auth.logout()\n      .then(() =\u003e {\n        this.$segment.reset();\n        return dispatch('AFTER_LOGOUT');\n      })\n  }\n}\n```\n\n\n## Development\n\n- Clone this repository\n- Install dependencies using `yarn install`\n- Start development server using `npm run dev`\n\n## License\n\n[MIT License](./LICENSE.md)\n\n\u003c!-- Badges --\u003e\n[npm-downloads-src]: https://img.shields.io/npm/dt/@dansmaculotte/nuxt-segment.svg?style=flat-square\n[npm-downloads-href]: https://npmjs.com/package/@dansmaculotte/nuxt-segment\n\n[npm-version-src]: https://img.shields.io/npm/v/@dansmaculotte/nuxt-segment/latest.svg?style=flat-square\n[npm-version-href]: https://npmjs.com/package/@dansmaculotte/nuxt-segment\n\n[david-dm-src]: https://david-dm.org/dansmaculotte/nuxt-segment/status.svg?style=flat-square\n[david-dm-href]: https://david-dm.org/dansmaculotte/nuxt-segment\n\n[standard-js-src]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square\n[standard-js-href]: https://standardjs.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdansmaculotte%2Fnuxt-segment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdansmaculotte%2Fnuxt-segment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdansmaculotte%2Fnuxt-segment/lists"}