@hzblj/kara-components 0.6.0 → 0.7.0

package/lib/typescript/atoms/text-field/text-field.types.d.ts

@@ -1,12 +1,24 @@
 import type { ReactNode } from 'react';
+/**
+ * An uncontrolled text field with an optional label above it — SwiftUI `TextField` (`SecureField` when `secure`) /
+ * Compose `OutlinedTextField`.
+ */
 export type TextFieldProps = {
+    /** The text it starts with. Read once, on mount — the field is uncontrolled. */
     defaultValue?: string;
+    /** Stops editing and dims the field. On iOS it outranks `error`. */
     disabled?: boolean;
+    /** Marks the field invalid: a destructive outline and label. */
     error?: boolean;
+    /** Shown above the field, in `labelMedium`. */
     label?: string;
+    /** Wraps the text and grows the field to fit it. iOS ignores it when `secure`. */
     multiline?: boolean;
+    /** Called with the whole text after every change. */
     onChangeText?: (text: string) => void;
+    /** Masks the text, for a password. */
     secure?: boolean;
+    /** iOS: forwarded to the native field. Android ignores it. */
     testID?: string;
 };
 export type TextFieldComponent = (props: TextFieldProps) => ReactNode;

package/lib/typescript/atoms/v-stack/v-stack.types.d.ts

@@ -2,11 +2,20 @@ import type { ResponsiveSx } from '@hzblj/kara-sx';
 import type { SpaceSize } from '@hzblj/kara-theme';
 import type { ReactNode } from 'react';
 export type VStackAlign = 'center' | 'end' | 'start';
+/** Stacks its children top to bottom — SwiftUI `VStack` / Compose `Column`. */
 export type VStackProps = ResponsiveSx & {
+    /** The children's horizontal alignment. `start` by default. */
     align?: VStackAlign;
+    /** Laid out top to bottom, `spacing` apart. */
     children?: ReactNode;
+    /**
+     * Makes the whole stack pressable. iOS adds a tap gesture with no press feedback; Android a `clickable` whose ripple
+     * fills the stack's shape.
+     */
     onPress?: () => void;
+    /** The space between children. */
     spacing?: SpaceSize;
+    /** Test identifier, forwarded to the native view. */
     testID?: string;
 };
 export type VStackComponent = (props: VStackProps) => ReactNode;

package/lib/typescript/atoms/z-stack/z-stack.types.d.ts

@@ -1,10 +1,18 @@
 import type { ResponsiveSx } from '@hzblj/kara-sx';
 import type { ReactNode } from 'react';
 export type ZStackAlign = 'bottom' | 'center' | 'top';
+/** Layers its children on one another — SwiftUI `ZStack` / Compose `Box`. */
 export type ZStackProps = ResponsiveSx & {
+    /** Where the children sit vertically; they are always centred horizontally. `center` by default. */
     align?: ZStackAlign;
+    /** Drawn in order, the last on top. */
     children?: ReactNode;
+    /**
+     * Makes the whole stack pressable. iOS adds a tap gesture with no press feedback; Android a `clickable` whose ripple
+     * fills the stack's shape.
+     */
     onPress?: () => void;
+    /** Test identifier, forwarded to the native view. */
     testID?: string;
 };
 export type ZStackComponent = (props: ZStackProps) => ReactNode;

package/lib/typescript/molecules/collapsible/collapsible.types.d.ts

@@ -1,8 +1,16 @@
 import type { ReactNode } from 'react';
+/**
+ * A row that shows and hides its content: SwiftUI's `DisclosureGroup` on iOS; on Android a pressable row with a
+ * chevron over an animated reveal. A native atom — it renders inside `<Screen>` or `<Island>`.
+ */
 export type CollapsibleProps = {
+    /** Shown while `expanded`. */
     children: ReactNode;
+    /** Whether the content is shown. Update it from `onExpandedChange`. */
     expanded: boolean;
+    /** The row's text. */
     label: string;
+    /** The user pressed the row; it passes the state the row asks for. */
     onExpandedChange: (expanded: boolean) => void;
 };
 export type CollapsibleComponent = (props: CollapsibleProps) => ReactNode;

