ComboBoxButton¶

Overview¶

The button on a combo box box. Displays the current selection on the button. Typically instantiated by ComboBox, not by client code.

@author Chris Malley (PixelZoom, Inc.)

Class ComboBoxButton¶

import { ComboBoxButton } from 'scenerystack/sun';

Constructor¶

new ComboBoxButton( property : TProperty<T>, items : ComboBoxItemNoNode<T>[], nodes : Node[], providedOptions? : ComboBoxButtonOptions )¶

Instance Methods¶

setDisplayOnly( displayOnly : boolean )¶

Sets the button to look like a value display instead of a combo box button. See https://github.com/phetsims/sun/issues/451

blockNextVoicingFocusListener()¶

Call to block voicing from occurring upon this button's next focus event. For use by ComboBox.

dispose()¶

Type ComboBoxButtonAlign¶

import type { ComboBoxButtonAlign } from 'scenerystack/sun';

"left" | "center" | "right"

Type ComboBoxButtonArrowDirection¶

import type { ComboBoxButtonArrowDirection } from 'scenerystack/sun';

"up" | "down"

Type ComboBoxButtonOptions¶

import type { ComboBoxButtonOptions } from 'scenerystack/sun';

• align?: ComboBoxButtonAlign
• arrowDirection?: ComboBoxButtonArrowDirection
• arrowFill?: TPaint
• comboBoxVoicingNameResponsePattern?: TReadOnlyProperty<string> | string
  The pattern for the voicingNameResponse, with "{{value}}" provided to be filled in with ComboBoxItem.a11yName.
• localPreferredWidthProperty?: TReadOnlyProperty<number | null>
• localMinimumWidthProperty?: TProperty<number | null>
• & StrictOmit<RectangularPushButtonOptions, "children" | "ariaLabelledbyAssociations">

Source Code¶

See the source for ComboBoxButton.ts in the sun repository.