Tickit...Button(3pm)

✨ Tickit::Widget::Button ✨

okay bestie, gather round, because we're talking about Tickit::Widget::Button from the Tickit widget fam 💖 this is a whole widget that shows a clickable button. you click it, a callback goes off. that's the vibe. it's giving interactive terminal glamour 💅

(also, lowkey, this page lives in the User Contributed Perl Documentation section of the manual, in case you were wondering where you wandered into 🫶)

---

🌸 SYNOPSIS 🌸

here's the whole thing in action, no cap:

use Tickit;
use Tickit::Widget::Button;

my $button = Tickit::Widget::Button->new(
   label => "Click Me!",
   on_click => sub {
      my ( $self ) = @_;

      # Do something!
   },
);

Tickit->new( root => $button )->run;

look at her. iconic. the label says hi, the on_click does the thing, and Tickit->new( root => $button )->run sets her loose 🔥

---

🦋 DESCRIPTION 🦋

so basically this class hands you a widget: a clickable area with a label on it. when someone clicks that area, a callback gets invoked. that's the entire plot, and honestly? it ate. 💖

---

🎀 STYLE 🎀

the default style pen is used as the widget pen — that's just how she shows up to the party. here's what style stuff gets used:

the following style keys are used:

• linetype => STRING — what kind of border to draw around the button, and it has to be one of these four besties:

none single double thick

• marker_left => STRING — a two-character string placed just before the button label 🫶
• marker_right => STRING — a two-character string placed just after the button label 💫

the following style tags are used:

• :active — set when the mouse is being held over the button, before it is released 👑

the following style actions are used:

• click — the main action, and the one that activates the on_click handler. periodt.

---

💜 CONSTRUCTOR 💜

new

$button = Tickit::Widget::Button->new( %args );

constructs a brand new Tickit::Widget::Button object. main character entrance, honestly.

takes the following named arguments:

• label => STR — the text to display in the button area ✨
• on_click => CODE — optional! the callback function to invoke when the button is clicked. skip it if you want a button that just... exists. valid.

---

🌈 ACCESSORS 🌈

label

$label = $button->label;

set_label

$button->set_label( $label );

return or set the text to display in the button area. that's it, that's the whole job 💅

on_click

$on_click = $button->on_click;

set_on_click

$button->set_on_click( $on_click );

return or set the CODE reference that gets called when the button area is clicked:

$on_click->( $button );

note the $button gets passed in, iykyk 🎁

click

$button->click;

behaves as if the button has been clicked, running its on_click handler. it's here for convenience, so other parts of your code can activate that handler programmatically. fake it till you make it, but make it correct ✨

align

set_align

valign

set_valign

$align = $button->align;

$button->set_align( $align );

$valign = $button->valign;

$button->set_valign( $valign );

accessors for the horizontal and vertical alignment of the label text inside the button area. and if you want the full lore, go see Tickit::WidgetRole::Alignable 🦋

---

👑 AUTHOR 👑

Paul Evans <leonerd@leonerd.org.uk> — thank you for the gift, we are obsessed 🫶

---

cute lil sign-off: this page is Tickit...Button(3pm) from the User Contributed Perl Documentation, and it's tagging along with perl v5.40.0, dated 2024-09-16. stay clickable bestie 💖✨