DropDown

Defined in: src/widgets/specialized.ts:99

Base class for controls that have a visual root and a set of properties.

Extends

• Widget

Constructors

Constructor

new DropDown(label, options?): DropDown

Defined in: src/widgets/specialized.ts:108

Parameters

Parameter	Type
label	string | Element
options?	DropDownOptions

Returns

DropDown

Overrides

Widget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Widget._functions	src/widgets/base.ts:243
_properties	protected	Property[]	[]	-	Widget._properties	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	Widget._root	src/widgets/base.ts:241
dart	public	any	undefined	-	Widget.dart	src/widgets/base.ts:246
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	src/widgets/base.ts:239
isDetached	public	boolean	false	-	Widget.isDetached	src/widgets/base.ts:247
props	public	any	undefined	-	Widget.props	src/widgets/base.ts:244
subs	public	Subscription[]	undefined	-	Widget.subs	src/widgets/base.ts:245
temp	public	any	undefined	Contains auxiliary information	Widget.temp	src/widgets/base.ts:236

Accessors

children

Get Signature

get children(): Widget<any>[]

Defined in: src/widgets/base.ts:320

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Widget.children

---

isExpanded

Get Signature

get isExpanded(): boolean

Defined in: src/widgets/specialized.ts:130

Returns

boolean

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: src/widgets/base.ts:317

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: src/widgets/base.ts:324

Widget's visual root.

Returns

HTMLElement

Set Signature

set root(r): void

Defined in: src/widgets/base.ts:325

Parameters

Parameter	Type
r	HTMLElement

Returns

void

Inherited from

Widget.root

---

type

Get Signature

get type(): string

Defined in: src/widgets/specialized.ts:106

Returns

string

Overrides

Widget.type

Methods

apply()

apply(properties): Widget

Defined in: src/widgets/base.ts:284

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Widget.apply

---

collapse()

collapse(hideMenu?): void

Defined in: src/widgets/specialized.ts:143

Parameters

Parameter	Type	Default value
hideMenu	boolean	true

Returns

void

---

detach()

detach(): void

Defined in: src/widgets/specialized.ts:118

Removes the widget and cleans up resources

Returns

void

Overrides

Widget.detach

---

expand()

expand(): void

Defined in: src/widgets/specialized.ts:134

Returns

void

---

getDartProperties()

getDartProperties(): any[]

Defined in: src/widgets/base.ts:305

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: src/widgets/base.ts:299

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

Widget.getFunctions

---

getProperties()

getProperties(): Property[]

Defined in: src/widgets/base.ts:295

Returns all properties of this widget.

Returns

Property[]

Inherited from

Widget.getProperties

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: src/widgets/base.ts:371

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Inherited from

Widget.getWidgetStatus

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/widgets/base.ts:368

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Inherited from

Widget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: src/widgets/base.ts:311

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: src/widgets/base.ts:303

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	Property | null	or null, if multiple properties were changed.

Returns

void

Inherited from

Widget.onPropertyChanged

---

removeMenuSubscription()

removeMenuSubscription(): void

Defined in: src/widgets/specialized.ts:125

Returns

void

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: src/widgets/base.ts:309

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: src/widgets/base.ts:277

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Widget.sub

---

toDart()

toDart(): any

Defined in: src/widgets/base.ts:269

Returns

any

Inherited from

Widget.toDart

---

custom()

static custom(label, createElement, options?): DropDown

Defined in: src/widgets/specialized.ts:306

Creates a dropdown with custom content.

Parameters

Parameter	Type	Description
label	string | Element	Text or element to display as the dropdown trigger
createElement	() => HTMLElement	Function that creates the dropdown content element
options?	DropDownOptions	Optional dropdown options

Returns

DropDown

---

find()

static find(root): Widget<any> | null

Defined in: src/widgets/base.ts:265

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Widget.find

---

fromRoot()

static fromRoot(root): Widget

Defined in: src/widgets/base.ts:374

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

Widget.fromRoot

---

getAll()

static getAll(): Widget<any>[]

Defined in: src/widgets/base.ts:260

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll

---

list()

static list(label, items, listOptions?, options?): DropDown

Defined in: src/widgets/specialized.ts:295

Creates a dropdown with a list of selectable items.

Parameters

Parameter	Type	Description
label	string | Element	Text or element to display as the dropdown trigger
items	string[]	Array of string items to display
listOptions?	DropDownListOptions	Options including onItemClick callback
options?	DropDownOptions	Optional dropdown options

Returns

DropDown

---

menu()

static menu(label, items, options?): DropDown

Defined in: src/widgets/specialized.ts:283

Creates a dropdown with menu items. This is the recommended way to create dropdowns.

Parameters

Parameter	Type	Description
label	string | Element	Text or element to display as the dropdown trigger
items	DropDownMenuItems | DropDownMenuBuilder	Menu items object, or a builder function for full Menu access
options?	DropDownOptions	Optional dropdown options

Returns

DropDown

Example

// Simple object syntax
DropDown.menu('Actions', {
  'Add': () => grok.shell.info('add'),
  'Edit': () => grok.shell.info('edit'),
});

// Builder function for separators, headers, etc.
DropDown.menu('Actions', (menu) => {
  menu.item('Add', () => grok.shell.info('add'));
  menu.separator();
  menu.item('Delete', () => grok.shell.info('delete'));
});