# @idocs-kz/widgets

> - **[English](#English)** - **[Русский](#Русский)**

Latest version **1.1.1** (published 2023-07-26) · 0 weekly downloads

## Install

```sh
npm install @idocs-kz/widgets
pnpm add @idocs-kz/widgets
yarn add @idocs-kz/widgets
bun add @idocs-kz/widgets
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2023-07-26 |
| First published | 2022-07-08 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | idocs-fe-techlead |
| Keywords | idocs, widgets, signing |

## Links

- npm: https://www.npmjs.com/package/@idocs-kz/widgets
- npm.io page: https://npm.io/package/@idocs-kz/widgets

## Dependencies (3)

- [rxjs](https://npm.io/package/rxjs.md) ~7.5.5
- [uuid](https://npm.io/package/uuid.md) ~8.3.2
- [@dev-stream/utils](https://npm.io/package/@dev-stream/utils.md) ~4.2.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2023-07-26
- 1.1.0 — 2023-02-23
- 1.0.0 — 2022-11-03
- 0.0.2-rc.3 — 2022-09-04
- 0.0.2-rc.2 — 2022-08-26
- 0.0.2-rc.1 — 2022-08-19
- 0.0.1-rc.3 — 2022-08-15
- 0.0.1 — 2022-08-15
- 0.0.1-rc.2 — 2022-07-19
- 0.0.1-rc.1 — 2022-07-08

## README

# IDocs Widgets

## Language (Язык)

- **[English](#English)**
- **[Русский](#Русский)**

## English

Library connector for iDocs widgets. Works as intermediary between website and various widgets of iDocs (right now only one way document signing) 

## Installation

Use the package manager ***[npm](https://pip.pypa.io/en/stable/)*** to install iDocs-widget. 

```bash
npm install --save @idocs-kz/widgets@latest
```
After installation add ***bundle.js*** (path to bundle ***"node_modules/@idocs-kz/widgets/dist/bundle.js"***) from package to your scripts. 

## Methods

### signWidget

signWidget(ISignWidgetConfig)  - creates sign widget instance with config, and returns it. 

#### ISignWidgetConfig

|    Parameter    |              Description               |
|:---------------:|:--------------------------------------:|
|     apiKey      |       token received from iDocs        |
|    filename     |     name of the resulting archive      |
| widgetServerUrl |           url of the widget            |
|   onComplete    |   callback on success, returns File    |
| closeOnComplete |   to close widget on complete or not   |
| onLicenceError  |       callback on Licence Error.       |
|    onCancel     | callback on canceling / closing widget |

### open

open(files: File[]) - opens widget with files. Input value is ***Array*** of type ***File***  

## Usage

### Angular

#### Component ts file

```ts
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.scss']
})
export class AppComponent {

    onChange(event: any) {
        const files: File[] = event.target.files;
        
        // getting widgets from window
        const widgets = (window as any).widgets;
        
        // creation of sign widget instance with config
        const widget = new widgets.signWidget({
            apiKey: 'Your Token', // token received from iDocs
            filename: 'result', // name of the resulting archive
            widgetServerUrl: 'https://widget.idocs.kz', // url of the widget
            onComplete: (zipFile: File) => { // callback on completion of signing document
                console.log('completed')
            },

            closeOnComplete: true, // to close widget on complete or not
            onLicenceError: (error: any) => { // callback on Licence Error 
                console.log(error);
            },

            onCancel: () => // callback on canceling / closing widget
                console.log('canceled')
        });
        
        // opening of sign widget iframe
        // File must have type
        // method open(files) takes Array<File[]>
        widget.open(files);
    }

}
```

### Javascript

#### HTML file

```html

<body>
    <input type="file" multiple id="files" />

    <script src="node_modules/@idocs-kz/widgets/dist/bundle.js"></script>

    <script>
      const files = document.getElementById("files");
      
      files.onchange = function (evt) {
        openSignWidget(evt);
      };

      function openSignWidget(event) {
        const files = event.target.files;
        
        // creation of sign widget instance with config
        const signWidget = new window.widgets.signWidget({
          apiKey: "Your Token", // token received from iDocs
          filename: 'result', // name of the resulting archive 
          closeOnComplete: true, // to close widget on complete or not 
          widgetServerUrl: "https://widget.idocs.kz", // url of the widget 

          onComplete: (zipFile) => { // callback on completion of signing document 
            console.log('completed');
          },
            
          onLicenceError: (error) => console.error(error), // callback on Licence Error 
            
          onCancel: () => console.info("canceled"), // callback on canceling / closing widget 
        });
        
        // opening of sign widget iframe 
        signWidget.open(Array.from(files));
      }
    </script>
  </body>

