interface.rst 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. .. _interface:
  2. The JupyterLab Interface
  3. ========================
  4. JupyterLab provides flexible building blocks for interactive,
  5. exploratory computing. While JupyterLab has many features found in
  6. traditional integrated development environments (IDEs), it remains
  7. focused on interactive, exploratory computing.
  8. The JupyterLab interface consists of a :ref:`main work area <main-area>`
  9. containing tabs of documents and activities, a collapsible :ref:`left sidebar
  10. <left-sidebar>`, and a :ref:`menu bar <menu-bar>`. The left sidebar contains a
  11. :ref:`file browser <working-with-files>`, the :ref:`list of running kernels and
  12. terminals <running>`, the :ref:`command palette <commands>`, the :ref:`notebook
  13. cell tools inspector <notebook>`, and the :ref:`tabs list <tabs>`.
  14. .. image:: images/interface_jupyterlab.png
  15. :align: center
  16. :class: jp-screenshot
  17. JupyterLab sessions always reside in a :ref:`workspace <url-workspaces-ui>`.
  18. Workspaces contain the state of JupyterLab: the files that are currently open,
  19. the layout of the application areas and tabs, etc.
  20. Workspaces can be saved on the server with
  21. :ref:`named workspace URLs <url-workspaces-ui>`.
  22. To learn more about URLs in Jupyterlab, visit :ref:`urls`.
  23. .. _menu-bar:
  24. Menu Bar
  25. --------
  26. The menu bar at the top of JupyterLab has top-level menus that expose
  27. actions available in JupyterLab with their keyboard shortcuts. The
  28. default menus are:
  29. - **File**: actions related to files and directories
  30. - **Edit**: actions related to editing documents and other activities
  31. - **View**: actions that alter the appearance of JupyterLab
  32. - **Run**: actions for running code in different activities such as
  33. notebooks and code consoles
  34. - **Kernel**: actions for managing kernels, which are separate processes
  35. for running code
  36. - **Tabs**: a list of the open documents and activities in the dock panel
  37. - **Settings**: common settings and an advanced settings editor
  38. - **Help**: a list of JupyterLab and kernel help links
  39. :ref:`JupyterLab extensions <user_extensions>` can also create new top-level menus in the menu
  40. bar.
  41. .. _left-sidebar:
  42. Left Sidebar
  43. ------------
  44. The left sidebar contains a number of commonly-used tabs, such as a file
  45. browser, a list of running kernels and terminals, the command palette,
  46. and a list of tabs in the main work area:
  47. .. image:: images/interface_left.png
  48. :align: center
  49. :class: jp-screenshot
  50. .. _left-sidebar-toggle:
  51. The left sidebar can be collapsed or expanded by selecting "Show Left Sidebar"
  52. in the View menu or by clicking on the active sidebar tab:
  53. .. raw:: html
  54. <div class="jp-youtube-video">
  55. <iframe src="https://www.youtube-nocookie.com/embed/PlJGecfetek?rel=0&amp;showinfo=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
  56. </div>
  57. JupyterLab extensions can add additional panels to the left sidebar.
  58. .. _main-area:
  59. Main Work Area
  60. --------------
  61. .. _main-area-vid:
  62. The main work area in JupyterLab enables you to arrange documents (notebooks,
  63. text files, etc.) and other activities (terminals, code consoles, etc.) into
  64. panels of tabs that can be resized or subdivided. Drag a tab to the center of a
  65. tab panel to move the tab to the panel. Subdivide a tab panel by dragging a tab to
  66. the left, right, top, or bottom of the panel:
  67. .. raw:: html
  68. <div class="jp-youtube-video">
  69. <iframe src="https://www.youtube-nocookie.com/embed/Ka8qS7CO1XQ?rel=0&amp;showinfo=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
  70. </div>
  71. The work area has a single current activity. The tab for the current activity is
  72. marked with a colored top border (blue by default).
  73. .. _tabs:
  74. Tabs and Simple Interface Mode
  75. ------------------------------
  76. The Tabs panel in the left sidebar lists the open documents or
  77. activities in the main work area:
  78. .. image:: images/interface_tabs.png
  79. :align: center
  80. :class: jp-screenshot
  81. The same information is also available in the Tabs menu:
  82. .. image:: images/interface_tabs_menu.png
  83. :align: center
  84. :class: jp-screenshot
  85. .. _tabs-singledocument:
  86. It is often useful to focus on a single document or activity without closing
  87. other tabs in the main work area. Simple Interface mode enables this, while making
  88. it easy to return to your multi-activity layout in the main work area.
  89. Toggle Simple Interface mode using the View menu:
  90. .. raw:: html
  91. <div class="jp-youtube-video">
  92. <iframe src="https://www.youtube-nocookie.com/embed/DO7NOenMQC0?rel=0&amp;showinfo=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
  93. </div>
  94. When you leave Simple Interface mode, the original layout of the main
  95. area is restored.
  96. Context Menus
  97. -------------
  98. .. _context-menus-rightclick:
  99. Many parts of JupyterLab, such as notebooks, text files, code consoles,
  100. and tabs, have context menus that can be accessed by right-clicking on
  101. the element:
  102. .. raw:: html
  103. <div class="jp-youtube-video">
  104. <iframe src="https://www.youtube-nocookie.com/embed/y30fs6kg6fc?rel=0&amp;showinfo=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
  105. </div>
  106. .. _context-menus-shiftrightclick:
  107. The browser’s native context menu can be accessed by holding down
  108. ``Shift`` and right-clicking:
  109. .. raw:: html
  110. <div class="jp-youtube-video">
  111. <iframe src="https://www.youtube-nocookie.com/embed/XPPWW-7WJ40?rel=0&amp;showinfo=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
  112. </div>
  113. .. _shortcuts:
  114. Keyboard Shortcuts
  115. ------------------
  116. .. _shortcuts-settings:
  117. As in the classic Notebook, you can navigate the user interface through keyboard
  118. shortcuts. You can find and customize the current list of keyboard shortcuts by
  119. selecting the Advanced Settings Editor item in the Settings menu, then selecting
  120. Keyboard Shortcuts in the Settings tab.
  121. .. raw:: html
  122. <div class="jp-youtube-video">
  123. <iframe src="https://www.youtube-nocookie.com/embed/rhW3kAExCik?rel=0&amp;showinfo=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
  124. </div>
  125. .. _editor-keymaps:
  126. You can also customize the :ref:`text editor <file-editor>` to use vim, emacs, or Sublime Text
  127. keyboard maps by using the Text Editor Key Map submenu in the Settings
  128. menu:
  129. .. raw:: html
  130. <div class="jp-youtube-video">
  131. <iframe src="https://www.youtube-nocookie.com/embed/COheO7sA4-U?rel=0&amp;showinfo=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
  132. </div>