Skip to main content
Skip table of contents

Installation [VDT SG]

The information on this page is sourced from here: Start Here / Installation - Page ⋅ Storybook (vidispine.github.io)

Installation

All packages are published and can be installed from the npm public registry. Typically you'd use the package mangers (and cli tools) from npm or yarn. Here below you'll see ways of importing these with ECMAScript modules (ESM) or CommonJs (CJS). Please note that all exports are available from the root import.

vdt-mui

Install

npm: npm install @vidispine/vdt-mui

yarn: yarn add @vidispine/vdt-mui

Import

ESM:

CODE
import { CollectionList } from '@vidispine/vdt-mui';Copy

vdt-materialui

Install

npm: npm install @vidispine/vdt-materialui

yarn: yarn add @vidispine/vdt-materialui

Import

ESM:

CODE
import { ItemCard } from '@vidispine/vdt-materialui';Copy

vdt-react

Install

npm: npm install @vidispine/vdt-react

yarn: yarn add @vidispine/vdt-react

Import

ESM:

CODE
import { useApi } from '@vidispine/vdt-react';Copy

vdt-api

Install

npm: npm install @vidispine/vdt-api

yarn: yarn add @vidispine/vdt-api

Import

ESM:

CODE
import vdtApi from '@vidispine/vdt-api';
// or import specific endpoint and rename
import { item as ItemApi } from '@vidispine/vdt-api';Copy

CJS:

CODE
const vdtApi = require('@vidispine/vdt-api');
// or destruct and rename
const { item: ItemApi } = require('@vidispine/vdt-api');Copy

vdt-js

Install

npm: npm install @vidispine/vdt-js

yarn: yarn add @vidispine/vdt-js

Import

ESM:

CODE
import vdtJs from '@vidispine/vdt-js';
// or import specific function
import { parseMetadataType } from '@vidispine/vdt-js';Copy

CJS:

CODE
const vdtJs = require('@vidispine/vdt-js');
// or destruct and use specific function
const { parseMetadataType } = require('@vidispine/vdt-js');Copy

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.