This documentation is for an unreleased (still in testing) version of Cornerstone Tools. Until it is released, its API may experience frequent breaking changes. The current stable release can be found here.
CornerstoneTools.js does not support IE8 and below because it uses ECMAScript 5 features that are un-shimmable in IE8. However it supports all ECMAScript 5 compliant browsers.
We're a small team, so our docs may not always be 100% accurate. Please feel free to create an issue and/or PR a change to update our docs.
- Latest stable version:
- Latest beta version:
You can find the latest versions for each tag by clicking the
versions tab for the cornerstone-tools npm listing
Detailed release notes for each version are available on GitHub.
Simply download and include with a script tag.
CornerstoneTools will be registered as a global variable.
We recommend linking to a specific version number that you can update manually:
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
You can browse the source of the NPM package at cdn.jsdelivr.net/npm/cornerstone-tools.
CornerstoneTools.js is also available on unpkg.
# latest stable npm install --save cornerstone-tools # latest @next (pre-release) npm install --save [email protected]
Explanation of Different Builds
dist/ directory of the NPM package you will find a few different builds for CornerstoneTools.js. Here's an overview of the difference between them:
CommonJS: CommonJS builds are intended for use with older bundlers like browserify or webpack 1. The default file for these bundlers (
pkg.main) is the CommonJS build (
ES Module: ES module builds are intended for use with modern bundlers like webpack 2+ or rollup. The default file for these bundlers (
pkg.module) is the ES Module build (
- Update dependencies (after each pull):
- Running the build:
- Run the local development server:
npm run start:dev