kotlin-notebook-js

Jupyter Kotlin Kernel support %js/%ts/%jsx/%tsx line magics.

Feature

• import any variable from kotlin world
• support JavaScript / TypeScript / React

Support magic

• %js
• %javacript
• %jsx
• %ts
• %typescript
• %tsx

Usage

Import The Library First

Latest dev jupyter kotlin kernel support %use magic.

%use jupyter-js

For old version, you have to using USE {} block.

USE {
    repositories {
        mavenCentral()

        maven("https://s01.oss.sonatype.org/content/groups/public/")
    }

    dependencies {
        implementation("dev.yidafu.jupyter:jupyter-js:0.7.0")
    }
}

JS Example

In JS world, you can import any variables from kotlin world, through the virtual package @jupyter.

You can call getCellRoot() to get a div element in output cell, and then do every thing you want to do.

• Baics Usage
• Echarts 3D Example

first declare a variable in cell

// value define in kotlin world
val kNumber = 233

then, add a cell with %js magic

%js
// using `kNumber` in js workd
import { kNumber } from '@jupyter'

getCellRoot().innerHTML = `<h1>${kNumber}</h1>`

screenshot

inline js script

In some case, you may want to reuse js script.

Jupyter JS support inline relative and remote script.

Inline script supports all feature as js script in cell.

you just import js script in local workspace, like: example/local.js

%js
import { foo } from './local.js'

console.log(foo)
// ==> 123

Or you may want using some shared script online. Add ?inline query parameter after url.

%js
import { foo } from  "https://cdn.jsdelivr.net/gh/yidafu/kotlin-jupyter-js@main/examples/local.js?inline"

console.log(foo)
// ==> 123

React Example

Just export your component function.

%jsx/%tsx magic will render your default export component function

%jsx

import { foo } from "@jupyter";

export default function App() {
    return <h1>{foo}</h1>
}

screenshot

Using NPM Library

You may want using npm package? fine, JupyterJs will transform js code into <script type="module">. this means you can import any script or package by http(s) link.

like this:

%js
import _ from 'https://cdn.jsdelivr.net/npm/lodash-es@4.17.21/lodash.min.js';

https://esm.sh/ may help you

Too long to Coding? JupyterJs also support import source replacement. JupyterJs will replace import source which libs-mapping.json contains into http(s) link

so, you can coding like this:

%js
import _ from 'lodash';

builtin packages

see: libs-mapping.json

• react
• react-dom
• lodash
• echarts
• d3
• highcharts
• visjs

Adding your favorite pakcage, submit a PR/Issue.

Echarts Example

see https://echarts.apache.org/examples/en/editor.html?c=line-simple&lang=ts

1. Defined Value in Kotlin Cell

val dataArray = arrayOf(150, 230, 224, 218, 135, 147, 260)

2. using it with %ts magic, render to char

%ts
import { dataArray } from "@jupyter";
import * as echarts from 'echarts';

type EChartsOption = echarts.EChartsOption;

var chartDom = getCellRoot();
chartDom.style = "width:300px; height: 300px"
var myChart = echarts.init(chartDom);
var option: EChartsOption;

option = {
  xAxis: {
    type: 'category',
    data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
  },
  yAxis: {
    type: 'value'
  },
  series: [
    {
      data: dataArray,
      type: 'line'
    }
  ]
};

option && myChart.setOption(option);

screenshot

kotlin variable alias

jsExport will export kotlin variable to javascript. kotlin variable will encode to json string.

val foo = "string"
// export variable to javascript
jsExport("bar", foo)

%js
import { foo, bar } from '@jupyter';

console.log(foo == bar);

full example see examples/js-magic.ipynb

Article

how kotlin jupyter js workd? (English Translation) - 中文原文

Documentation

Jupyter Kotlin Js API

TODO LIST

• swc binding for compile js code
• %js/%tsmagics
• %jsx/%tsx magic
• import variable from Kotlin world. like this: import { foo } from "@jupyter"
• js syntax highlight
• etc...