Document tab and tabs properties.

HealthSamurai · Dec 20, 2024 · 8869c93 · 8869c93
1 parent b69b232
commit 8869c93
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/src/hs_ui/components/tab.cljc b/src/hs_ui/components/tab.cljc
@@ -18,6 +18,13 @@
    ])
 
 (defn component
+  "Possible component-specific props:
+  :id
+  :name
+  :c/selected?
+  :checked
+  :on-change
+  :slot/content"
   [props]
   [(if (:href props) :a :label) (dissoc (u/merge-props  {:class root-class} props)
                                         :on-change :name)

diff --git a/src/hs_ui/organisms/tabs.cljc b/src/hs_ui/organisms/tabs.cljc
@@ -8,6 +8,13 @@
    "space-x-[theme(spacing.x3)]"])
 
 (defn component
+  "Accepts a vector of maps, each map might have
+  :id
+  :name
+  :c/selected?
+  :checked
+  :on-change
+  :slot/content"
   [props]
   [:div (u/merge-props {:class root-class} props)
    (for [item (:c/items props)] ^{:key (:id item)}