Class: ToolboxNavigator

Defined in: packages/blockly/core/keyboard_nav/navigators/toolbox_navigator.ts:19

Navigator that handles keyboard navigation within a toolbox.

Extends

• Navigator

Properties index

Property	Description
rules	Map from classes to a corresponding ruleset to handle navigation from instances of that class.
navigationLoops	Whether or not navigation loops around when reaching the end.
toolbox	-

Methods index

Method	Description
addNavigationPolicy	Adds a navigation ruleset to this Navigator.
getFirstChild	Returns the first child of the given object instance, if any.
getParent	Returns the parent of the given object instance, if any.
getNextSibling	Returns the next sibling of the given object instance, if any.
getPreviousSibling	Returns the previous sibling of the given object instance, if any.
setNavigationLoops	Sets whether or not navigation should loop around when reaching the end of the workspace.
getNavigationLoops	Returns whether or not navigation loops around when reaching the end of the workspace.
getNavigableItems	Returns the navigable top-level items of a tree, in navigation order.
getFirstNode	Get the first navigable node on the workspace, or null if none exist.
getLastNode	Get the last navigable node on the workspace, or null if none exist.
transitionAllowed	Determines whether navigation is allowed between two nodes.
isNavigable	Returns whether or not the given node is navigable.
getSourceBlockFromNode	Returns the block that the given node is a child of.
getInNode	Returns the flyout's first item (if any) or next toolbox item when navigating in (right arrow) from a toolbox.
getOutNode	Returns the flyout's first item (if any) or previous toolbox item when navigating out (left arrow) from a toolbox.
getNextNode	Returns the flyout's first item (if any) or next toolbox item when navigating next (down arrow) from a toolbox.
getPreviousNode	Returns the flyout's first item (if any) or previous toolbox item when navigating previous (up arrow) from a toolbox.
getTopLevelItems	Returns a list of all toolbox items.

Constructors

Constructor

new ToolboxNavigator(toolbox): ToolboxNavigator;

Defined in: packages/blockly/core/keyboard_nav/navigators/toolbox_navigator.ts:20

Parameters

Parameter	Type
toolbox	IToolbox

Returns

ToolboxNavigator

Overrides

Navigator.constructor

Properties

rules

protected rules: RuleList<any>;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:46

Map from classes to a corresponding ruleset to handle navigation from instances of that class.

Inherited from

Navigator.rules

---

navigationLoops

protected navigationLoops: boolean = true;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:59

Whether or not navigation loops around when reaching the end.

Inherited from

Navigator.navigationLoops

---

toolbox

protected toolbox: IToolbox;

Defined in: packages/blockly/core/keyboard_nav/navigators/toolbox_navigator.ts:20

Methods

addNavigationPolicy()

addNavigationPolicy(policy): void;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:67

Adds a navigation ruleset to this Navigator.

Parameters

Parameter	Type	Description
policy	INavigationPolicy<any>	A ruleset that determines where focus should move starting from an instance of its managed class.

Returns

void

Inherited from

Navigator.addNavigationPolicy

---

getFirstChild()

getFirstChild(current): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:91

Returns the first child of the given object instance, if any.

Parameters

Parameter	Type	Description
current	IFocusableNode	The object to retrieve the first child of.

Returns

IFocusableNode | null

The first child node of the given object, if any.

Inherited from

Navigator.getFirstChild

---

getParent()

getParent(current): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:106

Returns the parent of the given object instance, if any.

Parameters

Parameter	Type	Description
current	IFocusableNode	The object to retrieve the parent of.

Returns

IFocusableNode | null

The parent node of the given object, if any.

Inherited from

Navigator.getParent

---

getNextSibling()

getNextSibling(current): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:119

Returns the next sibling of the given object instance, if any.

Parameters

Parameter	Type	Description
current	IFocusableNode	The object to retrieve the next sibling node of.

Returns

IFocusableNode | null

The next sibling node of the given object, if any.

Inherited from

Navigator.getNextSibling

---

getPreviousSibling()

getPreviousSibling(current): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:134

Returns the previous sibling of the given object instance, if any.

Parameters

Parameter	Type	Description
current	IFocusableNode	The object to retrieve the previous sibling node of.

Returns

IFocusableNode | null

The previous sibling node of the given object, if any.

Inherited from

Navigator.getPreviousSibling

---

setNavigationLoops()

setNavigationLoops(loops): void;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:327

Sets whether or not navigation should loop around when reaching the end of the workspace.

Parameters

Parameter	Type	Description
loops	boolean	True if navigation should loop around, otherwise false.

Returns

void

Inherited from

Navigator.setNavigationLoops

---

getNavigationLoops()

getNavigationLoops(): boolean;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:335

Returns whether or not navigation loops around when reaching the end of the workspace.

Returns

boolean

