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.

Sign up for GitHub

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

updated and added to the plugin descriptions #7093

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

updated and added to the plugin descriptions #7093

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d84e210
updated and added to the plugin descriptions
pettis1996 Oct 6, 2023
a27261a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 6, 2023
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
40 changes: 32 additions & 8 deletions packages/application-extension/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ namespace CommandIDs {
}

/**
* Check if the application is dirty before closing the browser tab.
* Provides a safeguard against accidental loss of unsaved changes
*/
const dirty: JupyterFrontEndPlugin<void> = {
id: '@jupyter-notebook/application-extension:dirty',
Expand Down Expand Up @@ -153,7 +153,7 @@ const dirty: JupyterFrontEndPlugin<void> = {
};

/**
* The logo plugin.
* Adds a Jupyter Notebook logo to the user interface
*/
const logo: JupyterFrontEndPlugin<void> = {
id: '@jupyter-notebook/application-extension:logo',
Expand Down Expand Up @@ -181,7 +181,9 @@ const logo: JupyterFrontEndPlugin<void> = {
};

/**
* A plugin to open documents in the main area.
* Responsible for routing URL requests and opening documents.
* It ensures that when users navigate to specific URLs,
* the associated documents are correctly opened within the notebook interface.
*/
const opener: JupyterFrontEndPlugin<void> = {
id: '@jupyter-notebook/application-extension:opener',
Expand Down Expand Up @@ -249,7 +251,8 @@ const opener: JupyterFrontEndPlugin<void> = {
};

/**
* A plugin to customize menus
* Enables for customization of the menu structure of the the application,
* based on the current page or context.
*/
const menus: JupyterFrontEndPlugin<void> = {
id: '@jupyter-notebook/application-extension:menus',
Expand Down Expand Up @@ -279,7 +282,9 @@ const menus: JupyterFrontEndPlugin<void> = {
};

/**
* A plugin to provide a spacer at rank 900 in the menu area
* Adds a visual separator, or spacer, between menu items,
* helping to group related menu items and improve the overall
* visual clarity of the menu interface.
*/
const menuSpacer: JupyterFrontEndPlugin<void> = {
id: '@jupyter-notebook/application-extension:menu-spacer',
Expand Down Expand Up @@ -348,6 +353,7 @@ const pathOpener: JupyterFrontEndPlugin<INotebookPathOpener> = {

/**
* The default paths for a Jupyter Notebook app.
* This plugin ensures that the paths functionality is available to other extensions or components that may rely on it.
*/
const paths: JupyterFrontEndPlugin<JupyterFrontEnd.IPaths> = {
id: '@jupyter-notebook/application-extension:paths',
Expand All @@ -363,6 +369,8 @@ const paths: JupyterFrontEndPlugin<JupyterFrontEnd.IPaths> = {

/**
* A plugin providing a rendermime registry.
* Responsible for managing and rendering MIME (Multipurpose Internet Mail Extensions)
* types, allowing for the display of various content types within the notebook interface
*/
const rendermime: JupyterFrontEndPlugin<IRenderMimeRegistry> = {
id: '@jupyter-notebook/application-extension:rendermime',
Expand Down Expand Up @@ -435,7 +443,7 @@ const rendermime: JupyterFrontEndPlugin<IRenderMimeRegistry> = {
};

/**
* The default Jupyter Notebook application shell.
* Responsible for defining the default Jupyter Notebook application shell
*/
const shell: JupyterFrontEndPlugin<INotebookShell> = {
id: '@jupyter-notebook/application-extension:shell',
Expand Down Expand Up @@ -946,7 +954,9 @@ const sidePanelVisibility: JupyterFrontEndPlugin<void> = {
};

/**
* The default tree route resolver plugin.
* The default tree route resolver plugin.
* Responsible for handling and resolving routes related to the file tree view.
* It ensures that the application can navigate to specific tree paths and resolve tree-related URLs correctly.
*/
const tree: JupyterFrontEndPlugin<JupyterFrontEnd.ITreeResolver> = {
id: '@jupyter-notebook/application-extension:tree-resolver',
Expand Down Expand Up @@ -1007,6 +1017,11 @@ const tree: JupyterFrontEndPlugin<JupyterFrontEnd.ITreeResolver> = {
},
};

/**
* Responsible for keeping the URL's tree path synchronized with the user's
* actions and selections within the file tree view. Ensures that the URL reflects the current tree path,
* allowing for bookmarking and sharing specific locations within the file tree.
*/
const treePathUpdater: JupyterFrontEndPlugin<ITreePathUpdater> = {
id: '@jupyter-notebook/application-extension:tree-updater',
requires: [IRouter],
Expand All @@ -1029,6 +1044,11 @@ const treePathUpdater: JupyterFrontEndPlugin<ITreePathUpdater> = {
autoStart: true,
};

/**
* Integrates the ITranslator interface with the notebook shell,
* allowing for the translation of user interface elements, labels,
* and descriptions into different languages.
*/
const translator: JupyterFrontEndPlugin<void> = {
id: '@jupyter-notebook/application-extension:translator',
requires: [INotebookShell, ITranslator],
Expand All @@ -1043,7 +1063,11 @@ const translator: JupyterFrontEndPlugin<void> = {
};

/**
* Zen mode plugin
* Zen mode plugin.
* This mode offers a distraction-free and immersive editing environment
* for users who want to focus solely on their notebook content. When activated,
* Zen Mode maximizes the notebook interface, hides menus, and enters fullscreen
* mode.
*/
const zen: JupyterFrontEndPlugin<void> = {
id: '@jupyter-notebook/application-extension:zen',
Expand Down
Loading