You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|**Communication**|[](https://gitter.im/jupyter-widgets/Lobby)[](https://discourse.jupyter.org/)|
8
+
|||
8
9
9
-
ipywidgets are [interactive HTML widgets](https://github.com/jupyter-widgets/ipywidgets/blob/master/docs/source/examples/Index.ipynb)
10
-
for Jupyter notebooks, JupyterLab and the IPython kernel.
10
+
**ipywidgets**, also known as jupyter-widgets or simply are [interactive HTML widgets](https://github.com/jupyter-widgets/ipywidgets/blob/master/docs/source/examples/Index.ipynb)
11
+
for Jupyter notebooks and the IPython kernel.
11
12
12
13
Notebooks come alive when interactive widgets are used. Users gain control of
13
14
their data and can visualize changes in the data.
@@ -18,7 +19,9 @@ ipywidgets to your notebooks, and we're here to help you get started.
18
19
19
20
## Core Interactive Widgets
20
21
21
-
A [demonstration notebook](https://github.com/jupyter-widgets/ipywidgets/blob/master/docs/source/examples/Index.ipynb) provides an overview of the core interactive widgets, including:
22
+
The fundamental widgets provided by this library are called core interactive
23
+
widgets. A [demonstration notebook](https://github.com/jupyter-widgets/ipywidgets/blob/master/docs/source/examples/Index.ipynb)
24
+
provides an overview of the core interactive widgets, including:
22
25
23
26
- sliders
24
27
- progress bars
@@ -30,28 +33,27 @@ A [demonstration notebook](https://github.com/jupyter-widgets/ipywidgets/blob/ma
30
33
## Jupyter Interactive Widgets as a Framework
31
34
32
35
Besides the widgets already provided with the library, the framework can be
33
-
extended with custom widget libraries.
36
+
extended with the development of **custom widget libraries**. For detailed
37
+
information, please refer to the [ipywidgets documentation](https://ipywidgets.readthedocs.io/en/latest/).
34
38
35
-
A template project is available in the form of a cookie cutter [here](https://github.com/jupyter-widgets/widget-ts-cookiecutter).
39
+
### Cookiecutter template for custom widget development
36
40
37
-
This project is meant to help custom widget authors get started with the
38
-
packaging and the distribution of Jupyter interactive widgets.
39
-
40
-
It produces a project for a Jupyter interactive widget library following the
41
-
current best practices for using interactive widgets. An implementation for a
42
-
placeholder "Hello World" widget is provided.
41
+
A template project for building custom widgets is available as a
- Install the front-end extension to JupyterLab (note that this requires nodejs to be installed):
85
+
### Front-end extension for JupyterLab
82
86
83
-
* For JupyterLab 1.0.x and 1.1.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
84
-
* For JupyterLab 1.2.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
85
-
* For JupyterLab 2.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
87
+
Install the front-end extension to JupyterLab (note that this requires nodejs
88
+
to be installed):
86
89
87
-
See the [Installation](docs/source/user_install.md) section of the documentation for additional details.
90
+
- For JupyterLab 1.0.x and 1.1.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
91
+
- For JupyterLab 1.2.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
92
+
- For JupyterLab 2.x, use `jupyter labextension install @jupyter-widgets/[email protected]`
88
93
89
-
### Installing from git
94
+
See the [Installation](docs/source/user_install.md) section of the documentation
95
+
for additional details.
90
96
91
-
If you want to install ipywidgets from git, **you will need the
92
-
[yarn](https://yarnpkg.com/) package manager version 1.2.1 or later**.
93
-
Installing from git is more complicated and requires a developer install, see the [developer install](docs/source/dev_install.md) instructions.
97
+
### Developer install from source
98
+
99
+
Installing from source is more complicated and requires a developer install,
100
+
see the detailed [developer install](docs/source/dev_install.md) instructions.
94
101
102
+
If you want to install ipywidgets from source, **you will need the
103
+
[yarn](https://yarnpkg.com/) package manager version 1.2.1 or later**.
95
104
To install the latest master version from the root directory of the source
96
-
code, run ``dev-install.sh``. To only build the Python package enter ``pip install -e .``.
105
+
code, run ``dev-install.sh``. To only build the Python package enter
106
+
``pip install -e .``.
107
+
108
+
## Usage
97
109
98
-
#### Compatibility
110
+
See the [examples](docs/source/examples.md) section of the documentation. The widgets are being used in a variety of ways; some uses can be seen in these notebooks:
111
+
[Demo notebook of interactive widgets](https://github.com/jupyter-widgets/ipywidgets/blob/master/docs/source/examples/Index.ipynb)
99
112
100
-
| ipywidgets version | Required notebook version |
See the [examples](docs/source/examples.md) section of the documentation. The widgets are being used in a variety of ways; some uses can be seen in these notebooks:
119
+
Refer to change log for more detail.
112
120
113
-
-[Demo notebook of interactive widgets](https://github.com/jupyter-widgets/ipywidgets/blob/master/docs/source/examples/Index.ipynb)
@@ -126,6 +142,7 @@ See the [LICENSE](LICENSE) file in this repository for details.
126
142
## Project Jupyter resources
127
143
128
144
-[Project Jupyter website](https://jupyter.org)
129
-
-[Online Demo of Jupyter Notebook at try.jupyter.org](https://try.jupyter.org)
145
+
-[Online Demo at try.jupyter.org](https://try.jupyter.org)
130
146
-[Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html)[[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]
0 commit comments