Inherited from

Navigator.getNavigationLoops

---

getNavigableItems()

getNavigableItems(root?): IFocusableNode[];

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:350

Returns the navigable top-level items of a tree, in navigation order.

For a workspace these are its stacks and comments; for a toolbox its categories; for a flyout its blocks, buttons and labels.

Parameters

Parameter	Type	Description
root	IFocusableNode | undefined	The root node of the tree to list, defaulting to the root of the currently focused tree.

Returns

IFocusableNode[]

The navigable top-level items, or an empty list if there is no tree to list.

Inherited from

Navigator.getNavigableItems

---

getFirstNode()

getFirstNode(): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:363

Get the first navigable node on the workspace, or null if none exist.

Returns

IFocusableNode | null

The first navigable node on the workspace, or null.

Inherited from

Navigator.getFirstNode

---

getLastNode()

getLastNode(): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:375

Get the last navigable node on the workspace, or null if none exist.

Returns

IFocusableNode | null

The last navigable node on the workspace, or null.

Inherited from

Navigator.getLastNode

---

transitionAllowed()

protected transitionAllowed(
   current, 
   candidate, 
   direction
): boolean;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:391

Determines whether navigation is allowed between two nodes.

Parameters

Parameter	Type	Description
current	IFocusableNode	The starting node for proposed navigation.
candidate	IFocusableNode	The proposed destination node.
direction	NavigationDirection	The direction in which the user is navigating.

Returns

boolean

True if navigation should be allowed to proceed, or false to find a different candidate.

Inherited from

Navigator.transitionAllowed

---

isNavigable()

protected isNavigable(node): boolean | undefined;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:504

Returns whether or not the given node is navigable.

Parameters

Parameter	Type	Description
node	IFocusableNode	A focusable node to check the navigability of.

Returns

boolean | undefined

True if the node is navigable, otherwise false.

Inherited from

Navigator.isNavigable

---

getSourceBlockFromNode()

getSourceBlockFromNode(node): BlockSvg | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/navigator.ts:513

Returns the block that the given node is a child of.

Parameters

Parameter	Type
node	IFocusableNode | null

Returns

BlockSvg | null

The parent block of the node if any, otherwise null.

Inherited from

Navigator.getSourceBlockFromNode

---

getInNode()

getInNode(node?, bypassAdjustments?): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/toolbox_navigator.ts:33

Returns the flyout's first item (if any) or next toolbox item when navigating in (right arrow) from a toolbox.

Parameters

Parameter	Type	Default value	Description
node	IFocusableNode | null	...	The toolbox item to navigate relative to.
bypassAdjustments	boolean	false	True to skip adjusting navigation based on the toolbox's layout; false (default) to take it into account.

Returns

IFocusableNode | null

Overrides

Navigator.getInNode

---

getOutNode()

getOutNode(node?, bypassAdjustments?): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/toolbox_navigator.ts:75

Returns the flyout's first item (if any) or previous toolbox item when navigating out (left arrow) from a toolbox.

Parameters

Parameter	Type	Default value	Description
node?	IFocusableNode | null	undefined	The toolbox item to navigate relative to.
bypassAdjustments?	boolean	false	True to skip adjusting navigation based on the toolbox's layout; false (default) to take it into account.

Returns

IFocusableNode | null

Overrides

Navigator.getOutNode

---

getNextNode()

getNextNode(node?, bypassAdjustments?): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/toolbox_navigator.ts:101

Returns the flyout's first item (if any) or next toolbox item when navigating next (down arrow) from a toolbox.

Parameters

Parameter	Type	Default value	Description
node?	IFocusableNode | null	undefined	The toolbox item to navigate relative to.
bypassAdjustments?	boolean	false	True to skip adjusting navigation based on the toolbox's layout; false (default) to take it into account.

Returns

IFocusableNode | null

Overrides

Navigator.getNextNode

---

getPreviousNode()

getPreviousNode(node?, bypassAdjustments?): IFocusableNode | null;

Defined in: packages/blockly/core/keyboard_nav/navigators/toolbox_navigator.ts:126

Returns the flyout's first item (if any) or previous toolbox item when navigating previous (up arrow) from a toolbox.

Parameters

Parameter	Type	Default value	Description
node?	IFocusableNode | null	undefined	The toolbox item to navigate relative to.
bypassAdjustments?	boolean	false	True to skip adjusting navigation based on the toolbox's layout; false (default) to take it into account.

Returns

IFocusableNode | null

Overrides

Navigator.getPreviousNode

---

getTopLevelItems()

protected getTopLevelItems(): IFocusableNode[];

Defined in: packages/blockly/core/keyboard_nav/navigators/toolbox_navigator.ts:146

Returns a list of all toolbox items.

Returns

IFocusableNode[]

Overrides

Navigator.getTopLevelItems