Layout...ompass(3pm)

💖 Layout::Manager::Compass 💖

okay bestie, so this is the Layout::Manager::Compass page from the User Contributed Perl Documentation, section 3pm, and it's literally a compass-based layout manager and I'm obsessed. 🧭✨

---

🌈 NAME 🌈

Layout::Manager::Compass — a compass based layout, no cap. 🧭💅

---

✨ DESCRIPTION ✨

So Layout::Manager::Compass is a layout manager that takes hints based on the four cardinal directions — north, east, south and west — plus a center area that takes up all the remaining space, heightwise. 🫶

In other words (fr fr): the center area will expand to take up all the space that is NOT used by components placed at the edges. And components at the north and south edges will take up the full width of the container. main character behavior honestly. 👑

+--------------------------------+
|              north             |
+-----+--------------------+-----+
|     |                    |     |
|  w  |                    |  e  |
|  e  |       center       |  a  |
|  s  |                    |  s  |
|  t  |                    |  t  |
|     |                    |     |
+-----+--------------------+-----+
|              south             |
+--------------------------------+

Components are placed in the order they are added. So if two items are added to the 'north' position, then the first item will be rendered above the second. And the height of the north edge will equal the height of both components combined. math is mathing. 🧮✨

Items in the center split the available space, heightwise. Two center components will each take up 50% of the available height and 100% of the available width. fifty fifty, periodt. 💅

Compass is basically an implementation of Java's BorderLayout — if you wanna peek at it: <http://java.sun.com/docs/books/tutorial/uiswing/layout/border.html> 🦋

---

🌸 SYNOPSIS 🌸

$cont->add_component($comp1, 'north');
$cont->add_component($comp2, 'east');

my $lm = Layout::Manager::Compass->new;
$lm->do_layout($cont);

---

🎀 POSITIONING 🎀

When you add a component with add_component, the second argument should be one of: north, south, east, west or center. Case doesn't matter bestie, she's flexible like that. 😌 You can also just provide the first letter of the word and it will do the same thing. one letter and she understands you, that's real chemistry. 💜

---

👑 METHODS 👑

do_layout

Size and position the components in this layout. that's it, that's the job. 🫡

---

🌟 AUTHOR 🌟

Cory Watson, "<gphat@cpan.org>" 💌

---

💀 COPYRIGHT & LICENSE 💀

Copyright 2008 - 2010 Cory G Watson

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. (yes it's the standard Perl license situation, we love a classic 🍓)

---

okay that's the whole page!! and for the cute sign-off: this was perl v5.34.0, dated 2022-06-15, and the footer said Layout...ompass(3pm) because the title got truncated by the terminal and honestly? iconic. 🌈✨ bye bestie, go lay out some components 💖🦋