```

#### Component html file

```html
<input type="file" multiple (change)="onChange($event)">
```

## Русский

Соединитель библиотеки для виджетов iDocs. Работает в качестве посредника между веб-сайтом и различными виджетами IDocs (прямо сейчас только односторонняя подпись документов)

## Установка

Используйте диспетчер пакетов ***[npm](https://pip.pypa.io/en/stable/)*** для установки  iDocs-widget.

```bash
npm install --save @idocs-kz/widgets@latest
```
После установки добавьте ***bundle.js*** (путь к пакету ***"node_modules/@idocs-kz/widgets/dist/bundle.js"***) из пакета в ваши скрипты.

## Методы

### signWidget

signWidget(ISignWidgetConfig)  - создает экземпляр виджета подписания с конфигурацией, и возвращает его.

#### ISignWidgetConfig

|    Parameter    |                                 Description                                  |
|:---------------:|:----------------------------------------------------------------------------:|
|     apiKey      |                          токен, полученный от IDocs                          |
|    filename     |                          имя результирующего архива                          |
| widgetServerUrl |                              url-адрес виджета                               |
|   onComplete    | функция обратного вызова по завершении подписания документа, возвращает File |
| closeOnComplete |                  чтобы закрыть виджет по завершении или нет                  |
| onLicenceError  |                 функция обратного вызова при ошибке лицензии                 |
|    onCancel     |            функция обратного вызова при отмене / закрытии виджета            |

### open

open(files: File[]) - открытие виджета подписания c файлами. Входной параметр должен быть ***Массив*** типа ***File***

## Использование

### Angular

#### Typescript файл компонента

```ts
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.scss']
})
export class AppComponent {

    onChange(event: any) {
        const files: File[] = event.target.files;
        
        // получение виджетов из window
        const widgets = (window as any).widgets;
        
        // создание экземпляра виджета подписания с конфигурацией 
        const widget = new widgets.signWidget({
            apiKey: 'Your Token', // токен, полученный от IDocs 
            filename: 'result', // имя результирующего архива 
            widgetServerUrl: 'https://widget.idocs.kz', // url-адрес виджета 
            closeOnComplete: true, // чтобы закрыть виджет по завершении или нет 
            
            onComplete: (zipFile: File) => { // функция обратного вызова по завершении подписания документа 
                console.log('completed')
            },

            onLicenceError: (error: any) => { // функция обратного вызова при ошибке лицензии 
                console.log(error);
            },

            onCancel: () => // функция обратного вызова при отмене / закрытии виджета 
                console.log('canceled')
        });
        
        // открытие iframe виджета подписания 
        widget.open(files);
    }

}
```

#### HTML файл компонента

```html

<input type="file" multiple (change)="onChange($event)">

```

### Javascript

#### HTML файл

```html

<body>
    <input type="file" multiple id="files" />

    <script src="node_modules/@idocs-kz/widgets/dist/bundle.js"></script>

    <script>
      const files = document.getElementById("files");
      
      files.onchange = function (evt) {
        openSignWidget(evt);
      };

      function openSignWidget(event) {
        const files = event.target.files;
        
        // создание экземпляра виджета подписания с конфигурацией 
        const signWidget = new window.widgets.signWidget({
            apiKey: 'Your Token', // токен, полученный от IDocs 
            filename: 'result', // имя результирующего архива 
            widgetServerUrl: 'https://widget.idocs.kz', // url-адрес виджета 
            closeOnComplete: true, // чтобы закрыть виджет по завершении или нет 

            onComplete: (zipFile) => { // функция обратного вызова по завершении подписания документа 
                console.log('completed')
            },

            onLicenceError: (error) => { // функция обратного вызова при ошибке лицензии 
                console.log(error);
            },

            onCancel: () => // функция обратного вызова при отмене / закрытии виджета 
                    console.log('canceled')
        });
        
        // открытие iframe виджета подписания
        signWidget.open(Array.from(files));
      }
    </script>
  </body>

```

---
_Source: https://npm.io/package/@idocs-kz/widgets · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._