https://github.com/virustotal/vt-augment
The VT Augment widget is an official, compliant and recommended way of integrating VirusTotal data in third-party applications.
https://github.com/virustotal/vt-augment
Last synced: 9 months ago
JSON representation
The VT Augment widget is an official, compliant and recommended way of integrating VirusTotal data in third-party applications.
- Host: GitHub
- URL: https://github.com/virustotal/vt-augment
- Owner: VirusTotal
- License: other
- Created: 2020-05-27T13:36:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-28T08:54:28.000Z (almost 2 years ago)
- Last Synced: 2025-08-08T23:55:12.281Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 560 KB
- Stars: 36
- Watchers: 16
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Client library that wraps common patterns when interacting with the
VirusTotal Augment widget.
Go to demo
# Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [API](#api)
# Installation
```bash
npm i @virustotal/vt-augment --save
```
# Usage
**VT Augment is bundled using the UMD format (@`dist/vt-augment.min.js`).**
```html
```
## Code
```html
```
```javascript
const container = document.querySelector('#vt-augment-container');
const vtaugment = new VTAugment(container, options)
vtaugment.load("[url]").openDrawer()
```
## Modes
### Drawer
This is the default mode, VT Augment will be shown in a right side panel when the `openDrawer` method is called.
### Standalone
This mode allows you to integrate the widget as a non-animated div in your page. See [Options](#options).
# API
### vtaugment(container = null, opts = {})
Creates a new object with a html element and a set of options. An iframe is dynamically created inside the container to host the VT API response.
## Methods
*Methods can be chained and can be called in whatever order.*
| [load](#loadurl-string) | [openDrawer](#opendrawer) | [closeDrawer](#closedrawer) | [loading](#loading(active-boolean))
|-----|-----|-----|-----|
#### load(url: string)
Loads the VT API url into the iframe.
```js
vtaugment.load("...")
// Additionally, if the mode is `drawer` can be used along with the method `openDrawer`
vtaugment.load("...").openDrawer()
```
#### openDrawer()
Open a drawer panel from the right side. (Only works in [drawer](#drawer) mode)
```js
vtaugment.openDrawer()
```
#### closeDrawer()
Close the drawer panel. (Only works in [drawer](#drawer) mode)
```js
vtaugment.closeDrawer()
```
#### loading(active: boolean)
The loading state is managed internally by the library but in the case of need the api provides this method to control loading manually. (Active loading hide the content)
```js
vtaugment.loading(true)
```
## Options
```js
{
// Background color for loading states. Default ''.
background: '#fff',
// Force to closing the widget only with the X button. Default true.
closingFromOutside: true | false,
// Select the widget mode. Default drawer.
mode: 'drawer' | 'standalone',
}
```