https://github.com/zonkyio/ember-liveagent
https://github.com/zonkyio/ember-liveagent
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/zonkyio/ember-liveagent
- Owner: zonkyio
- License: mit
- Created: 2018-12-04T08:31:49.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-31T01:34:57.000Z (9 months ago)
- Last Synced: 2025-08-18T14:36:38.215Z (about 2 months ago)
- Language: JavaScript
- Size: 24.3 MB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-liveagent
[](https://github.com/zonkyio/ember-liveagent/actions)
[](https://emberobserver.com/addons/ember-liveagent)
[](https://codeclimate.com/github/zonkyio/ember-liveagent/maintainability)
[](https://codeclimate.com/github/zonkyio/ember-liveagent/test_coverage)
[](https://david-dm.org/zonkyio/ember-liveagent)
[](https://david-dm.org/zonkyio/ember-liveagent?type=dev)
Salesforce's [live agent](https://www.salesforce.com/products/service-cloud/features/live-agent/) chat integration for Ember.js applications.
## Compatibility
- Ember.js v4.12 or above
- Embroider or ember-auto-import v2
## Installation
```
ember install ember-liveagent
```
## Usage
1\. You'll need to configure your `liveagent` chat.
```javascript
// config/environment.js
module.exports = function (environment) {
let ENV = {
'ember-liveagent': {
salesforceURL: '[SALESFORCE_URL]',
communityURL: '[COMMUNITY_URL]',
org: '[ORG]',
snapinName: '[SNAPIN_NAME]',
baseLiveAgentContentURL: '[BASE_LIVEAGENT_CONTENT_URL]',
deploymentId: '[DEPLOYMENT_ID]',
buttonId: '[BUTTON_ID]',
baseLiveAgentURL: '[BASE_LIVEAGENT_URL]',
eswLiveAgentDevName: '[ESW_LIVEAGENT_DEV_NAME]',
},
};
return ENV;
};
```
_See the [service](ember-liveagent/src/services/liveagent.ts) for how the parameters are passed into `embedded_svc`'s `init` method._
2\. You can then inject the `liveagent` service provided by this addon to call the `boot` method which accepts optional parameters.
```javascript
// app/routes/application.js
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';
import config from '../config/environment'; // import the configuration
export default class ApplicationRoute extends Route {
@service liveagent;
afterModel() {
const liveagentConfig = config['ember-liveagent'];
this.liveagent.boot({
...liveAgentConfig,
settings: {
displayHelpButton: true, // default value: false
isOfflineSupportEnabled: true, // default value: false
language: 'cs', // default value: 'en'
defaultMinimizedText: 'Ask guru', // default value: 'Chat with an Expert'
loadingText: 'Just wait a second', // default value: 'Loading'
prepopulatedPrechatFields: { Email: 'example@example.com' }, // default value: {}
offlineSupportMinimizedText: 'You can contact us', // default value: 'Contact Us'
},
});
}
}
```
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
## License
This project is licensed under the [MIT License](LICENSE.md).