@fabwcie/free-drawing / components/toolbar/widgets/GroupWidget / GroupWidget
Class: GroupWidget
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:117
Group of toolbar widgets: one button (generic icon by default) shows its widgets above it, highlighted while one of them is active. Its widgets are still widgets of the toolbar (shortcuts, help, command palette, read only), added with it by toolbar.addGroup.
Constructors
Constructor
new GroupWidget(
drawer,__namedParameters):GroupWidget
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:133
Create the group button and the menu of its widgets
Parameters
drawer
Drawer of this group
__namedParameters
Returns
GroupWidget
Properties
$button
readonly$button:HTMLButtonElement
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:125
Button showing / hiding the menu (disclosure), highlighted while a widget of group is active
$container
readonly$container:HTMLDivElement
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:123
Container of group button and menu in toolbar
$menu
readonly$menu:HTMLDivElement
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:127
Menu of widget buttons (role group), above group button in fixed position, hidden until shown
drawer
readonlydrawer:Drawer
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:119
Drawer of this group
widgets
readonlywidgets:BaseWidget[]
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:121
Widgets of the group, in menu order
Methods
_initEvents()
private_initEvents():void
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:242
Button toggles widgets, arrow keys move between them, Escape closes them (focus back on button), closed when a widget is chosen, focus or pointer goes elsewhere, footer scrolls or window is resized
Returns
void
_place()
private_place():void
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:222
Widgets above group button, in drawer: fixed position, not cut by footer (scrolled on narrow screens)
Returns
void
addTo()
addTo(
parent):void
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:170
Internal
Adds group button and its widgets to parent (toolbar)
Parameters
parent
HTMLElement
Toolbar root receiving the group container
Returns
void
hide()
hide():
void
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:199
Hide widgets (widget chosen, Escape, focus or pointer elsewhere, footer scrolled, window resized)
Returns
void
isShown()
isShown():
boolean
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:179
Menu of widgets is shown
Returns
boolean
True while the menu is not hidden
show()
show():
void
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:186
Show widgets, focus on active one (else first one): arrow keys move between them
Returns
void
update()
update():
void
Defined in: packages/free-drawing/src/components/toolbar/widgets/GroupWidget.ts:207
Button highlighted while a widget of group is active, disabled when all its widgets are (read only)
Returns
void