Introducing VDT
The information on this page is sourced from: Start Here / Introduction - Page ⋅ Storybook (vidispine.github.io)
Introduction
Vidispine Development Toolkit (VDT) is a collection of packages used to help build (JavaScript-based) solutions with Vidispine.
The documentation in here show examples on how to use the toolkit. In the Canvas view you can try these out using controls and actions, while in the Docs view you'll see APIs and code examples. Furthermore, there's additional information of packages and categories found inside the Overview links.
Installation
Vdt packages are published and can be installed from the npm public registry. All packages are bundled as ECMAScript modules (ESM) which has best tree shake, code/module splitting and hmr support. ESM is also supported in modern versions of node However, we also export bundles with Universal Module Definition (UMD) or CommonJs (CJS). Use you're favorite package manager to retrieve packages (e.g. yarn, npm, pnpm). In general, all modules can be imported from the root level.
Peer Dependencies
To avoid installing dependencies for modules you aren't using we add some as peer dependencies; hence, if you decide to use them, manually add these as dependencies. At the Installation documentation for packages you'll find a list of the peer dependencies certain modules need to work. You can also find more information about the peer dependencies (e.g. compliant versions) from the package manager during install or by viewing the vdt packages at npmjs.com
Note: peerDependencies are automatically installed with npm 7+, but not with yarn or pnpm
Published Packages
Package | Description | Version | Latest Release |
|---|---|---|---|
Javascript API for VidiCore | 23.4.0 |  | |
Javascript SDK for VidiCore | 23.4.0 |  | |
React SDK for VidiCore | 23.4.0 |  | |
React timeline based on react-konva | 23.4.0 |  | |
Materialui (v4) library for VidiCore | 23.4.0 |  | |
Mui (v5) library for VidiCore | 23.4.0 |  | |
Javascript player based on videojs | 23.4.0 |  | |
React player based on vdt-videojs | 23.4.0 |  |
Developer Packages
Package | Description | Version | Latest Release |
|---|---|---|---|
CRA template using vdt packages | 23.4.0 |  | |
PropTypes for VidiCore | 23.4.0 |  | |
TypeScript definitions for VidiCore | 23.4.0 |  | |
Eslint config for React apps | 23.4.0 |  | |
Eslint config for React libs | 23.4.0 |  | |
Eslint config for Javascript | 23.4.0 |  | |
Eslint config for Typescript | 23.4.0 |  | |
Prettier config | 23.4.0 |  |