User Guide

• Installation
  • Installing in classic Jupyter Notebook
  • Installing in JupyterLab 3.0
  • Installing into JupyterLab 1 or 2
  • Frequently Asked Questions
• Using Interact
  • Basic interact
  • Fixing arguments using fixed
  • Widget abbreviations
  • interactive
  • Disabling continuous updates
    • interact_manual
    • continuous_update
  • More control over the user interface: interactive_output
  • Arguments that are dependent on each other
  • Flickering and jumping output
• Simple Widget Introduction
  • What are widgets?
  • What can they be used for?
  • Using widgets
    • repr
    • display()
    • Multiple display() calls
  • Why does displaying the same widget twice work?
    • Closing widgets
  • Widget properties
    • Keys
    • Shorthand for setting the initial values of widget properties
  • Linking two similar widgets
    • Unlinking widgets
• Widget List
  • Numeric widgets
    • IntSlider
    • FloatSlider
    • FloatLogSlider
    • IntRangeSlider
    • FloatRangeSlider
    • IntProgress
    • FloatProgress
    • BoundedIntText
    • BoundedFloatText
    • IntText
    • FloatText
  • Boolean widgets
    • ToggleButton
    • Checkbox
    • Valid
  • Selection widgets
    • Dropdown
    • RadioButtons
    • Select
    • SelectionSlider
    • SelectionRangeSlider
    • ToggleButtons
    • SelectMultiple
  • String widgets
    • Text
    • Textarea
    • Combobox
    • Label
    • HTML
    • HTML Math
  • Image
  • Button
  • Output
  • Play (Animation) widget
  • Date picker
  • Color picker
  • File Upload
  • Controller
  • Container/Layout widgets
    • Box
    • HBox
    • VBox
    • GridBox
    • Accordion
    • Tabs
    • Accordion and Tab use selected_index, not value
    • Nesting tabs and accordions
• Output widgets: leveraging Jupyter’s display system
  • Output widgets as the foundation for interact
  • Debugging errors in callbacks with the output widget
  • Integrating output widgets with the logging module
  • Interacting with output widgets from background threads
• Widget Events
  • Special events
    • Example
  • Traitlet events
    • Signatures
  • Linking Widgets
    • Linking traitlets attributes in the kernel
    • Registering callbacks to trait changes in the kernel
    • Linking widgets attributes from the client side
    • The difference between linking in the kernel and linking in the client
  • Continuous updates
• Layout and Styling of Jupyter widgets
  • The layout attribute
    • Exposed CSS properties
    • Shorthand CSS properties
    • Simple examples
    • Description
    • Natural sizes, and arrangements using HBox and VBox
    • Latex
    • Number formatting
  • The Flexbox layout
    • Acknowledgement
    • Basics and terminology
    • Properties of the parent
    • Properties of the items
    • The VBox and HBox helpers
    • Examples
  • Predefined styles
  • The style attribute
  • The Grid layout
    • Basics and browser support
    • Important terminology
    • Properties of the parent
    • Properties of the items
  • Image layout and sizing
    • Controlling the display of an Image inside a container
    • Examples of object_fit
    • object_fit in a Box smaller than the original image
    • object_fit in a Box larger than the original image
    • object_fit in a Box larger than the original image: use image layout width 100% to fill container
    • Examples of object_position
    • Specifying object_position with keywords
    • Specifying object_position with offsets in pixels
    • Specifying object_position with offsets as a percentage
• Using Layout Templates
  • 2x2 Grid
  • AppLayout
  • Grid layout
  • Creating scatter plots using GridspecLayout
  • Style attributes
  • Example
• Building a Custom Widget - Email widget
  • Building a Custom Widget
  • Python Kernel
    • DOMWidget and Widget
    • _view_name
    • sync=True traitlets
    • Other traitlet types
  • Front end (JavaScript)
    • Models and views
    • Import @jupyter-widgets/base
    • Define the view
    • Render method
  • Test
  • Making the widget stateful
    • Accessing the model from the view
    • Rendering model contents
    • Dynamic updates
  • Test
  • More advanced uses: Packaging and distributing Jupyter widgets
• Low Level Widget Tutorial
  • How do they fit into the picture?
  • How?
  • Comms
  • Synchronized state
  • Models and Views
  • Code execution
  • Model construction
  • Displaying a view
  • Widget skeleton
  • Serialization of widget attributes
    • Custom serialization and de-serialization on the Python side
    • Custom serialization and de-serialization on the JavaScript side
  • Installation
  • Static assets
  • Distribution
• Asynchronous Widgets
  • Waiting for user interaction
    • Event loop integration
    • Generator approach
    • Modifications
  • Updating a widget in the background
• Embedding Jupyter Widgets in Other Contexts than the Notebook
  • Embedding Widgets in HTML Web Pages
    • Save Notebook Widget State
    • Embeddable HTML Snippet
    • Widget State JSON
  • Python interface
  • Embedding Widgets in the Sphinx HTML Documentation
    • Using the Jupyter Sphinx Extension
    • Using the nbsphinx Project
  • Rendering Interactive Widgets on nbviewer
  • The Case of Custom Widget Libraries
  • Using jupyter-widgets-controls in web contexts
• Contributing
• Migrating custom widget libraries
  • Migrating from 6.0 to 7.0
    • Updating setup.py
    • Updating package.json
    • Updating Webpack configuration
    • Updating the client-side code
    • Updating the notebook extension
    • Updating the Python code
    • Updating embedded widgets
• ipywidgets changelog
  • 7.7
  • 7.6
    • Updates for Widget Maintainers
  • 7.5
    • Updates for Widget Maintainers
  • 7.4
  • 7.3
  • 7.2
  • 7.1
  • 7.0.x patch releases
  • 7.0
  • 6.0
  • 5.x
  • 4.1.x
    • 4.1.1
    • 4.1.0
  • 4.0.x
    • 4.0.3
    • 4.0.2
    • 4.0.1
    • 4.0.0