Merge pull request #117 from kgoo124/localization-kernel-messaging

Localization for kernel-messaging example

Author: jtpio

advanced/kernel-messaging/README.md

@@ -36,7 +36,7 @@ Jupyterlab provides a class `SessionContext`
 that manages a single kernel session. Here is the code to initialize such session:
 
 ```ts
-// src/panel.ts#L33-L37
+// src/panel.ts#L41-L45
 
 this._sessionContext = new SessionContext({
   sessionManager: manager.sessions,
@@ -46,7 +46,7 @@ this._sessionContext = new SessionContext({
 ```
 
 <!-- prettier-ignore-start -->
-<!-- embedme src/panel.ts#L43-L54 -->
+<!-- embedme src/panel.ts#L51-L62 -->
 
 ```ts
 void this._sessionContext
@@ -68,7 +68,7 @@ The session manager object is
 provided directly by the JupyterLab application:
 
 ```ts
-// src/index.ts#L48-L48
+// src/index.ts#L52-L52
 
 const manager = app.serviceManager;
 ```
@@ -81,14 +81,16 @@ to free the kernel session resources if the panel is closed. The whole adapted
 panel class looks like this:
 
 ```ts
-// src/panel.ts#L25-L74
+// src/panel.ts#L31-L85
 
 export class ExamplePanel extends StackedPanel {
-  constructor(manager: ServiceManager.IManager) {
+  constructor(manager: ServiceManager.IManager, translator?: ITranslator) {
     super();
+    this._translator = translator || nullTranslator;
+    this._trans = this._translator.load('jupyterlab');
     this.addClass(PANEL_CLASS);
     this.id = 'kernel-messaging-panel';
-    this.title.label = 'Kernel Messaging Example View';
+    this.title.label = this._trans.__('Kernel Messaging Example View');
     this.title.closable = true;
 
     this._sessionContext = new SessionContext({
@@ -132,6 +134,9 @@ export class ExamplePanel extends StackedPanel {
   private _model: KernelModel;
   private _sessionContext: SessionContext;
   private _example: KernelView;
+
+  private _translator: ITranslator;
+  private _trans: TranslationBundle;
 }
 ```
 

advanced/kernel-messaging/package.json

@@ -42,10 +42,11 @@
     "watch:src": "tsc -w"
   },
   "dependencies": {
-    "@jupyterlab/application": "~3.0.0-beta.4",
-    "@jupyterlab/launcher": "~3.0.0-beta.4",
-    "@jupyterlab/mainmenu": "~3.0.0-beta.4",
-    "@jupyterlab/nbformat": "~3.0.0-beta.4",
+    "@jupyterlab/application": "^3.0.0-beta.8",
+    "@jupyterlab/launcher": "^3.0.0-beta.8",
+    "@jupyterlab/mainmenu": "^3.0.0-beta.8",
+    "@jupyterlab/nbformat": "^3.0.0-beta.8",
+    "@jupyterlab/translation": "^3.0.0-beta.8",
     "@lumino/algorithm": "^1.3.3",
     "@lumino/coreutils": "^1.5.3",
     "@lumino/datagrid": "^0.5.2",

advanced/kernel-messaging/src/index.ts

@@ -9,6 +9,8 @@ import { ILauncher } from '@jupyterlab/launcher';
 
 import { IMainMenu } from '@jupyterlab/mainmenu';
 
+import { ITranslator } from '@jupyterlab/translation';
+
 import { Menu } from '@lumino/widgets';
 
 import { ExamplePanel } from './panel';
@@ -27,27 +29,30 @@ const extension: JupyterFrontEndPlugin<void> = {
   id: 'kernel-messaging',
   autoStart: true,
   optional: [ILauncher],
-  requires: [ICommandPalette, IMainMenu],
+  requires: [ICommandPalette, IMainMenu, ITranslator],
   activate: activate
 };
 
 /**
  * Activate the JupyterLab extension.
  *
- * @param app Jupyter Font End
+ * @param app Jupyter Front End
  * @param palette Jupyter Commands Palette
  * @param mainMenu Jupyter Menu
+ * @param translator Jupyter Translator
  * @param launcher [optional] Jupyter Launcher
  */
 function activate(
   app: JupyterFrontEnd,
   palette: ICommandPalette,
   mainMenu: IMainMenu,
+  translator: ITranslator,
   launcher: ILauncher | null
 ): void {
   const manager = app.serviceManager;
   const { commands, shell } = app;
   const category = 'Extension Examples';
+  const trans = translator.load('jupyterlab');
 
   // Add launcher
   if (launcher) {
@@ -63,20 +68,20 @@ function activate(
    * @returns The panel
    */
   async function createPanel(): Promise<ExamplePanel> {
-    const panel = new ExamplePanel(manager);
+    const panel = new ExamplePanel(manager, translator);
     shell.add(panel, 'main');
     return panel;
   }
 
   // add menu tab
   const exampleMenu = new Menu({ commands });
-  exampleMenu.title.label = 'Kernel Messaging';
+  exampleMenu.title.label = trans.__('Kernel Messaging');
   mainMenu.addMenu(exampleMenu);
 
   // add commands to registry
   commands.addCommand(CommandIDs.create, {
-    label: 'Open the Kernel Messaging Panel',
-    caption: 'Open the Kernel Messaging Panel',
+    label: trans.__('Open the Kernel Messaging Panel'),
+    caption: trans.__('Open the Kernel Messaging Panel'),
     execute: createPanel
   });
 

advanced/kernel-messaging/src/panel.ts

@@ -4,6 +4,12 @@ import {
   sessionContextDialogs
 } from '@jupyterlab/apputils';
 
+import {
+  ITranslator,
+  nullTranslator,
+  TranslationBundle
+} from '@jupyterlab/translation';
+
 import { ServiceManager } from '@jupyterlab/services';
 
 import { Message } from '@lumino/messaging';
@@ -23,11 +29,13 @@ const PANEL_CLASS = 'jp-RovaPanel';
  * A panel which has the ability to add other children.
  */
 export class ExamplePanel extends StackedPanel {
-  constructor(manager: ServiceManager.IManager) {
+  constructor(manager: ServiceManager.IManager, translator?: ITranslator) {
     super();
+    this._translator = translator || nullTranslator;
+    this._trans = this._translator.load('jupyterlab');
     this.addClass(PANEL_CLASS);
     this.id = 'kernel-messaging-panel';
-    this.title.label = 'Kernel Messaging Example View';
+    this.title.label = this._trans.__('Kernel Messaging Example View');
     this.title.closable = true;
 
     this._sessionContext = new SessionContext({
@@ -71,4 +79,7 @@ export class ExamplePanel extends StackedPanel {
   private _model: KernelModel;
   private _sessionContext: SessionContext;
   private _example: KernelView;
+
+  private _translator: ITranslator;
+  private _trans: TranslationBundle;
 }