https://github.com/mwcraig/ipyevents
A custom widget for returning mouse and keyboard events to Python. Documentation:
https://github.com/mwcraig/ipyevents
jupyter jupyter-widget jupyter-widgets
Last synced: 11 days ago
JSON representation
A custom widget for returning mouse and keyboard events to Python. Documentation:
- Host: GitHub
- URL: https://github.com/mwcraig/ipyevents
- Owner: mwcraig
- License: bsd-3-clause
- Created: 2017-10-28T17:05:25.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T14:07:48.000Z (over 1 year ago)
- Last Synced: 2025-03-29T02:04:48.830Z (18 days ago)
- Topics: jupyter, jupyter-widget, jupyter-widgets
- Language: TypeScript
- Homepage: https://ipyevents.readthedocs.io/en/latest/index.html
- Size: 333 KB
- Stars: 116
- Watchers: 6
- Forks: 27
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-jupyter-widgets - ipyevents - a widget for returning mouse and keyboard events (Interactive Widgets / Interactive Jupyter Widget Ecosystem)
README
# ipyevents
## Browsers events for your jupyter widgets
*ipyevents* provides a custom widget for returning mouse and keyboard events to
Python. Use it to:
- add keyboard shortcuts to an existing widget;
- react to the user clicking on an image;
- add callbacks on arbitrary mouse and keyboard events.
See [this demo notebook](docs/events.ipynb) for documentation.
Special thanks to the [contributors to `ipyevents`](CONTRIBUTORS.md)!
## Try it on binder:
Dev version:
[](https://mybinder.org/v2/gh/mwcraig/ipyevents/HEAD?filepath=docs%2Fevents.ipynb)
## Documentation
[](https://ipyevents.readthedocs.io/en/latest/?badge=latest)
## Installation
To install using `conda`:
```bash
$ conda install -c conda-forge ipyevents
```
To install use `pip`:
$ pip install ipyevents
Using with JupyterLab (whether you installed with `conda` or `pip`):
+ The stable releases of ipyevents (`2.0.0` and higher) are only built for JupyterLab 3 and up.
+ The last release that is built for JupyterLab 2 is 0.9.0. See the [README for that version](https://github.com/mwcraig/ipyevents/tree/0.9.0) for installation instructions.
```bash
$ jupyter labextension install @jupyter-widgets/jupyterlab-manager ipyevents
```
### For a development installation (requires npm),
```bash
$ git clone https://github.com/mwcraig/ipyevents.git
$ cd ipyevents
$ pip install -e .
$ jupyter nbextension install --py --symlink --sys-prefix ipyevents
$ jupyter nbextension enable --py --sys-prefix ipyevents
```
For Jupyter Lab also do this:
```bash
$ npm install
$ npm run build
$ jupyter labextension install
```