blockly 8.0.4 → 8.0.5-beta.0

package/core/utils/aria.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * ARIA role values.
+ * Copied from Closure's goog.a11y.aria.Role
+ * @alias Blockly.utils.aria.Role
+ */
+export declare enum Role {
+    GRID = "grid",
+    GRIDCELL = "gridcell",
+    GROUP = "group",
+    LISTBOX = "listbox",
+    MENU = "menu",
+    MENUITEM = "menuitem",
+    MENUITEMCHECKBOX = "menuitemcheckbox",
+    OPTION = "option",
+    PRESENTATION = "presentation",
+    ROW = "row",
+    TREE = "tree",
+    TREEITEM = "treeitem"
+}
+/**
+ * ARIA states and properties.
+ * Copied from Closure's goog.a11y.aria.State
+ * @alias Blockly.utils.aria.State
+ */
+export declare enum State {
+    ACTIVEDESCENDANT = "activedescendant",
+    COLCOUNT = "colcount",
+    DISABLED = "disabled",
+    EXPANDED = "expanded",
+    INVALID = "invalid",
+    LABEL = "label",
+    LABELLEDBY = "labelledby",
+    LEVEL = "level",
+    ORIENTATION = "orientation",
+    POSINSET = "posinset",
+    ROWCOUNT = "rowcount",
+    SELECTED = "selected",
+    SETSIZE = "setsize",
+    VALUEMAX = "valuemax",
+    VALUEMIN = "valuemin"
+}
+/**
+ * Sets the role of an element.
+ *
+ * Similar to Closure's goog.a11y.aria
+ *
+ * @param element DOM node to set role of.
+ * @param roleName Role name.
+ * @alias Blockly.utils.aria.setRole
+ */
+export declare function setRole(element: Element, roleName: Role): void;
+/**
+ * Sets the state or property of an element.
+ * Copied from Closure's goog.a11y.aria
+ * @param element DOM node where we set state.
+ * @param stateName State attribute being set.
+ *     Automatically adds prefix 'aria-' to the state name if the attribute is
+ * not an extra attribute.
+ * @param value Value for the state attribute.
+ * @alias Blockly.utils.aria.setState
+ */
+export declare function setState(element: Element, stateName: State, value: string | boolean | number | string[]): void;

package/core/utils/{aria.js → aria.ts}

@@ -9,7 +9,6 @@
  * These methods are not specific to Blockly, and could be factored out into
  * a JavaScript framework such as Closure.
  */
-'use strict';
 
 /**
  * ARIA-related constants and utilities.
@@ -17,7 +16,8 @@
  * a JavaScript framework such as Closure.
  * @namespace Blockly.utils.aria
  */
-goog.module('Blockly.utils.aria');
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.aria');
 
 
 /** ARIA states/properties prefix. */
@@ -29,146 +29,132 @@ const ROLE_ATTRIBUTE = 'role';
 /**
  * ARIA role values.
  * Copied from Closure's goog.a11y.aria.Role
- * @enum {string}
  * @alias Blockly.utils.aria.Role
  */
-const Role = {
+export enum Role {
   // ARIA role for an interactive control of tabular data.
-  GRID: 'grid',
+  GRID = 'grid',
 
   // ARIA role for a cell in a grid.
-  GRIDCELL: 'gridcell',
-
+  GRIDCELL = 'gridcell',
   // ARIA role for a group of related elements like tree item siblings.
-  GROUP: 'group',
+  GROUP = 'group',
 
   // ARIA role for a listbox.
-  LISTBOX: 'listbox',
+  LISTBOX = 'listbox',
 
   // ARIA role for a popup menu.
-  MENU: 'menu',
+  MENU = 'menu',
 
   // ARIA role for menu item elements.
-  MENUITEM: 'menuitem',
-
+  MENUITEM = 'menuitem',
   // ARIA role for a checkbox box element inside a menu.
-  MENUITEMCHECKBOX: 'menuitemcheckbox',
-
+  MENUITEMCHECKBOX = 'menuitemcheckbox',
   // ARIA role for option items that are  children of combobox, listbox, menu,
   // radiogroup, or tree elements.
-  OPTION: 'option',
-
+  OPTION = 'option',
   // ARIA role for ignorable cosmetic elements with no semantic significance.
-  PRESENTATION: 'presentation',
+  PRESENTATION = 'presentation',
 
   // ARIA role for a row of cells in a grid.
-  ROW: 'row',
-
+  ROW = 'row',
   // ARIA role for a tree.
-  TREE: 'tree',
+  TREE = 'tree',
 
   // ARIA role for a tree item that sometimes may be expanded or collapsed.
-  TREEITEM: 'treeitem',
-};
-exports.Role = Role;
+  TREEITEM = 'treeitem'
+}
 
 /**
  * ARIA states and properties.
  * Copied from Closure's goog.a11y.aria.State
- * @enum {string}
  * @alias Blockly.utils.aria.State
  */
-const State = {
+export enum State {
   // ARIA property for setting the currently active descendant of an element,
   // for example the selected item in a list box. Value: ID of an element.
-  ACTIVEDESCENDANT: 'activedescendant',
-
+  ACTIVEDESCENDANT = 'activedescendant',
   // ARIA property defines the total number of columns in a table, grid, or
   // treegrid.
   // Value: integer.
-  COLCOUNT: 'colcount',
-
+  COLCOUNT = 'colcount',
   // ARIA state for a disabled item. Value: one of {true, false}.
-  DISABLED: 'disabled',
+  DISABLED = 'disabled',
 
   // ARIA state for setting whether the element like a tree node is expanded.
   // Value: one of {true, false, undefined}.
-  EXPANDED: 'expanded',
+  EXPANDED = 'expanded',
 
   // ARIA state indicating that the entered value does not conform. Value:
   // one of {false, true, 'grammar', 'spelling'}
-  INVALID: 'invalid',
+  INVALID = 'invalid',
 
   // ARIA property that provides a label to override any other text, value, or
   // contents used to describe this element. Value: string.
-  LABEL: 'label',
-
+  LABEL = 'label',
   // ARIA property for setting the element which labels another element.
   // Value: space-separated IDs of elements.
-  LABELLEDBY: 'labelledby',
+  LABELLEDBY = 'labelledby',
 
   // ARIA property for setting the level of an element in the hierarchy.
   // Value: integer.
-  LEVEL: 'level',
-
+  LEVEL = 'level',
   // ARIA property indicating if the element is horizontal or vertical.
   // Value: one of {'vertical', 'horizontal'}.
-  ORIENTATION: 'orientation',
+  ORIENTATION = 'orientation',
 
   // ARIA property that defines an element's number of position in a list.
   // Value: integer.
-  POSINSET: 'posinset',
+  POSINSET = 'posinset',
 
   // ARIA property defines the total number of rows in a table, grid, or
   // treegrid.
   // Value: integer.
-  ROWCOUNT: 'rowcount',
+  ROWCOUNT = 'rowcount',
 
   // ARIA state for setting the currently selected item in the list.
   // Value: one of {true, false, undefined}.
-  SELECTED: 'selected',
-
+  SELECTED = 'selected',
   // ARIA property defining the number of items in a list. Value: integer.
-  SETSIZE: 'setsize',
+  SETSIZE = 'setsize',
 
   // ARIA property for slider maximum value. Value: number.
-  VALUEMAX: 'valuemax',
+  VALUEMAX = 'valuemax',
 
   // ARIA property for slider minimum value. Value: number.
-  VALUEMIN: 'valuemin',
-};
-exports.State = State;
+  VALUEMIN = 'valuemin'
+}
 
 /**
  * Sets the role of an element.
  *
  * Similar to Closure's goog.a11y.aria
  *
- * @param {!Element} element DOM node to set role of.
- * @param {!Role} roleName Role name.
+ * @param element DOM node to set role of.
+ * @param roleName Role name.
  * @alias Blockly.utils.aria.setRole
  */
-const setRole = function(element, roleName) {
+export function setRole(element: Element, roleName: Role) {
   element.setAttribute(ROLE_ATTRIBUTE, roleName);
-};
-exports.setRole = setRole;
+}
 
 /**
  * Sets the state or property of an element.
  * Copied from Closure's goog.a11y.aria
- * @param {!Element} element DOM node where we set state.
- * @param {!State} stateName State attribute being set.
+ * @param element DOM node where we set state.
+ * @param stateName State attribute being set.
  *     Automatically adds prefix 'aria-' to the state name if the attribute is
- *     not an extra attribute.
- * @param {string|boolean|number|!Array<string>} value Value
- * for the state attribute.
+ * not an extra attribute.
+ * @param value Value for the state attribute.
  * @alias Blockly.utils.aria.setState
  */
-const setState = function(element, stateName, value) {
+export function setState(
+    element: Element, stateName: State, value: string|boolean|number|string[]) {
   if (Array.isArray(value)) {
     value = value.join(' ');
   }
   const attrStateName = ARIA_PREFIX + stateName;
-  element.setAttribute(attrStateName, value);
-};
-exports.setState = setState;
+  // AnyDuringMigration because:  Argument of type 'string | number | boolean'
+  // is not assignable to parameter of type 'string'.
+  element.setAttribute(attrStateName, value as AnyDuringMigration);
+}

package/core/utils/array.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Removes the first occurrence of a particular value from an array.
+ * @param arr Array from which to remove value.
+ * @param value Value to remove.
+ * @return True if an element was removed.
+ * @alias Blockly.array.removeElem
+ * @internal
+ */
+export declare function removeElem(arr: any[], value: any): boolean;

package/core/utils/{array.js → array.ts}

@@ -7,28 +7,26 @@
 /**
  * @fileoverview Utility methods related to arrays.
  */
-'use strict';
 
