The basics

• I validated my changes

The details

Resolves

Fixes #8063

Proposed Changes

• Adds getContents method to the IFlyout interface (breaking change)
• Removes casts for Flyout and FlyoutItem[]
• Adjusts the getContents method in flyout_base to return an actual FlyoutItem[] instead of saying it does that, but is actually Array<Block | FlyoutItem> (note that this method exists in develop but hasn't been released yet so this isn't the breaking change)

Reason for Changes

• In Blockly v10, flyouts never store a list of their contents. Whenever show is called, the flyout definition is passed to the method, that definition is parsed, and the blocks, buttons, and gaps are laid out in the flyout. The actual blocks and buttons created are never stored anywhere.
• For keyboard navigation to be able to navigate flyouts including buttons, we need to know what is currently in the flyout. Simply inspecting the workspace is not enough, as buttons are not a first class object stored on the workspace like blocks are. You can't get a list of buttons on the workspace. Therefore, we need to store what is currently being shown in the flyout.
• This was initially implemented in feat: support keyboard navigation of flyout buttons #7852. Initially, the getContents method was only added to the abstract Flyout class, and not the IFlyout interface. However, custom flyouts are only required to implement the IFlyout interface and are not required to extend our base class.
• Also, in this PR, the getContents method was typed as returning an array of FlyoutItems, but it didn't actually return those, and used casts to fake it, both when setting the contents and using them. The reason I'm fixing this by actually using FlyoutItem instead of just changing the type is because using FlyoutItem is more future-compatible. If we ever extend the flyout definition to include a third type of object that might be keyboard-navigable, we won't need to change the type or implementation of getContents (just the implementation of ASTNode to handle the new item).

Test Coverage

I haven't been able to link this to samples to test keyboard navigation, but I'll try that again before submitting this PR.

Documentation

N/A, we don't document how to create a custom flyout at this time.

Breaking changes / To fix

• getContents is now required to be implemented in the IFlyout interface. This is important to support our goal of improving accessibility in Blockly.
• If you do not use a custom flyout, you do not need to take any action.
• If you use a custom flyout that extends Blockly.Flyout, Blockly.HorizontalFlyout, Blockly.VerticalFlyout, or the ContinuousFlyout from the continuous-toolbox plugin, you may not need to take any action. The getContents method has been implemented in the abstract base class.
  • If your subclass overrides the show method, ensure that it sets the contents property of the flyout as the base class implementation does.
• If you use a custom flyout that implements the IFlyout interface and does not extend the abstract Flyout class, you will need to add an implementation for getContents to your flyout. This method should return a list of all FlyoutItems (at this time, that includes Blocks and FlyoutButtons) that are present in the current flyout.