package/lib/typescript/molecules/empty-state/empty-state.types.d.ts

@@ -5,10 +5,15 @@ import type { IconName } from '../../atoms/icon';
  * `action` takes a `Button` so the state can offer a way out.
  */
 export type EmptyStateProps = {
+    /** Under the text — a `Button`, say. */
     action?: ReactNode;
+    /** A second line under the title, in the secondary colour. */
     description?: string;
+    /** One of the app's icons, large and muted above the title. */
     icon?: IconName;
+    /** Test identifier, forwarded to the native view. */
     testID?: string;
+    /** The headline. */
     title: string;
 };
 export type EmptyStateComponent = (props: EmptyStateProps) => ReactNode;

package/lib/typescript/molecules/label/label.types.d.ts

@@ -6,11 +6,17 @@ import type { IconName } from '../../atoms/icon';
  * header. For a full tappable row with a subtitle and chevron, use `ListItem`.
  */
 export type LabelProps = {
+    /** Colours the icon and the title alike. `content.primary` by default. */
     color?: ColorToken;
+    /** One of the app's icons, before the title. */
     icon: IconName;
+    /** The icon's size. `s20` by default. */
     iconSize?: SpaceSize;
+    /** Test identifier, forwarded to the native view. */
     testID?: string;
+    /** The text beside the icon. */
     title: string;
+    /** The title's text style. `body` by default. */
     variant?: TextVariant;
 };
 export type LabelComponent = (props: LabelProps) => ReactNode;

package/lib/typescript/molecules/labeled-content/labeled-content.types.d.ts

@@ -6,13 +6,19 @@ import type { IconName } from '../../atoms/icon';
  * Pass `children` instead of `value` when the trailing side is a control rather than text.
  */
 export type LabeledContentProps = {
+    /** The trailing side when it is a control, in place of `value`. */
     children?: ReactNode;
+    /** One of the app's icons, before the label, in the secondary colour. */
     icon?: IconName;
+    /** The leading text. */
     label: string;
+    /** Makes the row pressable and adds a chevron on the trailing edge. */
     onPress?: () => void;
     /** Horizontal padding inside the row — inside its press area too, so Android's ripple reaches the card's edges. */
     px?: SpaceSize;
+    /** Test identifier, forwarded to the native view. */
     testID?: string;
+    /** The trailing text, in the secondary colour. Ignored when `children` is given. */
     value?: string;
 };
 export type LabeledContentComponent = (props: LabeledContentProps) => ReactNode;

package/lib/typescript/molecules/link/link.types.d.ts

@@ -3,11 +3,17 @@ import type { ReactNode } from 'react';
 import type { IconName } from '../../atoms/icon';
 /** Opens an external URL in the platform browser or the app that claims the scheme. */
 export type LinkProps = {
+    /** Colours the label and the icon. `content.accent` by default. */
     color?: ColorToken;
+    /** One of the app's icons, before the label. */
     icon?: IconName;
+    /** The link's text. */
     label: string;
+    /** Test identifier, forwarded to the native view. */
     testID?: string;
+    /** Opened through React Native's `Linking` on press. A URL nothing can open fails silently. */
     url: string;
+    /** The label's text style. `body` by default. */
     variant?: TextVariant;
 };
 export type LinkComponent = (props: LinkProps) => ReactNode;

package/lib/typescript/molecules/list-item/list-item.types.d.ts

@@ -1,16 +1,25 @@
 import type { SpaceSize } from '@hzblj/kara-theme';
 import type { ReactNode } from 'react';
 import type { IconName } from '../../atoms/icon';
+/**
+ * A row with an optional icon, a title and subtitle, and a chevron when it can be pressed. A native atom — it renders
+ * inside `<Screen>` or `<Island>`; `RnListItem` is the same row without a host.
+ */
 export type ListItemProps = {
+    /** One of the app's icons, before the title, in the secondary colour. */
     icon?: IconName;
+    /** Makes the row pressable and adds a chevron on the trailing edge. */
     onPress?: () => void;
     /**
      * Horizontal padding inside the row — inside its press area too, so Android's ripple reaches the card's edges. For
      * rows in a card of your own; a `List` insets its rows by itself.
      */
     px?: SpaceSize;
+    /** A second line under the title, smaller and in the secondary colour. */
     subtitle?: string;
+    /** Test identifier, forwarded to the row's view. */
     testID?: string;
+    /** The row's main text. */
     title: string;
 };
 export type ListItemComponent = (props: ListItemProps) => ReactNode;

