@pearl.com/pearl-widget-angular
v1.0.0
Published
Angular component wrapper for the Pearl Widget iframe
Readme
@pearl.com/pearl-widget-angular
An Angular component that embeds the Pearl Widget iframe into your application. It allows initialization of the widget with an access key and mode, enabling interactive chat or expert systems powered by Pearl.
✨ Features
- Embeds a secure iframe widget from Pearl
- Configurable via
accessKeyandmode - Automatically initializes via
postMessageon iframe load - Simple Angular integration
By default chat starts in pearl-ai mode. To enable other mods you need to obtain accessKey here.
📦 Installation
Install the widget package via npm:
npm install @pearl.com/pearl-widget-angular🚀 Usage
<pearl-widget
[accessKey]="'your-access-key'"
[mode]="'pearl-ai'"
></pearl-widget>🔧 Inputs
| Input | Type | Description |
| ----------- | -------- | --------------------------------------------------------------------------------------------------- |
| accessKey | string | Optional. The key used to authenticate the widget session. |
| mode | string | Optional. Used only with accessKey. One of the available modes: expert, pearl-ai, pearl-ai-verified, pearl-ai-expert. |
🧪 Development
To build the package locally:
ng build pearl-widget📄 License
MIT
