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

Document how to use React #6595

Merged
merged 7 commits into from Jun 21, 2019
Merged

Document how to use React #6595

merged 7 commits into from Jun 21, 2019

Conversation

@saulshanabrook
Copy link
Member

@saulshanabrook saulshanabrook commented Jun 17, 2019

I had a go at writing up how we are using React inside JupyterLab.

Happy for any suggestions here.

References

Closes #5215 and #5875

Code changes

User-facing changes

Rewrites virtualdom doc to explain how to use React in JupyterLab.

Backwards-incompatible changes

None.

@saulshanabrook saulshanabrook added this to the 1.0 milestone Jun 17, 2019
@jupyterlab-dev-mode
Copy link

@jupyterlab-dev-mode jupyterlab-dev-mode bot commented Jun 17, 2019

Thanks for making a pull request to JupyterLab!

To try out this branch on binder, follow this link: Binder

@saulshanabrook
Copy link
Member Author

@saulshanabrook saulshanabrook commented Jun 17, 2019

cc @gnestor if you wanna take a look and have time.

ivanov
ivanov approved these changes Jun 17, 2019
Copy link
Member

@ivanov ivanov left a comment

We also talked in person about not linking to specific commits in the tree, and instead pointing to the files with a mention of createSearchOverlay for searchoverlay.tsx

docs/source/developer/extension_dev.rst Outdated Show resolved Hide resolved
@saulshanabrook
Copy link
Member Author

@saulshanabrook saulshanabrook commented Jun 17, 2019

This is failing to build because Sphinx recently started raising an error for syntax that could be parsed by pygments and pygments fails to parse JSX/TSX properly.

It seems like they added a warn flag you can set to True to only warn on this, instead of raising an error, but I am unable to figure out how to enable it on the code blocks sphinx-doc/sphinx#1565 (comment)

Copy link
Collaborator

@tslaton tslaton left a comment

Left some comments. Let me know what you all think.

docs/source/developer/virtualdom.create.tsx Show resolved Hide resolved
docs/source/developer/virtualdom.create.tsx Outdated Show resolved Hide resolved
@saulshanabrook
Copy link
Member Author

@saulshanabrook saulshanabrook commented Jun 19, 2019

Thanks @tslaton for the review. I think the test failure is unrelated, so this is good to go.

Copy link
Contributor

@gnestor gnestor left a comment

This is helpful, thanks for working on this 👍

@ellisonbg ellisonbg merged commit d44df20 into jupyterlab:master Jun 21, 2019
7 of 9 checks passed
@lock
Copy link

@lock lock bot commented Aug 6, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related discussion.

@lock lock bot locked as resolved and limited conversation to collaborators Aug 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

6 participants