How do I initialize cytoscape using Typescript?
I built a React component with Typescript that uses cytoscape (and its types ) as a headless model. My goal is to create an NPM package so that I can directly import it into other projects.
My library:
- Works when I import cytoscape.js into my index.html as a static asset
- Not when I have
npm install
my component in the new application ES6:Uncaught ReferenceError: cytoscape is not defined at new WbsLayout
. This is despite the fact that cytoscape is automatically installed in node_modules when I install my component.
Typescript source
WbsLayout.tsx:
export class WbsLayout {
//...
public cy: Cy.Core;
constructor(graph: any, Options?: Options) {
this.cy = cytoscape({ // <-- Works or fails, see cases #1 and #2 explained above
headless: true,
elements: graph
});
//...
}
//...
}
Please note that I am not import cytoscape from 'cytoscape'
(or any similar ways) anywhere in my component source, since I didn’t have any, as it seems that with Typescript and the way of defining cytoscopic images I didn’t use it, t need my component to work with cytoscape imported in html. This might be a problem for the NPN package, though ...
Wbs.tsx:
A simple React component that gets WbsLayout support.
cytoscopic pictograms (relevant part only)
declare namespace Cy {
//...
interface Core { }
//...
interface Static {
(options?: Cy.CytoscapeOptions): Core;
(extensionName: string, foo: string, bar: any): Core;
version: string;
}
}
declare module "cytoscape" {
export = cytoscape;
}
declare var cytoscape: Cy.Static;
Webpack 2 config
Wbs.tsx
, WbsLayout.tsx
and others linked in @nodeject/wbs-react
with Webpack 2:
module.exports = {
entry: {
'test/index': './src/test.tsx',
'dist/index': './src/index.tsx'
},
output: {
filename: "./[name].js",
libraryTarget: 'umd',
library: 'wbs-react',
umdNamedDefine: true
},
devtool: "source-map",
resolve: {
extensions: [".webpack.js", ".web.js", ".ts", ".tsx", ".js"]
},
node: {
fs: "empty",
child_process: "empty"
},
module: {
rules: [
{
enforce: 'pre',
test: /\.js$/,
loader: "source-map-loader"
},
{
test: /\.tsx?$/,
loader: "ts-loader"
},
{
test: /\.css$/,
loader: "style-loader!css-loader"
},
]
},
externals: {
"react": {
root: 'React',
commonjs2: 'react',
commonjs: 'react',
amd: 'react'
},
"react-dom": {
root: 'ReactDOM',
commonjs2: 'react-dom',
commonjs: 'react-dom',
amd: 'react-dom'
},
"cytoscape": {
root: 'Cy',
commonjs2: 'cytoscape',
commonjs: 'cytoscape',
amd: 'cytoscape'
},
"chai": {
root: 'chai',
commonjs2: 'chai',
commonjs: 'chai',
amd: 'chai'
}
}
};
tsconfig.json
{
"compilerOptions": {
"outDir": "./temp/",
"sourceMap": false,
"noImplicitAny": true,
"module": "commonjs",
"target": "es2015",
"allowSyntheticDefaultImports": true,
"moduleResolution": "node",
"jsx": "react"
},
"exclude": [
"node_modules",
"dist",
"temp",
"test"
]
}
New source for eS6
import React from 'react';
import ReactDOM from 'react-dom';
import {Wbs, WbsLayout} from '@nodeject/wbs-react';
let graph = {
nodes: [
{ data: { id: '1' } },
{ data: { id: '1.1', parent: '1' } }
],
edges: [
{ data: { id: 'e1', source: '1', target: '1.1' } }
]
};
layout: new WbsLayout(graph); // <-- Fails here (case #2)
ReactDOM.render(<Wbs layout={layout}/>, document.querySelector('#wbs_example'));
source to share
I found the answer by noticing that if I removed the cytoscript entirely from external in webpack, it worked. Here's what I need to do:
"cytoscape": {
root: 'Cy',
commonjs2: 'cytoscape',
commonjs: 'cytoscape',
amd: 'cytoscape'
}
should have been:
"cytoscape": {
root: 'cytoscape', <--------
commonjs2: 'cytoscape',
commonjs: 'cytoscape',
amd: 'cytoscape'
}
source to share