Merge pull request #51 from Scouterna/bottom-bar-prop-descriptions

document bottom bar props

Author: scriptcoded

.changeset/config.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
   "changelog": "@changesets/cli/changelog",
-  "commit": false,
+  "commit": true,
   "fixed": [["@scouterna/ui-*"]],
   "linked": [],
   "access": "restricted",

.changeset/fair-wolves-lay.md

@@ -0,0 +1,5 @@
+---
+"@scouterna/ui-webc": patch
+---
+
+Added prop descriptions for bottom bar item.

packages/ui-webc/src/components/bottom-bar-item/bottom-bar-item.tsx

@@ -13,11 +13,31 @@ export type ItemType = "button" | "link";
   shadow: true,
 })
 export class ScoutBottomBarItem {
+  /**
+   * The type of the bottom bar item, either a button or a link.
+   */
   @Prop() type: ItemType = "button";
+
+  /**
+   * An optional link to navigate to when the item is clicked. Only used when
+   * `type` is set to "link".
+   */
   @Prop() href?: string;
 
+  /**
+   * An icon to display above the label. Must be an SVG string.
+   */
   @Prop() icon!: string;
+
+  /**
+   * The label to display below the icon.
+   */
   @Prop() label!: string;
+
+  /**
+   * Whether the item is currently active. Should be set to true when the item
+   * represents the current page.
+   */
   @Prop() active?: boolean;
 
   @Event()