Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dansmaculotte/vue-segment
Vue.js plugin for Segment Analytics.js
https://github.com/dansmaculotte/vue-segment
segment vue vue-plugin
Last synced: about 1 month ago
JSON representation
Vue.js plugin for Segment Analytics.js
- Host: GitHub
- URL: https://github.com/dansmaculotte/vue-segment
- Owner: dansmaculotte
- License: mit
- Created: 2019-05-03T21:12:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T20:42:22.000Z (about 2 months ago)
- Last Synced: 2024-11-18T21:49:25.581Z (about 2 months ago)
- Topics: segment, vue, vue-plugin
- Language: JavaScript
- Size: 2.23 MB
- Stars: 5
- Watchers: 3
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# NOT MAINTAINED ANYMORE!
We don't use segment anymore for our website, I don't have an account on Segment to make this plugin evolve.
Please fill in an issue if you want to be a maintainer or if you want redirect people to you fork.
# vue-segment
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Dependencies][david-dm-src]][david-dm-href]
[![Standard JS][standard-js-src]][standard-js-href]
> Vue.js plugin for Segment Analytics.js
[Segment Analytics.js Documentation](https://segment.com/docs/sources/website/analytics.js/)
## Setup
1. Add the `@dansmaculotte/vue-segment` dependency with `yarn` or `npm` to your project
2. Configure it:
```js
import Vue from 'vue'
import Segment from '@dansmaculotte/vue-segment'
Vue.use(Segment, {
writeKey: 'YOUR_SEGMENT_WRITE_KEY',
disabled: true,
router,
pageCategory: 'shop',
settings: {
...
}
})
```
## Usage
See [Segment Vue Quickstart Guide](https://github.com/segmentio/analytics-vue#how-to-get-started).
## Options
### writeKey
- Type: `String`
- Default: `''`
### disabled
Disable automatic script loading, if you need compliance with GDPR.
- Type: `Boolean`
- Default: `false`
### router
Call `analytics.page` method on `afterEach` router method if provided.
- Type: `Object`
### pageCategory
In case you provided router, you can specify the category page of the `page` event. See segment [page](https://segment.com/docs/sources/website/analytics.js/#page) method reference.
- Type: `String`,
- Default: `''`
### settings
See [Load options](https://segment.com/docs/sources/website/analytics.js/#load-options) reference.
- Type: `Object`
## Development
1. Clone this repository
2. Install dependencies using `yarn install` or `npm install`
3. Start development server using `npm run dev`
## License
[MIT License](./LICENSE.md)
[npm-downloads-src]: https://img.shields.io/npm/dt/@dansmaculotte/vue-segment.svg?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/@dansmaculotte/vue-segment
[npm-version-src]: https://img.shields.io/npm/v/@dansmaculotte/vue-segment/latest.svg?style=flat-square
[npm-version-href]: https://npmjs.com/package/@dansmaculotte/vue-segment
[david-dm-src]: https://david-dm.org/dansmaculotte/vue-segment/status.svg?style=flat-square
[david-dm-href]: https://david-dm.org/dansmaculotte/vue-segment
[standard-js-src]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square
[standard-js-href]: https://standardjs.com