https://github.com/expressapp/express-widget
https://github.com/expressapp/express-widget
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/expressapp/express-widget
- Owner: ExpressApp
- Created: 2020-05-26T13:54:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T11:13:34.000Z (almost 2 years ago)
- Last Synced: 2025-07-31T03:58:52.224Z (6 months ago)
- Language: JavaScript
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Виджет для подключения eXpress messenger на сайт
## Установка
Для подключения виджета, скачайте библиотеку в ваш проект и вставьте на странице тег script c ссылкой на файл express.js и link на style.css
```html
```
или установите с помощью npm
```
npm i @expressms/express-widget
import { ExpressWidget } from '@expressms/express-widget'
import '@expressms/express-widget/style.css'
```
## Использование
Разместите на странице следующий код:
```html
<script type="text/javascript">
new ExpressWidget({
elementId: 'express-button',
url: 'https://corp.express',
})
```
## Параметры
* `url` - **обязательно** ссылка на eXpress messenger
* `elementId` - **опционально** id элемента на странице в который отрисуется кнопка вызова eXpress messenger, если не указать будет отрисовано перед закрывающим тегом `body`
* `containerId` - **опционально** id элемента на странице в который отрисуется iframe eXpress messenger (использовать для модальных окон), если не указать будет отрисовано перед закрывающим тегом `body`
* `chatId` - **опционально** id чата, будет открыт после разворачивания приложения
* `buttonStatus` - **опционально** boolean, изменение фона кнопки открытия виджета, в зависимости от входа в приложение
## Методы
* `handleOpen` - открывает окно приложения
* `handleClose` - закрывает окно приложения
* `handleToggle` - открывает или закрывает окно в зависимости от текущего значения
* `handleOpenApp` - открывает приложение если оно установлено, если приложения нет - окно приложения, можно указать ид чата, логин пользователя или huid
* `handleOpenChat` - открывает только окно приложения, можно указать ид чата, логин пользователя, huid и isCall - для совершения звонка
* `handleCallUser` - открывает окно приложения и совершает вызов, можно указать логин пользователя и huid
Пример:
```html
Open
Close
Toggle
Open app desktop
Open app chat id desktop
Open chat user name (testLogin) desktop
Open chat user huid and call desktop
Open chat user name (testLogin) desktop
Open chat id desktop
Open chat id
Open chat user name (testLogin)
Open chat user huid
Open chat user name (testLogin)
Open chat id
Open chat user huid and call
Open chat user name (testLogin) and call
const expressButton = new ExpressWidget({
url: 'https://corp.express',
})
```