https://github.com/fabriquartz/ember-marker-io

No-hassle inclusion of the Marker.io SDK in Ember
https://github.com/fabriquartz/ember-marker-io

ember ember-addon marker

Last synced: about 1 month ago
JSON representation

No-hassle inclusion of the Marker.io SDK in Ember

• Host: GitHub
• URL: https://github.com/fabriquartz/ember-marker-io
• Owner: Fabriquartz
• License: mit
• Created: 2022-01-24T08:36:48.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-07T03:57:47.000Z (almost 2 years ago)
• Last Synced: 2024-12-19T03:14:45.601Z (about 1 month ago)
• Topics: ember, ember-addon, marker
• Language: JavaScript
• Homepage:
• Size: 1.47 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
ember-marker-io

==============================================================================

Adds a [marker.io](marker.io) service to your ember application to create and configure its feedback button and interact with the marker.io sdk from  anywhere in your application.

For more information about the marker.io sdk, see: https://github.com/marker-io/browser-sdk

Compatibility

------------------------------------------------------------------------------

* Ember.js v3.20 or above

* Ember CLI v3.20 or above

* Node.js v12 or above

Installation

------------------------------------------------------------------------------

```

ember install ember-marker-io

```

Usage

------------------------------------------------------------------------------

To use marker.io, you will first need to load the widget with a destination ID. You can do this on app boot by adding a call to `loadWidget` to the `beforeModel` hook of your application route.

```js

import Route from '@ember/routing/route';

import { inject as service } from '@ember/service';

export default class ApplicationRoute extends Route {

    ...

    @service marker;

    async beforeModel() {

        await this.marker.loadWidget();

    }

    ...

}

```

The marker service can then be used to further configure and use the marker.io sdk through the following methods:

```show()```

```hide()```

```isVisible()```

```capture()```

```cancelCapture()```

```isExtensionInstalled()```

```setReporter()```

```unloadWidget()```

```setCustomData```

These mirror the methods of the [marker.io sdk](https://github.com/marker-io/browser-sdk) API

Contributing

------------------------------------------------------------------------------

See the [Contributing](CONTRIBUTING.md) guide for details.

License

------------------------------------------------------------------------------

This project is licensed under the [MIT License](LICENSE.md).