Document all tags and named sub-components

Closes #9
2024-08-25 02:36:05 -04:00
parent a688e2dc24
commit 30d4e208b1
11 changed files with 80 additions and 5 deletions
--- a/scrollbar.go
+++ b/scrollbar.go
@@ -9,6 +9,17 @@ var _ tomo.Object = new(Scrollbar)

 // Scrollbar is a special type of slider that can control the scroll of any
 // overflowing ContainerObject.
+//
+// Sub-components:
+//   - ScrollbarHandle is the grabbable handle of the scrollbar.
+//
+// Tags:
+//   - [vertical] The scrollbar is oriented vertically.
+//   - [horizontall] The scrollbar is oriented horizontally.
+//
+// ScrollbarHandle tags:
+//   - [vertical] The handle is oriented vertically.
+//   - [horizontall] The handle is oriented horizontally.
 type Scrollbar struct {
 	box        tomo.ContainerBox
 	handle     *sliderHandle