Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the custom widget tutorial for JupyterLab 3.0 #3129

Merged
merged 3 commits into from
Mar 10, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions docs/source/examples/Widget Custom.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"To create the environment, execute the following command:\n",
"\n",
"```bash\n",
"conda create -n ipyemail -c conda-forge jupyterlab cookiecutter nodejs python\n",
"conda create -n ipyemail -c conda-forge jupyterlab cookiecutter nodejs yarn python\n",
"```\n",
"\n",
"Then activate the environment with:\n",
Expand Down Expand Up @@ -120,7 +120,26 @@
"\n",
"You also need to enable the widget frontend extension.\n",
"\n",
"If you are using JupyterLab 2.x:\n",
"If you are using JupyterLab 3.x:\n",
"\n",
"\n",
"```bash\n",
"# link your development version of the extension with JupyterLab\n",
"jupyter labextension develop . --overwrite\n",
"\n",
"# rebuild extension Typescript source after making changes\n",
"yarn run build\n",
"```\n",
"\n",
"It is also possible to rebuild the widget automatically when there is a new change, using the `watch` script:\n",
"\n",
"```bash\n",
"# watch the source directory in one terminal, automatically rebuilding when needed\n",
"yarn run watch\n",
"```\n",
"\n",
"\n",
"If you are using JupyterLab 2.x, you will need to install the `@jupyter-widgets/jupyterlab-manager` extension manually:\n",
"\n",
"```bash\n",
"# install the widget manager to display the widgets in JupyterLab\n",
Expand Down Expand Up @@ -802,5 +821,5 @@
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}