index.rst

IDOM

Libraries for defining and controlling interactive webpages with Python 3.7 and above.

.. toctree::
    :hidden:
    :caption: User Guide

    installation
    getting-started
    life-cycle-hooks
    core-concepts
    custom-javascript
    examples

.. toctree::
    :hidden:
    :caption: Reference

    GitHub <https://github.com/idom-team/idom>
    package-api
    specifications
    extra-features

Early Days

IDOM is still young. Be sure to post any issues you have or contribute by creating a pull request.

At a Glance

Let's use IDOM to create a simple slideshow which changes whenever a user clicks an image:

.. example:: slideshow

Try selecting the "Live Example" tab in the view above and enabling the widget.

Once activated try clicking the displayed image to make it change 🖱️

Note

You can display the same thing in a Jupyter Notebook by installing idom-jupyter:

pip install idom-jupyter

And replacing idom.run with idom_jupyter.run:

import idom_jupyter
idom_jupyter.run(Slideshow)

Try it out on Binder now: