blockly @ 2.20190722.0

This release is our first major version bump. The next release will also be a major version bump, after which we should go back to regularly scheduled minor bumps.

If you're using Blockly plain, with no modifications, you shouldn't notice anything different. If you've made significant changes inside Blockly or are using our more advanced APIs, read on!

In this release (Q2 2019)

• A major cleanup of the Field APIs (huge thanks to Beka Westberg for this work, on both code and documentation)

  • Existing library fields work the same
    • And now we have documentation on all library fields, including code samples
  • Your custom fields may need to be tweaked--see the Upgrading a Custom Field page
  • We have documentation on creating a new custom field!
  • Beka also built a custom field demo with annotated code samples

• Renames of a significant number of utility functions.

  • For a full list of renamed functions, plus bash scripts to do most of the work for you, check out this gist
  • This is part of our push to remove our dependency on the Closure UI library

• Deletion of the accessibility demo

  • We're working on a new approach to accessibility, with a focus on keyboard navigation
  • That is on the keyboard-nav branch, and will be in the Q3 release
  • The old accessibility demo is now in a separate repo, blockly-experimental

• An XSD for validating Blockly XML files

• Assorted bug fixes

Here is a full list of pull requests and issues closed:

Issues closed

• Function argument names not escaped (https://github.com/google/blockly/issues/2624)
• Functions with return values have lost the no-statement option (https://github.com/google/blockly/issues/2621)
• Procedures with arguments break (https://github.com/google/blockly/issues/2620)
• Headless xml -> Javascript in Node.js: Many Problems (https://github.com/google/blockly/issues/2603)
• Previously partial XML parsing failure becomes absolute failure (https://github.com/google/blockly/issues/2600)
• run python build.py, but build failed (https://github.com/google/blockly/issues/2593)
• Procedures Don't Properly Handle Spaces (https://github.com/google/blockly/issues/2590)
• No longer builds on NodeJS v12+ (https://github.com/google/blockly/issues/2582)
• Headless Workspaces Require a Theme to Be Defined (https://github.com/google/blockly/issues/2575)
• Make separate Feature Request and Bug Report templates (https://github.com/google/blockly/issues/2566)
• Move accessible directory to an experiments repo (https://github.com/google/blockly/issues/2565)
• text_append block shows all variables in dropdown menu (https://github.com/google/blockly/issues/2561)
• Dynamic variable getter/setter toolbox error (https://github.com/google/blockly/issues/2557)
• hideChaff doesn't cancel chaff that's animating open (https://github.com/google/blockly/issues/2555)
• Blockly.getMainWorkspace returns WorkspaceSvg (https://github.com/google/blockly/issues/2553)
• Colour picker doesn't close on selection (https://github.com/google/blockly/issues/2544)
• Accessible Demo is broken (https://github.com/google/blockly/issues/2540)
• Shadow blocks sent to trash (https://github.com/google/blockly/issues/2538)
• Uncompressed Mode - Error using dynamics variables (https://github.com/google/blockly/issues/2536)
• Shadow blocks shouldn't hide blocklyPathDark (https://github.com/google/blockly/issues/2535)
• Date picker should fire change events (https://github.com/google/blockly/issues/2534)
• Code: add line numbers (https://github.com/google/blockly/issues/2533)
• Dropdown arrow missing padding. (https://github.com/google/blockly/issues/2527)
• Document Move Options (https://github.com/google/blockly/issues/2524)
• Why does the locally opened window have FieldDate, while the project launched with http://localhost:3000 has no FieldDate alone? (https://github.com/google/blockly/issues/2511)
• How to regenerate the blockly_compressed.js file after FieldDate unannotates it? (https://github.com/google/blockly/issues/2510)
• When the variable name can be displayed, the Chinese 姓名 can be displayed, and when it becomes code, is it name? (https://github.com/google/blockly/issues/2505)
• On the problem of recompiling errors after Uncommenting FildDate (https://github.com/google/blockly/issues/2504)
• Some Browsers Don't Properly Import XML with Sub-Block Nodes (https://github.com/google/blockly/issues/2499)
• Blockly.FieldDate is not a constructor (https://github.com/google/blockly/issues/2488)
• Make Adding Children to a Field's textElement_ Easier (https://github.com/google/blockly/issues/2484)
• Is there an object concept in Blockly? Or how to develop custom components for objects (https://github.com/google/blockly/issues/2481)
• How to Redevelop Field_date (https://github.com/google/blockly/issues/2480)
• Extension Documentation Example Incorrect (https://github.com/google/blockly/issues/2474)
• Audit fields' behavior when setting invalid values (https://github.com/google/blockly/issues/2462)
• Feature request: Collapse/expand blocks on double click (https://github.com/google/blockly/issues/2461)
• Q: Should fields initialize with default values? (https://github.com/google/blockly/issues/2454)
• Q: How do you want text input validation to look? (https://github.com/google/blockly/issues/2435)
• Blockly Future (https://github.com/google/blockly/issues/2432)
• Clarify in docs that variabletype needs to be set in Toolbox XML when using typed variables (https://github.com/google/blockly/issues/2422)
• what can i do to return the result from the function that use in controls_if block when i try to create a new block (actually i need it return true or false,but nothing return) (https://github.com/google/blockly/issues/2416)
• getAllBlockStyles Annotation Error? (https://github.com/google/blockly/issues/2414)
• MIT's licence appearing in compressed file (https://github.com/google/blockly/issues/2412)
• Buttons and Labels in Toolbox do Not Respect Elements (https://github.com/google/blockly/issues/2396)
• Comments should be allowed on non-movable/deletable blocks (https://github.com/google/blockly/issues/2388)
• Blocks Positioned Under Toolbox in RTL Demo (https://github.com/google/blockly/issues/2387)
• Calling setVisible(false) on a Field Does Not Update the Block Correctly (https://github.com/google/blockly/issues/2381)
• Angle picker needs border (https://github.com/google/blockly/issues/2379)
• Mouse clicks/drags are borked in Safari (https://github.com/google/blockly/issues/2362)
• [Android] Suggest to open number keyboard when edit number field (https://github.com/google/blockly/issues/2341)
• Documentation: Category XML Attributes (https://github.com/google/blockly/issues/2333)
• Update webdriverio to 5.4 (https://github.com/google/blockly/issues/2283)
• Remove enforced delays from generator tests (https://github.com/google/blockly/issues/2118)
• Update geckodriver to latest (https://github.com/google/blockly/issues/2117)
• Package name casing inconsistencies (https://github.com/google/blockly/issues/2102)
• Clicking on document should call Blockly.hideChaff (https://github.com/google/blockly/issues/2066)
• New variable should default setter to that variable. (https://github.com/google/blockly/issues/2050)
• XML namespace (https://github.com/google/blockly/issues/1978)
• Add Field.prototype.toXml() & .fromXml() (https://github.com/google/blockly/issues/1627)
• Use for field_number editor (https://github.com/google/blockly/issues/1595)
• Proposal - Block.setDisabled() to Block.setEnabled() (https://github.com/google/blockly/issues/1593)
• Create DTD for xml format (https://github.com/google/blockly/issues/1308)
• Remove uses of 'goog' in demos (https://github.com/google/blockly/issues/1072)
• Code demo is not escaping strings before colourizing them (https://github.com/google/blockly/issues/1002)
• BlocklyFactory: Remove dependency on closure. (https://github.com/google/blockly/issues/668)
• realtime not working playground.html (https://github.com/google/blockly/issues/88)

Pull requests

• Rebuild (https://github.com/google/blockly/pull/2643)
• Update dependencies (https://github.com/google/blockly/pull/2638)
• A bunch of XML related issues. (https://github.com/google/blockly/pull/2635)
• Remove edit handler that is just eating events (https://github.com/google/blockly/pull/2634)
• Add XSD to validate Blockly’s XML (https://github.com/google/blockly/pull/2633)
• Replace --dependency_mode=STRICT with PRUNE. (https://github.com/google/blockly/pull/2631)
• Added setCollapsed to insertion marker block creation. (https://github.com/google/blockly/pull/2629)
• Define DOMParser and Element in Blockly namespace (https://github.com/google/blockly/pull/2628)
• Fixed Procedure Argument Escaping (https://github.com/google/blockly/pull/2626)
• Remove accessibility demo from Blockly repo (https://github.com/google/blockly/pull/2623)
• Fixed Procedure Decomposition Not Working with >1 Arguments (https://github.com/google/blockly/pull/2622)
• Fixes bug with using dynamic variable in toolbox (https://github.com/google/blockly/pull/2618)
• Rename BlockAnimation > blockAnimation (https://github.com/google/blockly/pull/2617)
• Adds fill to svg dark path (https://github.com/google/blockly/pull/2611)
• Fixes spacing problem in procedure name (https://github.com/google/blockly/pull/2610)
• Update github templates (https://github.com/google/blockly/pull/2609)
• Create bug and feature templates (https://github.com/google/blockly/pull/2608)
• Adds type to FieldNumber editor (https://github.com/google/blockly/pull/2607)
• Rename Blockly.Xml.utils to Blockly.utils.xml (https://github.com/google/blockly/pull/2606)
• Fixes theme error for headless workspaces (https://github.com/google/blockly/pull/2605)
• Remove sudo tag in travis (https://github.com/google/blockly/pull/2602)
• Use Blockly.utils.Paths functions for some constants; fix a test (https://github.com/google/blockly/pull/2601)
• Rebase on develop (https://github.com/google/blockly/pull/2599)
• Fix IE not unhighlighting (https://github.com/google/blockly/pull/2598)
• Create svg_utils file (https://github.com/google/blockly/pull/2597)
• Rename block_render_* files (https://github.com/google/blockly/pull/2596)
• Added custom fields demo. (https://github.com/google/blockly/pull/2594)
• Build script updates (https://github.com/google/blockly/pull/2589)
• Removed Class Option Check from Text Input fromJson (https://github.com/google/blockly/pull/2588)
• Fixed Rendering of Images & Text Dropdown (https://github.com/google/blockly/pull/2587)
• Removed textToDom Needing Documents (https://github.com/google/blockly/pull/2585)
• upgrade gulp to v4 (https://github.com/google/blockly/pull/2583)
• Pull Request: Split showContextMenu_ (https://github.com/google/blockly/pull/2581)
• Fixed bug block is not unhighlighted (https://github.com/google/blockly/pull/2580)
• Fixed setTooltip Not Working Before appendField() (https://github.com/google/blockly/pull/2578)
• Added Sending the Bad Value to doValueInvalid (https://github.com/google/blockly/pull/2577)
• Added Procedure Tests (https://github.com/google/blockly/pull/2576)
• Remove last Closure from Block Factory. (https://github.com/google/blockly/pull/2573)
• Refactor workspace.connectionDBList (https://github.com/google/blockly/pull/2572)
• Resolve 13 warnings (https://github.com/google/blockly/pull/2571)
• Added Colour and Date Editor Auto-Close on Selection (https://github.com/google/blockly/pull/2570)
• Adds option for testing external and internal inputs (https://github.com/google/blockly/pull/2569)
• Added Trashcan Tests (https://github.com/google/blockly/pull/2568)
• Add a row after a dummy input. (https://github.com/google/blockly/pull/2567)
• Add simple page for comparing rendered blocks directly (https://github.com/google/blockly/pull/2564)
• Adds screenshot test script (https://github.com/google/blockly/pull/2563)
• Change alignment on previous and next connections (https://github.com/google/blockly/pull/2560)
• Fix regular expressions. (https://github.com/google/blockly/pull/2559)
• Fixed Fields Still Being Editable on Non-Editable Blocks (https://github.com/google/blockly/pull/2558)
• Render/bottom inline highlight (https://github.com/google/blockly/pull/2554)
• Remove a bunch more Closure (https://github.com/google/blockly/pull/2552)
• Fixed Field Disposal, and Reorganized Editor Creation (https://github.com/google/blockly/pull/2551)
• Clean up inline and external value input highlighting (https://github.com/google/blockly/pull/2550)
• Fix tree traversal to work for multiple stacks (https://github.com/google/blockly/pull/2549)
• Render/rtl top right (https://github.com/google/blockly/pull/2548)
• Extract connection placement into separate functions (https://github.com/google/blockly/pull/2547)
• Remove goog.color (https://github.com/google/blockly/pull/2546)
• Fixed how the Trashcan Handles Shadow Blocks (https://github.com/google/blockly/pull/2545)
• Add test case for stacked blocks (https://github.com/google/blockly/pull/2543)
• Add tests with external and inline inputs; set shadow colour (https://github.com/google/blockly/pull/2542)
• Account for shadow in block size. (https://github.com/google/blockly/pull/2541)
• Fix text y location on statement inputs (https://github.com/google/blockly/pull/2539)
• Block min width; notch offsets (https://github.com/google/blockly/pull/2537)
• Removed Extra DropDownDiv Calls (https://github.com/google/blockly/pull/2532)
• Add new test cases (https://github.com/google/blockly/pull/2529)
• Fixed Dropdown Arrow Missing Padding (https://github.com/google/blockly/pull/2528)
• Moved Serializing the Field's Name up to xml.js (https://github.com/google/blockly/pull/2526)
• Fix 19 warnings in theme-related code. (https://github.com/google/blockly/pull/2523)
• Adds minimum block height (https://github.com/google/blockly/pull/2522)
• Fix checkbox rendering (https://github.com/google/blockly/pull/2521)
• Call getSize in getCorrectedSize (https://github.com/google/blockly/pull/2520)
• Remove empty tests; clean up logs; open based on OS (https://github.com/google/blockly/pull/2519)
• Render insertion markers (https://github.com/google/blockly/pull/2518)
• Moved the Date Field to the Dropdown Div, and Restyled It (https://github.com/google/blockly/pull/2517)
• Draws highlight on the bottom of a statement input (https://github.com/google/blockly/pull/2516)
• Make tests pass by setting up requires/provides correctly (https://github.com/google/blockly/pull/2515)
• Set node version explicitly for travis on master (https://github.com/google/blockly/pull/2514)
• Adds alignment padding to dummy inputs (https://github.com/google/blockly/pull/2512)
• Reorganized Field View Initialization (https://github.com/google/blockly/pull/2509)
• Added getSourceBlock Function to Field (https://github.com/google/blockly/pull/2508)
• Readded Reevaluating Values when Constraints are Set (https://github.com/google/blockly/pull/2507)
• Replace Element constants with Node constants. (https://github.com/google/blockly/pull/2503)
• Angle Field Fixes (https://github.com/google/blockly/pull/2501)
• Fixed How Fields Handle Size (https://github.com/google/blockly/pull/2500)
• Added More setValue Test Coverage (https://github.com/google/blockly/pull/2498)
• Changed Colour Field Class Validator to Accept all Documented Values (https://github.com/google/blockly/pull/2497)
• Dependencies and tests (https://github.com/google/blockly/pull/2495)
• Fixes highlight for bottom row (https://github.com/google/blockly/pull/2494)
• Fix colour and image fields (https://github.com/google/blockly/pull/2492)
• More pixel pushing (https://github.com/google/blockly/pull/2491)
• Use constants for width and height of empty inline inputs. (https://github.com/google/blockly/pull/2489)
• Fix style matching in Firefox 67 (master cherrypick) (https://github.com/google/blockly/pull/2487)
• Restricts bottom row length after a statement input (https://github.com/google/blockly/pull/2486)
• Fix style matching in Firefox 67 (https://github.com/google/blockly/pull/2485)
• Make the test reporter function when tests pass (https://github.com/google/blockly/pull/2479)
• Refactors bottom row to be a row instead of measurable (https://github.com/google/blockly/pull/2478)
• Rendering tweaks (https://github.com/google/blockly/pull/2477)
• Handle empty filter argument, in an ugly way (https://github.com/google/blockly/pull/2476)
• Filter tests based on command line argument (https://github.com/google/blockly/pull/2475)
• Add single-block test cases (https://github.com/google/blockly/pull/2473)
• Refactor top row (https://github.com/google/blockly/pull/2472)
• Clear debug rectangles before rerendering (https://github.com/google/blockly/pull/2471)
• Add a checkbox to toggle rendering debug visualizations in the playground (https://github.com/google/blockly/pull/2470)
• Load a list of tests to run from a file; connect test output to dif-viewer (https://github.com/google/blockly/pull/2469)
• Fixes a dozen compiler warnings (https://github.com/google/blockly/pull/2468)
• Fix bug with in bounds bumping (https://github.com/google/blockly/pull/2467)
• Accessibility demo (https://github.com/google/blockly/pull/2466)
• Basic screenshot diffing (https://github.com/google/blockly/pull/2465)
• Prefix, suffix, window, global, requires, getViewportSize, oh my... (https://github.com/google/blockly/pull/2464)
• Fraser suffix2 (https://github.com/google/blockly/pull/2463)
• Moves navigation logic to cursor (https://github.com/google/blockly/pull/2460)
• Added Field Value Tests (https://github.com/google/blockly/pull/2459)
• Add STATEMENT_SUFFIX (https://github.com/google/blockly/pull/2458)
• Remove goog.userAgent dependency. (https://github.com/google/blockly/pull/2457)
• Maybe fix mocha tests (https://github.com/google/blockly/pull/2456)
• Use modify when inserting from the flyout (https://github.com/google/blockly/pull/2455)
• TDD: tests for navigation insert/modify, currently skipped (https://github.com/google/blockly/pull/2453)
• Changes the cursor look for a stack (https://github.com/google/blockly/pull/2452)
• Develop (https://github.com/google/blockly/pull/2450)
• Fixes case where we do not have a toolbox (https://github.com/google/blockly/pull/2449)
• Add wrapper functions so developers can override warning and error handling (https://github.com/google/blockly/pull/2448)
• Add basic tests for insert functions (https://github.com/google/blockly/pull/2447)
• Disconnect blocks with X (https://github.com/google/blockly/pull/2446)
• Make the marker blue on both blocks and input/output connections. (https://github.com/google/blockly/pull/2445)
• Mark the cursor location when opening the toolbox; cleanup (https://github.com/google/blockly/pull/2444)
• typo fix in createVariable documentation in variable.js (https://github.com/google/blockly/pull/2443)
• Small bug fixes and cleanup (https://github.com/google/blockly/pull/2442)
• Refactored Field Validation. (https://github.com/google/blockly/pull/2441)
• Get rid of insertionNode (https://github.com/google/blockly/pull/2439)
• Helper to check whether an ast node points to a connection (https://github.com/google/blockly/pull/2438)
• Handle escape in the toolbox/flyout. (https://github.com/google/blockly/pull/2437)
• Cleanup for previous (https://github.com/google/blockly/pull/2436)
• Run mocha tests in the browser on travis (https://github.com/google/blockly/pull/2434)
• Testing/webdriverio upgrade (https://github.com/google/blockly/pull/2433)
• Next cleanup (https://github.com/google/blockly/pull/2431)
• Reduce ID collisions. (https://github.com/google/blockly/pull/2429)
• Refactored field.init into field.initView and field.initModel (https://github.com/google/blockly/pull/2427)
• Add mocha tests to npm test (https://github.com/google/blockly/pull/2426)
• Removed Explicitly Setting Variable Type to Two Single Quotes (https://github.com/google/blockly/pull/2425)
• Update to webdriverio v5; fix resulting test breakages (https://github.com/google/blockly/pull/2424)
• Cleanup for in functionality (https://github.com/google/blockly/pull/2423)
• Out cleanup (https://github.com/google/blockly/pull/2421)
• Strip MIT’s licence out of compiled code. (https://github.com/google/blockly/pull/2420)
• Add a marker that shows where the user has marked on the workspace (https://github.com/google/blockly/pull/2419)
• Resolve field angle overlap render problem (https://github.com/google/blockly/pull/2418)
• Add a border to angle picker field, to fix rendering problem (https://github.com/google/blockly/pull/2417)
• Position correctly when inserting before another block (from the flyout) (https://github.com/google/blockly/pull/2415)
• Added updateColour to Field (https://github.com/google/blockly/pull/2413)
• Delete two unused i18n scripts (https://github.com/google/blockly/pull/2411)
• Fixed Buttons Being Rendered as Labels if They Come After a Label (https://github.com/google/blockly/pull/2410)
• Cursor ast update (https://github.com/google/blockly/pull/2409)
• Added fromXml and toXml to Fields (https://github.com/google/blockly/pull/2407)
• Removed setVisible (fields, inputs) from the Public API (https://github.com/google/blockly/pull/2406)
• Add tests for keyboard handling in the toolbox (https://github.com/google/blockly/pull/2405)
• Warnings fix (https://github.com/google/blockly/pull/2404)
• Set node version explicitly for travis; update dependencies (https://github.com/google/blockly/pull/2403)
• When moving from a stack to the workspace, place the cursor just above the recently selected stack. (https://github.com/google/blockly/pull/2402)
• Add release and milestone information to Readme (https://github.com/google/blockly/pull/2401)
• Update comment body size in resizeBubble (https://github.com/google/blockly/pull/2400)
• Added field_label_serializable (https://github.com/google/blockly/pull/2399)
• Kb exit toolbox (https://github.com/google/blockly/pull/2398)
• Moved RTL Demo Blocks so They Aren't Behind the Toolbox (https://github.com/google/blockly/pull/2397)
• Changed Buttons and Labels to Respect Elements in Toolbox (https://github.com/google/blockly/pull/2395)
• Update version number to 1.20190419.0-develop (https://github.com/google/blockly/pull/2394)
• Add sauce labs to readme (https://github.com/google/blockly/pull/2393)
• Validate newValue parameter in setValue (https://github.com/google/blockly/pull/2392)
• Keyboard nav ast node (https://github.com/google/blockly/pull/2391)
• Reorganize conditionals for block context menu (https://github.com/google/blockly/pull/2390)
• Added isSerializable and SERIALIZABLE to Field (https://github.com/google/blockly/pull/2389)
• Add Block.setEnabled (https://github.com/google/blockly/pull/2386)
• Added isDirty_ Property to Fields (https://github.com/google/blockly/pull/2382)
• #1142 Replace tests/generator/*.xml with .js (https://github.com/google/blockly/pull/2375)
• April 2019 release candidate (https://github.com/google/blockly/pull/2373)
• Documentation update (https://github.com/google/blockly/pull/2366)
• Change the cursor to a pointer if there is a click handler on the image (https://github.com/google/blockly/pull/1437)
• Add option to disable keyboard shortcuts (https://github.com/google/blockly/pull/171)
• Implement tree structure for blocks (https://github.com/google/blockly/pull/112)

Cherrypicks

• Fix colour injection vulnerability (https://github.com/google/blockly/pull/2645)
• Remove @packages annotation from public methods (#2653)
• Revert "Adds type to FieldNumber editor" (#2664)
• Rename Blockly.utils.Paths -> Blockly.utils.svgPath (#2658)
• Link to custom fields demo from demos/index.html (#2673)
• Revert changes related to #2003 (#2676)