-/**
- * @namespace Blockly.utils.array
- */
-goog.module('Blockly.utils.array');
+/** @namespace Blockly.utils.array */
+import * as goog from '../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.utils.array');
 
 
 /**
  * Removes the first occurrence of a particular value from an array.
- * @param {!Array} arr Array from which to remove value.
- * @param {*} value Value to remove.
- * @return {boolean} True if an element was removed.
+ * @param arr Array from which to remove value.
+ * @param value Value to remove.
+ * @return True if an element was removed.
  * @alias Blockly.array.removeElem
- * @package
+ * @internal
  */
-const removeElem = function(arr, value) {
+export function removeElem(
+    arr: AnyDuringMigration[], value: AnyDuringMigration): boolean {
   const i = arr.indexOf(value);
   if (i === -1) {
     return false;
   }
   arr.splice(i, 1);
   return true;
-};
-exports.removeElem = removeElem;
+}

package/core/utils/colour.d.ts

@@ -0,0 +1,103 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Get the richness of block colours, regardless of the hue.
+ * @alias Blockly.utils.colour.getHsvSaturation
+ * @return The current richness.
+ * @internal
+ */
+export declare function getHsvSaturation(): number;
+/**
+ * Set the richness of block colours, regardless of the hue.
+ * @param newSaturation The new richness, in the range of  0 (inclusive) to 1
+ *     (exclusive)
+ * @alias Blockly.utils.colour.setHsvSaturation
+ * @internal
+ */
+export declare function setHsvSaturation(newSaturation: number): void;
+/**
+ * Get the intensity of block colours, regardless of the hue.
+ * @alias Blockly.utils.colour.getHsvValue
+ * @return The current intensity.
+ * @internal
+ */
+export declare function getHsvValue(): number;
+/**
+ * Set the intensity of block colours, regardless of the hue.
+ * @param newValue The new intensity, in the range of  0 (inclusive) to 1
+ *     (exclusive)
+ * @alias Blockly.utils.colour.setHsvValue
+ * @internal
+ */
+export declare function setHsvValue(newValue: number): void;
+/**
+ * Parses a colour from a string.
+ * .parse('red') -> '#ff0000'
+ * .parse('#f00') -> '#ff0000'
+ * .parse('#ff0000') -> '#ff0000'
+ * .parse('0xff0000') -> '#ff0000'
+ * .parse('rgb(255, 0, 0)') -> '#ff0000'
+ * @param str Colour in some CSS format.
+ * @return A string containing a hex representation of the colour, or null if
+ *     can't be parsed.
+ * @alias Blockly.utils.colour.parse
+ */
+export declare function parse(str: string | number): string | null;
+/**
+ * Converts a colour from RGB to hex representation.
+ * @param r Amount of red, int between 0 and 255.
+ * @param g Amount of green, int between 0 and 255.
+ * @param b Amount of blue, int between 0 and 255.
+ * @return Hex representation of the colour.
+ * @alias Blockly.utils.colour.rgbToHex
+ */
+export declare function rgbToHex(r: number, g: number, b: number): string;
+/**
+ * Converts a colour to RGB.
+ * @param colour String representing colour in any colour format ('#ff0000',
+ *     'red', '0xff000', etc).
+ * @return RGB representation of the colour.
+ * @alias Blockly.utils.colour.hexToRgb
+ */
+export declare function hexToRgb(colour: string): number[];
+/**
+ * Converts an HSV triplet to hex representation.
+ * @param h Hue value in [0, 360].
+ * @param s Saturation value in [0, 1].
+ * @param v Brightness in [0, 255].
+ * @return Hex representation of the colour.
+ * @alias Blockly.utils.colour.hsvToHex
+ */
+export declare function hsvToHex(h: number, s: number, v: number): string;
+/**
+ * Blend two colours together, using the specified factor to indicate the
+ * weight given to the first colour.
+ * @param colour1 First colour.
+ * @param colour2 Second colour.
+ * @param factor The weight to be given to colour1 over colour2.
+ *     Values should be in the range [0, 1].
+ * @return Combined colour represented in hex.
+ * @alias Blockly.utils.colour.blend
+ */
+export declare function blend(colour1: string, colour2: string, factor: number): string | null;
+/**
+ * A map that contains the 16 basic colour keywords as defined by W3C:
+ * https://www.w3.org/TR/2018/REC-css-color-3-20180619/#html4
+ * The keys of this map are the lowercase "readable" names of the colours,
+ * while the values are the "hex" values.
+ *
+ * @alias Blockly.utils.colour.names
+ */
+export declare const names: {
+    [key: string]: string;
+};
+/**
+ * Convert a hue (HSV model) into an RGB hex triplet.
+ * @param hue Hue on a colour wheel (0-360).
+ * @return RGB code, e.g. '#5ba65b'.
+ * @alias Blockly.utils.colour.hueToHex
+ */
+export declare function hueToHex(hue: number): string;