KTNB-1205: Support Jupyter Widgets

README.md

@@ -12,6 +12,7 @@ Each integration lives in the `integrations/` directory and has its own README.
 - [IntelliJ Platform](integrations/intellij-platform/README.md) — interactive access to IntelliJ Platform APIs from a running IDE process.
 - [HTTP Utilities](integrations/http-util/README.md) — JSON/serialization helpers and Ktor HTTP client wrappers for notebooks.
 - [Database](integrations/database/README.md) — helpers for configuring JDBC DataSources and working with Databases.
+- [Widgets](integrations/widgets/README.md) — ipywidgets API for Kotlin notebooks.
 
 ## Contributing
 

build.gradle.kts

@@ -3,7 +3,7 @@ plugins {
     alias(libs.plugins.publisher)
     alias(libs.plugins.buildconfig)
     alias(libs.plugins.kotlin.serialization) apply false
-    alias(libs.plugins.ktlint) apply false
+    alias(libs.plugins.ktlint)
 }
 
 version =
@@ -16,6 +16,13 @@ allprojects {
     version = rootProject.version
 
     plugins.apply("org.jlleitschuh.gradle.ktlint")
+    ktlint {
+        filter {
+            exclude { entry ->
+                entry.file.toString().contains("generated")
+            }
+        }
+    }
 
     repositories {
         mavenCentral()

gradle/libs.versions.toml

@@ -3,7 +3,7 @@
 # https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under
 jvmTarget = "17"
 kotlin = "2.2.20"
-kotlin-jupyter = "0.15.1-668"
+kotlin-jupyter = "0.15.1-768-1"
 publishPlugin = "2.2.0-dev-71"
 intellijPlatformGradlePlugin = "2.10.3"
 intellijPlatform = "253-EAP-SNAPSHOT" # TODO: lower to 2025.1.3 GA whenever released with required changes

integrations/intellij-platform/build.gradle.kts

@@ -12,10 +12,6 @@ plugins {
 val spaceUsername: String by properties
 val spaceToken: String by properties
 
-allprojects {
-    version = rootProject.version
-}
-
 tasks.processJupyterApiResources {
     libraryProducers = listOf("org.jetbrains.kotlinx.jupyter.intellij.IntelliJPlatformJupyterIntegration")
 }

integrations/widgets/README.md

@@ -0,0 +1,46 @@
+[![JetBrains official project](https://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
+[![Kotlin experimental stability](https://img.shields.io/badge/project-experimental-kotlin.svg?colorA=555555&colorB=AC29EC&label=&logo=kotlin&logoColor=ffffff&logoWidth=10)](https://kotlinlang.org/docs/components-stability.html)
+
+# Kotlin Notebook Widgets Integration
+
+This integration provides a collection of interactive widgets for Kotlin Notebooks, such as sliders, labels, and more. It allows you to create a richer, more interactive experience within your notebooks.
+
+## Usage
+
+Use this API through the `%use widgets` magic command in a Kotlin Notebook.
+
+```kotlin
+%use widgets
+
+val slider = intSliderWidget().apply {
+    min = 0
+    max = 100
+    value = 50
+    description = "Select a value:"
+}
+
+val label = labelWidget().apply {
+    value = "Current value: ${slider.value}"
+}
+
+// Display the slider
+slider
+```
+
+## Module structure
+
+This project consists of the following modules:
+
+- `widgets-api`: Contains the core widget implementations, protocols, and model definitions.
+- `widgets-jupyter`: Provides the integration logic and useful helpers for Kotlin Jupyter notebooks.
+- `widgets-generator`: Generates widget models from `schema.json`.
+- `widgets-tests`: Contains integration tests for widgets.
+
+## Development
+
+Most widgets are automatically generated from a schema.
+To regenerate widgets after changing `schema.json` or the generator itself, run:
+
+```bash
+./gradlew :integrations:widgets:widgets-generator:generateWidgets
+```

integrations/widgets/build.gradle.kts

@@ -0,0 +1,24 @@
+import org.jetbrains.kotlinx.publisher.apache2
+import org.jetbrains.kotlinx.publisher.githubRepo
+
+plugins {
+    alias(libs.plugins.publisher)
+}
+
+kotlinPublications {
+    pom {
+        githubRepo("Kotlin", "kotlin-notebook-integrations")
+        inceptionYear = "2025"
+        licenses {
+            apache2()
+        }
+        developers {
+            developer {
+                id.set("kotlin-jupyter-team")
+                name.set("Kotlin Jupyter Team")
+                organization.set("JetBrains")
+                organizationUrl.set("https://www.jetbrains.com")
+            }
+        }
+    }
+}

integrations/widgets/widgets-api/build.gradle.kts

@@ -0,0 +1,40 @@
+plugins {
+    alias(libs.plugins.kotlin.jvm)
+    alias(libs.plugins.publisher)
+    alias(libs.plugins.kotlin.serialization)
+    alias(libs.plugins.kotlin.jupyter.api)
+}
+
+dependencies {
+    api(libs.kotlinx.serialization.json)
+    implementation(libs.kotlin.reflect)
+
+    testImplementation(libs.kotlin.test)
+    testImplementation(libs.test.kotlintest.assertions)
+    testImplementation(libs.kotlinx.serialization.json)
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+
+kotlin {
+    jvmToolchain(
+        libs.versions.jvm.toolchain
+            .get()
+            .toInt(),
+    )
+    explicitApi()
+}
+
+sourceSets {
+    main {
+        kotlin.srcDir("src/generated/kotlin")
+    }
+}
+
+kotlinPublications {
+    publication {
+        description.set("Kotlin APIs for IPython Widgets")
+    }
+}

integrations/widgets/widgets-api/src/generated/kotlin/org/jetbrains/kotlinx/jupyter/widget/library/AccordionWidget.kt

@@ -0,0 +1,52 @@
+// Generated by widgets-generator. Do not edit manually.
+package org.jetbrains.kotlinx.jupyter.widget.library
+
+import org.jetbrains.kotlinx.jupyter.widget.WidgetManager
+import org.jetbrains.kotlinx.jupyter.widget.library.enums.BoxStyle
+import org.jetbrains.kotlinx.jupyter.widget.model.DefaultWidgetFactory
+import org.jetbrains.kotlinx.jupyter.widget.model.DefaultWidgetModel
+import org.jetbrains.kotlinx.jupyter.widget.model.WidgetModel
+import org.jetbrains.kotlinx.jupyter.widget.model.WidgetSpec
+import org.jetbrains.kotlinx.jupyter.widget.model.createAndRegisterWidget
+import org.jetbrains.kotlinx.jupyter.widget.model.types.compound.ArrayType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.compound.NullableType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.enums.WidgetEnumEntry
+import org.jetbrains.kotlinx.jupyter.widget.model.types.enums.WidgetEnumType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.BooleanType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.IntType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.StringType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.widget.WidgetReferenceType
+
+private val accordionSpec = WidgetSpec(
+    modelName = "AccordionModel",
+    modelModule = "@jupyter-widgets/controls",
+    modelModuleVersion = "2.0.0",
+    viewName = "AccordionView",
+    viewModule = "@jupyter-widgets/controls",
+    viewModuleVersion = "2.0.0",
+)
+
+public fun WidgetManager.accordion(): AccordionWidget = createAndRegisterWidget(AccordionWidget.Factory)
+
+public class AccordionWidget internal constructor(
+    widgetManager: WidgetManager,
+    fromFrontend: Boolean,
+) : DefaultWidgetModel(accordionSpec, widgetManager) {
+    internal object Factory : DefaultWidgetFactory<AccordionWidget>(accordionSpec, ::AccordionWidget)
+
+    /** CSS classes applied to widget DOM element */
+    public var domClasses: List<String?> by prop("_dom_classes", ArrayType(NullableType(StringType)), emptyList())
+    /** Use a predefined styling for the box. */
+    public var boxStyle: WidgetEnumEntry<BoxStyle> by prop("box_style", WidgetEnumType(BoxStyle, BoxStyle.Default), BoxStyle.Default)
+    /** List of widget children */
+    public var children: List<WidgetModel?> by prop("children", ArrayType(NullableType(WidgetReferenceType<WidgetModel>())), emptyList())
+    public var layout: LayoutWidget? by nullableWidgetProp("layout", if (fromFrontend) null else widgetManager.layout())
+    /** The index of the selected page. This is either an integer selecting a particular sub-widget, or None to have no widgets selected. */
+    public var selectedIndex: Int? by nullableIntProp("selected_index", null)
+    /** Is widget tabbable? */
+    public var tabbable: Boolean? by nullableBoolProp("tabbable", null)
+    /** Titles of the pages */
+    public var titles: List<String?> by prop("titles", ArrayType(NullableType(StringType)), emptyList())
+    /** A tooltip caption. */
+    public var tooltip: String? by nullableStringProp("tooltip", null)
+}

integrations/widgets/widgets-api/src/generated/kotlin/org/jetbrains/kotlinx/jupyter/widget/library/AudioWidget.kt

@@ -0,0 +1,50 @@
+// Generated by widgets-generator. Do not edit manually.
+package org.jetbrains.kotlinx.jupyter.widget.library
+
+import org.jetbrains.kotlinx.jupyter.widget.WidgetManager
+import org.jetbrains.kotlinx.jupyter.widget.model.DefaultWidgetFactory
+import org.jetbrains.kotlinx.jupyter.widget.model.DefaultWidgetModel
+import org.jetbrains.kotlinx.jupyter.widget.model.WidgetSpec
+import org.jetbrains.kotlinx.jupyter.widget.model.createAndRegisterWidget
+import org.jetbrains.kotlinx.jupyter.widget.model.types.compound.ArrayType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.compound.NullableType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.BooleanType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.BytesType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.StringType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.widget.WidgetReferenceType
+
+private val audioSpec = WidgetSpec(
+    modelName = "AudioModel",
+    modelModule = "@jupyter-widgets/controls",
+    modelModuleVersion = "2.0.0",
+    viewName = "AudioView",
+    viewModule = "@jupyter-widgets/controls",
+    viewModuleVersion = "2.0.0",
+)
+
+public fun WidgetManager.audio(): AudioWidget = createAndRegisterWidget(AudioWidget.Factory)
+
+public class AudioWidget internal constructor(
+    widgetManager: WidgetManager,
+    fromFrontend: Boolean,
+) : DefaultWidgetModel(audioSpec, widgetManager) {
+    internal object Factory : DefaultWidgetFactory<AudioWidget>(audioSpec, ::AudioWidget)
+
+    /** CSS classes applied to widget DOM element */
+    public var domClasses: List<String?> by prop("_dom_classes", ArrayType(NullableType(StringType)), emptyList())
+    /** When true, the audio starts when it's displayed */
+    public var autoplay: Boolean by boolProp("autoplay", true)
+    /** Specifies that audio controls should be displayed (such as a play/pause button etc) */
+    public var controls: Boolean by boolProp("controls", true)
+    /** The format of the audio. */
+    public var format: String by stringProp("format", "mp3")
+    public var layout: LayoutWidget? by nullableWidgetProp("layout", if (fromFrontend) null else widgetManager.layout())
+    /** When true, the audio will start from the beginning after finishing */
+    public var loop: Boolean by boolProp("loop", true)
+    /** Is widget tabbable? */
+    public var tabbable: Boolean? by nullableBoolProp("tabbable", null)
+    /** A tooltip caption. */
+    public var tooltip: String? by nullableStringProp("tooltip", null)
+    /** The media data as a memory view of bytes. */
+    public var value: ByteArray by bytesProp("value", byteArrayOf())
+}

integrations/widgets/widgets-api/src/generated/kotlin/org/jetbrains/kotlinx/jupyter/widget/library/BoundedFloatTextWidget.kt

@@ -0,0 +1,58 @@
+// Generated by widgets-generator. Do not edit manually.
+package org.jetbrains.kotlinx.jupyter.widget.library
+
+import org.jetbrains.kotlinx.jupyter.widget.WidgetManager
+import org.jetbrains.kotlinx.jupyter.widget.model.DefaultWidgetFactory
+import org.jetbrains.kotlinx.jupyter.widget.model.DefaultWidgetModel
+import org.jetbrains.kotlinx.jupyter.widget.model.WidgetSpec
+import org.jetbrains.kotlinx.jupyter.widget.model.createAndRegisterWidget
+import org.jetbrains.kotlinx.jupyter.widget.model.types.compound.ArrayType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.compound.NullableType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.BooleanType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.FloatType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.StringType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.widget.WidgetReferenceType
+
+private val boundedFloatTextSpec = WidgetSpec(
+    modelName = "BoundedFloatTextModel",
+    modelModule = "@jupyter-widgets/controls",
+    modelModuleVersion = "2.0.0",
+    viewName = "FloatTextView",
+    viewModule = "@jupyter-widgets/controls",
+    viewModuleVersion = "2.0.0",
+)
+
+public fun WidgetManager.boundedFloatText(): BoundedFloatTextWidget = createAndRegisterWidget(BoundedFloatTextWidget.Factory)
+
+public class BoundedFloatTextWidget internal constructor(
+    widgetManager: WidgetManager,
+    fromFrontend: Boolean,
+) : DefaultWidgetModel(boundedFloatTextSpec, widgetManager) {
+    internal object Factory : DefaultWidgetFactory<BoundedFloatTextWidget>(boundedFloatTextSpec, ::BoundedFloatTextWidget)
+
+    /** CSS classes applied to widget DOM element */
+    public var domClasses: List<String?> by prop("_dom_classes", ArrayType(NullableType(StringType)), emptyList())
+    /** Update the value as the user types. If False, update on submission, e.g., pressing Enter or navigating away. */
+    public var continuousUpdate: Boolean by boolProp("continuous_update", false)
+    /** Description of the control. */
+    public var description: String by stringProp("description", "")
+    /** Accept HTML in the description. */
+    public var descriptionAllowHtml: Boolean by boolProp("description_allow_html", false)
+    /** Enable or disable user changes */
+    public var disabled: Boolean by boolProp("disabled", false)
+    public var layout: LayoutWidget? by nullableWidgetProp("layout", if (fromFrontend) null else widgetManager.layout())
+    /** Max value */
+    public var max: Double by doubleProp("max", 100.0)
+    /** Min value */
+    public var min: Double by doubleProp("min", 0.0)
+    /** Minimum step to increment the value */
+    public var step: Double? by nullableDoubleProp("step", null)
+    /** Styling customizations */
+    public var style: DescriptionStyleWidget? by nullableWidgetProp("style", if (fromFrontend) null else widgetManager.descriptionStyle())
+    /** Is widget tabbable? */
+    public var tabbable: Boolean? by nullableBoolProp("tabbable", null)
+    /** A tooltip caption. */
+    public var tooltip: String? by nullableStringProp("tooltip", null)
+    /** Float value */
+    public var value: Double by doubleProp("value", 0.0)
+}

integrations/widgets/widgets-api/src/generated/kotlin/org/jetbrains/kotlinx/jupyter/widget/library/BoundedIntTextWidget.kt

@@ -0,0 +1,58 @@
+// Generated by widgets-generator. Do not edit manually.
+package org.jetbrains.kotlinx.jupyter.widget.library
+
+import org.jetbrains.kotlinx.jupyter.widget.WidgetManager
+import org.jetbrains.kotlinx.jupyter.widget.model.DefaultWidgetFactory
+import org.jetbrains.kotlinx.jupyter.widget.model.DefaultWidgetModel
+import org.jetbrains.kotlinx.jupyter.widget.model.WidgetSpec
+import org.jetbrains.kotlinx.jupyter.widget.model.createAndRegisterWidget
+import org.jetbrains.kotlinx.jupyter.widget.model.types.compound.ArrayType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.compound.NullableType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.BooleanType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.IntType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.primitive.StringType
+import org.jetbrains.kotlinx.jupyter.widget.model.types.widget.WidgetReferenceType
+
+private val boundedIntTextSpec = WidgetSpec(
+    modelName = "BoundedIntTextModel",
+    modelModule = "@jupyter-widgets/controls",
+    modelModuleVersion = "2.0.0",
+    viewName = "IntTextView",
+    viewModule = "@jupyter-widgets/controls",
+    viewModuleVersion = "2.0.0",
+)
+
+public fun WidgetManager.boundedIntText(): BoundedIntTextWidget = createAndRegisterWidget(BoundedIntTextWidget.Factory)
+
+public class BoundedIntTextWidget internal constructor(
+    widgetManager: WidgetManager,
+    fromFrontend: Boolean,
+) : DefaultWidgetModel(boundedIntTextSpec, widgetManager) {
+    internal object Factory : DefaultWidgetFactory<BoundedIntTextWidget>(boundedIntTextSpec, ::BoundedIntTextWidget)
+
+    /** CSS classes applied to widget DOM element */
+    public var domClasses: List<String?> by prop("_dom_classes", ArrayType(NullableType(StringType)), emptyList())
+    /** Update the value as the user types. If False, update on submission, e.g., pressing Enter or navigating away. */
+    public var continuousUpdate: Boolean by boolProp("continuous_update", false)
+    /** Description of the control. */
+    public var description: String by stringProp("description", "")
+    /** Accept HTML in the description. */
+    public var descriptionAllowHtml: Boolean by boolProp("description_allow_html", false)
+    /** Enable or disable user changes */
+    public var disabled: Boolean by boolProp("disabled", false)
+    public var layout: LayoutWidget? by nullableWidgetProp("layout", if (fromFrontend) null else widgetManager.layout())
+    /** Max value */
+    public var max: Int by intProp("max", 100)
+    /** Min value */
+    public var min: Int by intProp("min", 0)
+    /** Minimum step to increment the value */
+    public var step: Int by intProp("step", 1)
+    /** Styling customizations */
+    public var style: DescriptionStyleWidget? by nullableWidgetProp("style", if (fromFrontend) null else widgetManager.descriptionStyle())
+    /** Is widget tabbable? */
+    public var tabbable: Boolean? by nullableBoolProp("tabbable", null)
+    /** A tooltip caption. */
+    public var tooltip: String? by nullableStringProp("tooltip", null)
+    /** Int value */
+    public var value: Int by intProp("value", 0)
+}