package/lib/typescript/molecules/navigation-bar/navigation-bar.types.d.ts

@@ -1,6 +1,7 @@
 import type { ReactNode, Ref } from 'react';
 import type { IconName } from '../../atoms/icon';
 type NavigationBarItemBase = {
+    /** Called when the item is pressed. */
     onPress: () => void;
     /**
      * iOS 26: neighbouring items on one side share a glass capsule; this gives the item its own. A close next to
@@ -29,10 +30,15 @@ export type NavigationBarSearchRef = {
 };
 /** A search field in place of the title — iOS only for now; Android keeps the title. */
 export type NavigationBarSearch = {
+    /** Every edit of the field's text. */
     onChangeText: (text: string) => void;
+    /** The field gained or lost focus. */
     onFocusChange?: (focused: boolean) => void;
+    /** Shown while the field is empty. */
     placeholder: string;
+    /** Imperative `clear`. */
     ref?: Ref<NavigationBarSearchRef>;
+    /** Test identifier, forwarded to the native search field. */
     testID?: string;
 };
 export type NavigationBarTitleAlignment = 'center' | 'leading';
@@ -50,7 +56,9 @@ export type NavigationBarProps = {
     leadingItems?: NavigationBarItem[];
     /** Replaces the title with a search field (iOS). */
     search?: NavigationBarSearch;
+    /** Test identifier, forwarded to the native bar. iOS only — Android ignores it. */
     testID?: string;
+    /** The bar's title. */
     title?: string;
     /** `center` by default — iOS's own; `leading` is Material's top app bar. */
     titleAlignment?: NavigationBarTitleAlignment;

package/lib/typescript/molecules/pager/pager.types.d.ts

@@ -10,6 +10,7 @@ import type { ReactNode } from 'react';
  * ceremony would buy nothing.
  */
 export type PagerProps = {
+    /** The pages, one per child, in order. */
     children?: ReactNode;
     /**
      * Page dots. iOS draws SwiftUI's own, over the bottom edge; Compose has no built-in indicator, so
@@ -27,6 +28,7 @@ export type PagerProps = {
      * content down with the swipe, so iOS always stays swipeable.
      */
     scrollEnabled?: boolean;
+    /** Test identifier, forwarded to the native view. */
     testID?: string;
 };
 export type PagerComponent = (props: PagerProps) => ReactNode;

package/lib/typescript/molecules/radio-group/radio-group.types.d.ts

@@ -1,11 +1,21 @@
 import type { ReactNode } from 'react';
+/** One choice of a `RadioGroup`. */
 export type RadioOption = {
+    /** The option's text. */
     label: string;
+    /** Identifies the option to `value` and `onValueChange`, and keys its row — keep it unique. */
     value: string;
 };
+/**
+ * A single choice from a list: rows with a checkmark on the selected one on iOS, Material radio buttons on Android. A
+ * native atom — it renders inside `<Screen>` or `<Island>`.
+ */
 export type RadioGroupProps = {
+    /** The user pressed an option; it passes that option's `value`. */
     onValueChange?: (value: string) => void;
+    /** The choices, top to bottom. */
     options: RadioOption[];
+    /** The selected option's `value`. Update it from `onValueChange`. */
     value: string;
 };
 export type RadioGroupComponent = (props: RadioGroupProps) => ReactNode;

package/lib/typescript/molecules/rn-list-item/rn-list-item.types.d.ts

@@ -2,7 +2,7 @@ import type { ReactNode } from 'react';
 import type { ListItemProps } from '../list-item';
 /**
  * `ListItem`'s row in the React Native tier — plain views, no host. For lists long enough that a native host per row
- * would cost too much to mount (a navigation list, a FlashList of rows), with the platform's own press feedback: a
+ * would cost too much to mount (a navigation list, an `RnFlatList` of rows), with the platform's own press feedback: a
  * ripple across the whole row on Android, a highlight on iOS. In a rounded card, give the card `overflow="hidden"`:
  * Android draws the ripple as the row's foreground, which only a parent's clip keeps inside rounded corners.
  */

package/lib/typescript/molecules/rn-tooltip/rn-tooltip.types.d.ts

@@ -1,7 +1,10 @@
 import type { ReactElement, ReactNode } from 'react';
 export type RnTooltipActionVariant = 'link' | 'primary' | 'secondary';
+/** A button in an `RnTooltip`. */
 export type RnTooltipAction = {
+    /** The button's text. */
     label: string;
+    /** Called on press. The tooltip stays up — turn `visible` off here if the action should close it. */
     onPress: () => void;
     /** `link` by default — an underlined text. `primary`/`secondary` are small filled/outlined buttons. */
     variant?: RnTooltipActionVariant;
@@ -14,6 +17,7 @@ export type RnTooltipDismissReason = 'anchorHidden' | 'outside';
  * Native tier, unlike `Tooltip`, whose anchor is a native view inside a host.
  */
 export type RnTooltipProps = {
+    /** A row of buttons under the text, in order. */
     actions?: RnTooltipAction[];
     /** Which end of the bubble the actions sit at. `end` by default. */
     actionsAlignment?: 'end' | 'start';
@@ -27,11 +31,18 @@ export type RnTooltipProps = {
     };
     /** The anchor — a single React Native view. */
     children: ReactElement;
+    /** The body text, under the title. */
     message?: string;
+    /**
+     * Asks for the tooltip to close, with the reason — turn `visible` off. On Android any touch outside asks, the start
+     * of a scroll included; iOS keeps the tooltip through a scroll.
+     */
     onDismiss: (reason: RnTooltipDismissReason) => void;
     /** The appear animation finished. */
     onShown?: () => void;
+    /** The heading line, above the message. */
     title?: string;
+    /** Shows the tooltip while true. It never hides itself. */
     visible: boolean;
 };
 export type RnTooltipComponent = (props: RnTooltipProps) => ReactNode;

package/lib/typescript/molecules/scroll-edge-container/scroll-edge-container.types.d.ts

@@ -15,12 +15,15 @@ export type ScrollEdgeContainerProps = ResponsiveViewSx & {
      * content begins below the top bar and scrolls under it. On by default.
      */
     automaticInsets?: boolean;
+    /** Laid over the scroll view's bottom edge on iOS; stacked below it on Android, where it wants a background. */
     bottomBar?: ReactNode;
     /** Exactly one React Native scroll view — `RnScrollView`, `RnFlatList`, `RnSectionList`. */
     children: ReactElement<ScrollEdgeScrollableProps>;
     /** iOS 26: how hard the edge cuts. `soft` by default. */
     effect?: ScrollEdgeEffect;
+    /** Test identifier, forwarded to the container view. */
     testID?: string;
+    /** Laid over the scroll view's top edge on iOS; stacked above it on Android, where it wants a background. */
     topBar?: ReactNode;
 };
 export type ScrollEdgeContainerComponent = (props: ScrollEdgeContainerProps) => ReactNode;

package/lib/typescript/molecules/search-bar/search-bar.types.d.ts

@@ -1,8 +1,16 @@
 import type { ReactNode } from 'react';
+/**
+ * A search field drawn the same on both platforms — a rounded box with a magnifier, a `TextInput` and a clear button
+ * while there is text. The React Native tier: it needs no host.
+ */
 export type SearchBarProps = {
+    /** Every edit, and `''` when the clear button is pressed. */
     onChangeText?: (text: string) => void;
+    /** Shown while the field is empty. `Search` by default. */
     placeholder?: string;
+    /** Test identifier, put on the field's container view rather than on the `TextInput`. */
     testID?: string;
+    /** The field's text. Controlled — pass back what `onChangeText` reports. */
     value: string;
 };
 export type SearchBarComponent = (props: SearchBarProps) => ReactNode;

package/lib/typescript/molecules/stepper/stepper.types.d.ts

@@ -1,10 +1,23 @@
 import type { ReactNode } from 'react';
+/**
+ * A number with minus and plus buttons beside a label: SwiftUI's `Stepper` on iOS; on Android the label, the value and
+ * two icon buttons in a row. A native atom — it renders inside `<Screen>` or `<Island>`.
+ */
 export type StepperProps = {
+    /**
+     * The leading text. iOS shows only the label, not the value — put the value in it if it should be seen. Android
+     * shows the value between its buttons.
+     */
     label: string;
+    /** The highest value. When unset, Android has no upper limit and iOS stops at `100`. */
     max?: number;
+    /** The lowest value. When unset, Android has no lower limit and iOS stops at `0`. */
     min?: number;
+    /** A button was pressed; it passes the new value, kept within `min` and `max`. */
     onValueChange: (value: number) => void;
+    /** How much one press adds or takes away. `1` by default. */
     step?: number;
+    /** The current value. Update it from `onValueChange`. iOS's native stepper counts in whole numbers. */
     value: number;
 };
 export type StepperComponent = (props: StepperProps) => ReactNode;

package/lib/typescript/molecules/tooltip/tooltip.types.d.ts

@@ -1,8 +1,20 @@
 import type { ReactNode } from 'react';
+/**
+ * A short text tip on a native view, shown while `visible` — a SwiftUI popover from `children` on iOS, Material's plain
+ * tooltip centred above them on Android. A native atom — it renders inside `<Screen>` or `<Island>`; `RnTooltip`
+ * anchors to a React Native view.
+ */
 export type TooltipProps = {
+    /** The anchor — a native view. */
     children: ReactNode;
+    /** The tip. */
     text: string;
+    /** Shows the tip while true. Controlled: nothing opens it but this — wire a long press to it if you want one. */
     visible: boolean;
+    /**
+     * The user dismissed the tip — turn `visible` off. iOS: a tap outside the popover. Android: any touch outside it, the
+     * start of a scroll included, or the anchor scrolling out of the window.
+     */
     onDismiss: () => void;
 };
 export type TooltipComponent = (props: TooltipProps) => ReactNode;

package/lib/typescript/organisms/action-sheet/action-sheet.types.d.ts

@@ -1,9 +1,17 @@
 import type { ReactNode } from 'react';
 import type { MenuAction } from '../menu';
+/**
+ * A list of actions to pick one from: SwiftUI's confirmation dialog on iOS, a `Sheet` of Material rows — icon and label
+ * — under the title on Android. A native atom — it renders inside `<Screen>` or `<Island>`.
+ */
 export type ActionSheetProps = {
+    /** The choices, top to bottom. Picking one closes the sheet. */
     actions: MenuAction[];
+    /** The sheet closed — after a pick too — so turn `visible` off. */
     onDismiss: () => void;
+    /** The heading above the actions. Android always shows it; on iOS the system decides, and may hide it. */
     title: string;
+    /** Presents the sheet while true. */
     visible: boolean;
 };
 export type ActionSheetComponent = (props: ActionSheetProps) => ReactNode;

package/lib/typescript/organisms/alert/alert.types.d.ts

@@ -1,11 +1,22 @@
 import type { ReactNode } from 'react';
+/**
+ * A modal alert with a confirm button and Cancel: SwiftUI's alert on iOS, Material's `AlertDialog` on Android. A native
+ * atom — it renders inside `<Screen>` or `<Island>`.
+ */
 export type AlertProps = {
+    /** The confirm button's label. `OK` by default. */
     confirmLabel?: string;
+    /** Marks the confirm button destructive — the system's destructive role on iOS, the destructive colour on Android. */
     destructive?: boolean;
+    /** The body text, under the title. */
     message?: string;
+    /** The confirm button was pressed. `onDismiss` follows, as it does for every way the alert closes. */
     onConfirm?: () => void;
+    /** The alert closed — either button, or on Android a tap outside or back — so turn `visible` off. */
     onDismiss: () => void;
+    /** The alert's heading. */
     title: string;
+    /** Shows the alert while true. */
     visible: boolean;
 };
 export type AlertComponent = (props: AlertProps) => ReactNode;

package/lib/typescript/organisms/context-menu/context-menu.types.d.ts

@@ -9,6 +9,7 @@ import type { MenuAction } from '../menu';
  * needs no `Screen` or `Island`.
  */
 export type ContextMenuProps = ResponsiveViewSx & {
+    /** The menu's actions, top to bottom. */
     actions: MenuAction[];
     /** The trigger, laid out as usual. */
     children: ReactNode;
@@ -28,9 +29,12 @@ export type ContextMenuProps = ResponsiveViewSx & {
      * `ZoomTransition.Source`, `pop` otherwise.
      */
     previewTransition?: 'dismiss' | 'pop' | 'zoom';
+    /** Test identifier — on the native view around the trigger on iOS, on the trigger's `Pressable` on Android. */
     testID?: string;
 };
+/** A region of a `ContextMenu`'s trigger that keeps its own long press — see `ContextMenu.Exclusion`. */
 export type ContextMenuExclusionProps = {
+    /** The region — a button inside the card, say. */
     children: ReactNode;
 };
 export type ContextMenuComponent = ((props: ContextMenuProps) => ReactNode) & {

package/lib/typescript/organisms/fab-menu/fab-menu.types.d.ts

@@ -7,9 +7,11 @@ import type { MenuAction } from '../menu';
  * of a SwiftUI `Menu`. A native atom — it renders inside `<Screen>` or `<Island>`.
  */
 export type FabMenuProps = {
+    /** The actions the button unfolds into. */
     actions: MenuAction[];
     /** The closed button's icon — one of the app's. A plus by default. */
     icon?: IconName;
+    /** Test identifier, forwarded to the SwiftUI `Menu`. iOS only — Android ignores it. */
     testID?: string;
 };
 export type FabMenuComponent = (props: FabMenuProps) => ReactNode;

package/lib/typescript/organisms/form/form.types.d.ts

@@ -5,12 +5,18 @@ import type { ReactNode } from 'react';
  * an island that sizes itself to its content it has no height and shows nothing.
  */
 export type FormProps = {
+    /** The form's `Form.Section`s. */
     children: ReactNode;
+    /** Test identifier, forwarded to the native view. */
     testID?: string;
 };
+/** A group of rows in a `Form`: a SwiftUI `Section` on iOS, a `Card` under a heading on Android. */
 export type FormSectionProps = {
+    /** The section's rows. */
     children: ReactNode;
+    /** Small print under the section. */
     footer?: string;
+    /** The section's heading. */
     title?: string;
 };
 export type FormComponent = ((props: FormProps) => ReactNode) & {

package/lib/typescript/organisms/menu/menu.types.d.ts

@@ -1,13 +1,30 @@
 import type { ReactNode } from 'react';
 import type { IconName } from '../../atoms/icon';
+/** One action of a `Menu`, an `ActionSheet`, a `ContextMenu` or a `FabMenu`. */
 export type MenuAction = {
+    /**
+     * Draws the action in the destructive colour — the system's destructive role on iOS. `FabMenu` ignores it on
+     * Android.
+     */
     destructive?: boolean;
+    /**
+     * One of the app's icons, before the label. `ContextMenu` and `FabMenu` show it on both platforms, `Menu` and
+     * `ActionSheet` on Android only.
+     */
     icon?: IconName;
+    /** The action's text. Rows are keyed by it, so keep labels unique within one list. */
     label: string;
+    /** Called when the action is chosen; the menu closes by itself. */
     onPress: () => void;
 };
+/**
+ * A text button that opens a list of actions: a SwiftUI `Menu` on iOS, a Material dropdown anchored to it on Android.
+ * A native atom — it renders inside `<Screen>` or `<Island>`.
+ */
 export type MenuProps = {
+    /** The menu's actions, top to bottom. */
     actions: MenuAction[];
+    /** The trigger's text. Android draws it in the accent colour, with a chevron. */
     label: string;
 };
 export type MenuComponent = (props: MenuProps) => ReactNode;

package/lib/typescript/organisms/sheet/sheet.types.d.ts

@@ -24,13 +24,16 @@ export type SheetHeaderProps = {
     leadingItems?: NavigationBarItem[];
     /** A search field in place of the title (iOS). */
     search?: NavigationBarSearch;
+    /** The title — in the bar, or above the content with a `large` `titleStyle`. */
     title?: string;
     /** `center` by default. */
     titleStyle?: SheetTitleStyle;
     /** In screen order, toward the trailing edge — the close item, by convention. */
     trailingItems?: NavigationBarItem[];
 };
+/** Imperative control of a `Sheet`, through its `ref`. */
 export type SheetRef = {
+    /** Dismisses it without calling `onDismiss`, which reports the user's dismissals only. */
     dismiss: () => Promise<void>;
     /** Presents at a detent — the first by default. */
     present: (detentIndex?: number) => Promise<void>;
@@ -45,6 +48,7 @@ export type SheetRef = {
 export type SheetProps = {
     /** The sheet's colour. `surface.primary` by default. */
     bg?: ColorToken;
+    /** The content. A `<Sheet.Header>` among the direct children becomes the native header instead. */
     children: ReactNode;
     /** Where the sheet can rest, smallest first. `['auto']` — fit the content — by default. */
     detents?: SheetDetent[];
@@ -60,29 +64,44 @@ export type SheetProps = {
     grabber?: boolean;
     /** The user dismissed it — `visible` going false does not call this. */
     onDismiss: () => void;
+    /** The sheet moved to another detent — its index in `detents`. */
     onDetentChange?: (detentIndex: number) => void;
+    /** The sheet finished presenting. */
     onPresent?: () => void;
+    /** `present`, `dismiss` and `resize`, for driving the sheet imperatively. */
     ref?: Ref<SheetRef>;
     /**
      * The content is a scroll view (`<Sheet.ScrollView>`) the sheet drives: dragging past its top resizes the sheet,
      * and a header scrolls with the iOS 26 edge effect. Off by default — set it with a scrolling body.
      */
     scrollable?: boolean;
+    /** Test identifier, forwarded to the native sheet. */
     testID?: string;
+    /** Presents the sheet while true; going false dismisses it. */
     visible: boolean;
 };
 export type SheetScrollHandler = (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
 /** What a scroll view inside a sheet needs: the room the header takes, the large title, the scroll listener. */
 export type SheetScrollContextValue = {
+    /** Render it first in the content. `null` unless the header's `titleStyle` is `large`. */
     largeTitle: ReactNode;
+    /** Forward the scroll view's scroll events to it — it tracks the large title. Unset when there is none. */
     onScroll?: SheetScrollHandler;
+    /** The room an overlaid header takes, to add to the content's top padding. `0` where the header sits above it. */
     topInset: number;
 };
+/**
+ * The body of a `scrollable` sheet: its content starts below an overlaid header, it carries a large title, and it
+ * reports its scroll to the sheet.
+ */
 export type SheetScrollViewProps = Pick<ScrollViewProps, 'keyboardShouldPersistTaps'> & {
+    /** The scrolling content, after the large title if there is one. */
     children: ReactNode;
     /** Styles the scrolling content — padding and gap belong here, as with `RnScrollView`. */
     content?: ResponsiveViewSx;
+    /** Called on every scroll event, after the sheet's own listener. */
     onScroll?: SheetScrollHandler;
+    /** Test identifier, forwarded to the scroll view. */
     testID?: string;
 };
 export type SheetComponent = ((props: SheetProps) => ReactNode) & {

package/lib/typescript/organisms/snackbar/snackbar.types.d.ts

@@ -1,8 +1,16 @@
 import type { ReactNode } from 'react';
+/**
+ * A short message laid over the bottom of its parent, with an optional action. The React Native tier, drawn the same on
+ * both platforms: it needs no host, and it never hides itself.
+ */
 export type SnackbarProps = {
+    /** The action button's text, on the trailing side. No button without it. */
     actionLabel?: string;
+    /** The message. */
     message: string;
+    /** The action was pressed. The snackbar stays up — turn `visible` off to hide it. */
     onAction?: () => void;
+    /** Shows the snackbar while true, fading it in and out. It sets no timer of its own. */
     visible: boolean;
 };
 export type SnackbarComponent = (props: SnackbarProps) => ReactNode;