Skip to content

charton API


charton API / @chart-on/ui / index / menuButton

Function: menuButton() ​

menuButton(p): MenuButton

Defined in: ui/src/controls.ts:229

Trigger button with a dropdown list. With isChecked the options are independent toggles, each showing its own state, and the trigger keeps its own icon and text instead of showing the selected option.

Parameters ​

p ​

alignEnd? ​

boolean

Anchor the list to the trigger's right edge. Default: whichever side keeps it on screen.

icon? ​

IconSource

isChecked? ​

(value) => boolean

isHidden? ​

(value) => boolean

Leave an option out of the list; read each time the list opens.

label ​

string

onSelect ​

(value) => void

options ​

MenuOption[]

text? ​

string

up? ​

boolean

Open above the trigger. Default: above in a bar at the bottom edge (data-pc-edge="bottom"), else below.

value? ​

string

Returns ​

MenuButton