Skip to content

charton API


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

Interface: IconButtonProps ​

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

Props of iconButton: the icon, its accessible name and tooltip, size, style variant, tooltip side and click handler.

Properties ​

icon ​

icon: IconSource

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


label ​

label: string

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

Accessible name and tooltip.


onClick? ​

optional onClick?: (e) => void

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

Parameters ​

e ​

MouseEvent

Returns ​

void


size? ​

optional size?: "sm" | "md" | "lg"

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


tip? ​

optional tip?: "right" | "bottom"

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


variant? ​

optional variant?: "flat" | "surface" | "ghost"

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

surface: tactile bevel; ghost: borderless until hover; flat: rail/sidebar.