Merge remote-tracking branch 'upstream/rc/v11.0.0' into flyout-button…

…-navigation

codelabs/context_menu_option/context_menu_option.md

@@ -67,7 +67,7 @@ Each menu option in the registry has several properties:
 
 - `callback`: A function called when the menu option is clicked.
 - `scopeType`: An enum indicating when this option should be shown.
-- `displayText`: The text to show in the menu. Either a string or a function that returns a string.
+- `displayText`: The text to show in the menu. Either a string, or HTML, or a function that returns either of the former.
 - `preconditionFn`: Function that returns one of `'enabled'`, `'disabled'`, or `'hidden'` to determine whether and how the menu option should be rendered.
 - `weight`: A number that determines the sort order of the option. Options with higher weights appear later in the context menu.
 - `id`: A unique string id for the option.
@@ -282,7 +282,7 @@ callback: function(scope) {
 
 ## Display text
 
-So far the `displayText` has always been a simple string, but it can also be a function that returns a string. This can be useful when you want a context-dependent message.
+So far the `displayText` has always been a simple string, but it can also be HTML, or a function that returns either of the former. Using a function can be useful when you want a context-dependent message.
 
 When defined as a function `displayText` accepts a `scope` argument, just like `callback` and `preconditionFn`.
 

examples/custom-renderer-codelab/src/renderers/custom.js

@@ -10,7 +10,12 @@
 
 import * as Blockly from 'blockly/core';
 
+/**
+ * The ConstantProvider holds rendering-related constants such as colour
+ * and size information.
+ */
 class CustomConstantProvider extends Blockly.blockRendering.ConstantProvider {
+  /** @override */
   constructor() {
     // Set up all of the constants from the base provider.
     super();
@@ -81,7 +86,7 @@ class CustomConstantProvider extends Blockly.blockRendering.ConstantProvider {
   }
 
   /**
-   * @returns Rectangular notch for use with previous and next connections.
+   * @returns {Object} Rectangular notch for use with previous and next connections.
    */
   makeRectangularPreviousConn() {
     const width = this.NOTCH_WIDTH;
@@ -90,8 +95,8 @@ class CustomConstantProvider extends Blockly.blockRendering.ConstantProvider {
     /**
      * Since previous and next connections share the same shape you can define
      * a function to generate the path for both.
-     * @param dir Multiplier for the horizontal direction of the path (-1 or 1)
-     * @returns SVGPath line for use with previous and next connections.
+     * @param {number} dir Multiplier for the horizontal direction of the path (-1 or 1)
+     * @returns {Object} SVGPath line for use with previous and next connections.
      */
     function makeMainPath(dir) {
       return Blockly.utils.svgPaths.line([
@@ -112,7 +117,7 @@ class CustomConstantProvider extends Blockly.blockRendering.ConstantProvider {
   }
 
   /**
-   * @returns Rectangular puzzle tab for use with input and output connections.
+   * @returns {Object} Rectangular puzzle tab for use with input and output connections.
    */
   makeRectangularInputConn() {
     const width = this.TAB_WIDTH;
@@ -121,8 +126,8 @@ class CustomConstantProvider extends Blockly.blockRendering.ConstantProvider {
     /**
      * Since input and output connections share the same shape you can define
      * a function to generate the path for both.
-     * @param dir Multiplier for the vertical direction of the path (-1 or 1)
-     * @returns SVGPath line for use with input and output connections.
+     * @param {number} dir Multiplier for the vertical direction of the path (-1 or 1)
+     * @returns {Object} SVGPath line for use with input and output connections.
      */
     function makeMainPath(dir) {
       return Blockly.utils.svgPaths.line([
@@ -143,7 +148,9 @@ class CustomConstantProvider extends Blockly.blockRendering.ConstantProvider {
   }
 }
 
+/** The CustomRenderer class incorporates our custom ConstantProvider. */
 export class CustomRenderer extends Blockly.blockRendering.Renderer {
+  /** @override */
   constructor() {
     super();
   }

examples/keyboard-navigation-codelab/src/cursors/custom.js

@@ -1,10 +1,13 @@
 import * as Blockly from 'blockly/core';
 
+/** A custom cursor that skips previous and next connections. */
 export class CustomCursor extends Blockly.Cursor {
+  /** @override */
   constructor() {
     super();
   }
 
+  /** @override */
   next() {
     const curNode = this.getCurNode();
     if (!curNode) {
@@ -26,6 +29,7 @@ export class CustomCursor extends Blockly.Cursor {
     return newNode;
   }
 
+  /** @override */
   in() {
     const curNode = this.getCurNode();
     if (!curNode) {
@@ -43,6 +47,7 @@ export class CustomCursor extends Blockly.Cursor {
     return newNode;
   }
 
+  /** @override */
   prev() {
     const curNode = this.getCurNode();
     if (!curNode) {
@@ -64,6 +69,7 @@ export class CustomCursor extends Blockly.Cursor {
     return newNode;
   }
 
+  /** @override */
   out() {
     const curNode = this.getCurNode();
     if (!curNode) {

examples/keyboard-navigation-codelab/src/markers/custom_marker_svg.js

@@ -1,6 +1,8 @@
 import * as Blockly from 'blockly/core';
 
+/** A custom Marker that causes an entire block to flash when marked. */
 class CustomMarkerSvg extends Blockly.blockRendering.MarkerSvg {
+  /** @override */
   constructor(workspace, constants, marker) {
     super(workspace, constants, marker);
   }
@@ -30,6 +32,7 @@ class CustomMarkerSvg extends Blockly.blockRendering.MarkerSvg {
     }
   }
 
+  /** @override */
   showWithBlock_(curNode) {
     // Get the block from the AST Node
     const block = curNode.getLocation();
@@ -78,11 +81,14 @@ class CustomMarkerSvg extends Blockly.blockRendering.MarkerSvg {
   }
 }
 
+/** A renderer that uses our custom marker. */
 class CustomRenderer extends Blockly.geras.Renderer {
+  /** @override */
   constructor(name) {
     super(name);
   }
 
+  /** @override */
   makeMarkerDrawer(workspace, marker) {
     return new CustomMarkerSvg(workspace, this.getConstants(), marker);
   }

gh-pages/_index.html

@@ -148,17 +148,6 @@ <h4>
       </p>
     </div>
   </a>
-  <a class="card" href="plugins/renderer-inline-row-separators/test/index.html">
-    <img srcset="media/inline-inputs.png 2x">
-    <div>
-      <h4>
-        Inline Input Blocks
-      </h4>
-      <p>
-        A custom renderer and example blocks that treat dummy inputs between value inputs as line breaks, rendering the value inputs on separate lines inside of the block.
-      </p>
-    </div>
-  </a>
   <a class="card" href="plugins/block-shareable-procedures/test/index.html">
     <img srcset="media/procedure-blocks.png 2x">
     <div>
@@ -315,7 +304,7 @@ <h4>
         Disable Top Blocks
       </h4>
       <p>
-        A plugin that hides the 'Enable' context menu option for orphan blocks. Works with the <code>Blockly.Events.disableOrphans</code> change listener in core.
+        A plugin that hides the 'Enable' context menu option for orphan blocks. Works with the <code>disableOrphans</code> change listener in core.
       </p>
     </div>
   </a>