@virustotal/vt-augment

Client library that wraps common patterns when interacting with the VirusTotal Augment widget.

Go to demo

Table of Contents

• Installation
• Usage
• API

Installation

npm i @virustotal/vt-augment --save

Usage

VT Augment is bundled using the UMD format (@dist/vt-augment.min.js).

<!--- "VTAugment" will be attached to the global window object. -->
<script src="./node_modules/@virustotal/vt-augment/dist/vt-augment.min.js"></script>

Code

<div id="vt-augment-container"></div>

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.

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	openDrawer	closeDrawer	loading

load(url: string)

Loads the VT API url into the iframe.

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 mode)

vtaugment.openDrawer()

closeDrawer()

Close the drawer panel. (Only works in drawer mode)

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)

vtaugment.loading(true)

Options

{
  // 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',
}