@hzblj/kara-components 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. package/CHANGELOG.md +49 -0
  2. package/README.md +31 -3
  3. package/lib/module/atoms/checkbox/checkbox.android.js +7 -3
  4. package/lib/module/atoms/checkbox/checkbox.android.js.map +1 -1
  5. package/lib/module/atoms/date-picker/date-picker.ios.js +32 -11
  6. package/lib/module/atoms/date-picker/date-picker.ios.js.map +1 -1
  7. package/lib/module/atoms/index.js +0 -1
  8. package/lib/module/atoms/index.js.map +1 -1
  9. package/lib/module/atoms/rn-flat-list/rn-flat-list.js +10 -9
  10. package/lib/module/atoms/rn-flat-list/rn-flat-list.js.map +1 -1
  11. package/lib/module/atoms/rn-section-list/rn-section-list.js +5 -8
  12. package/lib/module/atoms/rn-section-list/rn-section-list.js.map +1 -1
  13. package/lib/module/atoms/segmented-control/index.js +1 -1
  14. package/lib/module/atoms/segmented-control/index.js.map +1 -1
  15. package/lib/module/atoms/segmented-control/segmented-control.android.js +74 -0
  16. package/lib/module/atoms/segmented-control/segmented-control.android.js.map +1 -0
  17. package/lib/module/atoms/segmented-control/segmented-control.ios.js +44 -0
  18. package/lib/module/atoms/segmented-control/segmented-control.ios.js.map +1 -0
  19. package/lib/module/atoms/switch/switch.android.js +4 -1
  20. package/lib/module/atoms/switch/switch.android.js.map +1 -1
  21. package/lib/module/molecules/search-bar/search-bar.js +15 -2
  22. package/lib/module/molecules/search-bar/search-bar.js.map +1 -1
  23. package/lib/module/molecules/tooltip/tooltip.android.js +16 -5
  24. package/lib/module/molecules/tooltip/tooltip.android.js.map +1 -1
  25. package/lib/module/organisms/action-sheet/action-sheet.android.js +41 -20
  26. package/lib/module/organisms/action-sheet/action-sheet.android.js.map +1 -1
  27. package/lib/module/organisms/action-sheet/action-sheet.ios.js +24 -8
  28. package/lib/module/organisms/action-sheet/action-sheet.ios.js.map +1 -1
  29. package/lib/module/organisms/alert/alert.ios.js +15 -2
  30. package/lib/module/organisms/alert/alert.ios.js.map +1 -1
  31. package/lib/module/organisms/form/form.android.js +22 -9
  32. package/lib/module/organisms/form/form.android.js.map +1 -1
  33. package/lib/module/organisms/swipe-actions/swipe-actions.android.js +125 -11
  34. package/lib/module/organisms/swipe-actions/swipe-actions.android.js.map +1 -1
  35. package/lib/module/organisms/swipe-actions/swipe-actions.ios.js +46 -18
  36. package/lib/module/organisms/swipe-actions/swipe-actions.ios.js.map +1 -1
  37. package/lib/module/templates/screen/screen.android.js +31 -10
  38. package/lib/module/templates/screen/screen.android.js.map +1 -1
  39. package/lib/typescript/atoms/avatar/avatar.types.d.ts +5 -0
  40. package/lib/typescript/atoms/badge/badge.types.d.ts +3 -0
  41. package/lib/typescript/atoms/button/button.types.d.ts +12 -0
  42. package/lib/typescript/atoms/card/card.types.d.ts +6 -0
  43. package/lib/typescript/atoms/checkbox/checkbox.types.d.ts +5 -0
  44. package/lib/typescript/atoms/chip/chip.types.d.ts +5 -0
  45. package/lib/typescript/atoms/color-picker/color-picker.types.d.ts +4 -0
  46. package/lib/typescript/atoms/date-picker/date-picker.ios.d.ts +6 -1
  47. package/lib/typescript/atoms/date-picker/date-picker.types.d.ts +14 -0
  48. package/lib/typescript/atoms/divider/divider.types.d.ts +3 -0
  49. package/lib/typescript/atoms/fab/fab.types.d.ts +7 -0
  50. package/lib/typescript/atoms/glass-view/glass-view.types.d.ts +1 -0
  51. package/lib/typescript/atoms/h-stack/h-stack.types.d.ts +6 -0
  52. package/lib/typescript/atoms/icon/icon.types.d.ts +8 -0
  53. package/lib/typescript/atoms/icon-button/icon-button.types.d.ts +5 -0
  54. package/lib/typescript/atoms/index.d.ts +0 -1
  55. package/lib/typescript/atoms/island/island.types.d.ts +4 -0
  56. package/lib/typescript/atoms/list/list.types.d.ts +2 -0
  57. package/lib/typescript/atoms/picker/picker.types.d.ts +12 -0
  58. package/lib/typescript/atoms/pressable/pressable.types.d.ts +8 -0
  59. package/lib/typescript/atoms/progress/progress.types.d.ts +6 -0
  60. package/lib/typescript/atoms/rn-flat-list/rn-flat-list.d.ts +5 -8
  61. package/lib/typescript/atoms/rn-flat-list/rn-flat-list.types.d.ts +3 -1
  62. package/lib/typescript/atoms/rn-scroll-view/rn-scroll-view.types.d.ts +4 -0
  63. package/lib/typescript/atoms/rn-section-list/rn-section-list.d.ts +2 -8
  64. package/lib/typescript/atoms/rn-section-list/rn-section-list.types.d.ts +3 -1
  65. package/lib/typescript/atoms/rn-text/rn-text.types.d.ts +4 -0
  66. package/lib/typescript/atoms/rn-view/rn-view.types.d.ts +2 -0
  67. package/lib/typescript/atoms/scroll-view/scroll-view.types.d.ts +4 -0
  68. package/lib/typescript/atoms/segmented-control/segmented-control.d.ts +1 -6
  69. package/lib/typescript/atoms/segmented-control/segmented-control.ios.d.ts +7 -0
  70. package/lib/typescript/atoms/segmented-control/segmented-control.types.d.ts +13 -0
  71. package/lib/typescript/atoms/skeleton/skeleton.types.d.ts +5 -0
  72. package/lib/typescript/atoms/slider/slider.types.d.ts +7 -0
  73. package/lib/typescript/atoms/spacer/spacer.types.d.ts +3 -0
  74. package/lib/typescript/atoms/surface/surface.types.d.ts +7 -0
  75. package/lib/typescript/atoms/switch/switch.types.d.ts +8 -0
  76. package/lib/typescript/atoms/text/text.types.d.ts +12 -0
  77. package/lib/typescript/atoms/text-field/text-field.types.d.ts +12 -0
  78. package/lib/typescript/atoms/v-stack/v-stack.types.d.ts +9 -0
  79. package/lib/typescript/atoms/z-stack/z-stack.types.d.ts +8 -0
  80. package/lib/typescript/molecules/collapsible/collapsible.types.d.ts +8 -0
  81. package/lib/typescript/molecules/empty-state/empty-state.types.d.ts +5 -0
  82. package/lib/typescript/molecules/label/label.types.d.ts +6 -0
  83. package/lib/typescript/molecules/labeled-content/labeled-content.types.d.ts +6 -0
  84. package/lib/typescript/molecules/link/link.types.d.ts +6 -0
  85. package/lib/typescript/molecules/list-item/list-item.types.d.ts +9 -0
  86. package/lib/typescript/molecules/navigation-bar/navigation-bar.types.d.ts +8 -0
  87. package/lib/typescript/molecules/pager/pager.types.d.ts +2 -0
  88. package/lib/typescript/molecules/radio-group/radio-group.types.d.ts +10 -0
  89. package/lib/typescript/molecules/rn-list-item/rn-list-item.types.d.ts +1 -1
  90. package/lib/typescript/molecules/rn-tooltip/rn-tooltip.types.d.ts +11 -0
  91. package/lib/typescript/molecules/scroll-edge-container/scroll-edge-container.types.d.ts +3 -0
  92. package/lib/typescript/molecules/search-bar/search-bar.types.d.ts +8 -0
  93. package/lib/typescript/molecules/stepper/stepper.types.d.ts +13 -0
  94. package/lib/typescript/molecules/tooltip/tooltip.types.d.ts +12 -0
  95. package/lib/typescript/organisms/action-sheet/action-sheet.types.d.ts +8 -0
  96. package/lib/typescript/organisms/alert/alert.types.d.ts +11 -0
  97. package/lib/typescript/organisms/context-menu/context-menu.types.d.ts +4 -0
  98. package/lib/typescript/organisms/fab-menu/fab-menu.types.d.ts +2 -0
  99. package/lib/typescript/organisms/form/form.types.d.ts +6 -0
  100. package/lib/typescript/organisms/menu/menu.types.d.ts +17 -0
  101. package/lib/typescript/organisms/sheet/sheet.types.d.ts +19 -0
  102. package/lib/typescript/organisms/snackbar/snackbar.types.d.ts +8 -0
  103. package/lib/typescript/organisms/swipe-actions/swipe-actions.types.d.ts +36 -13
  104. package/lib/typescript/templates/screen/screen.types.d.ts +9 -0
  105. package/package.json +5 -7
  106. package/src/atoms/avatar/avatar.types.ts +5 -0
  107. package/src/atoms/badge/badge.types.ts +3 -0
  108. package/src/atoms/button/button.types.ts +12 -0
  109. package/src/atoms/card/card.types.ts +6 -0
  110. package/src/atoms/checkbox/checkbox.android.tsx +7 -3
  111. package/src/atoms/checkbox/checkbox.types.ts +5 -0
  112. package/src/atoms/chip/chip.types.ts +5 -0
  113. package/src/atoms/color-picker/color-picker.types.ts +4 -0
  114. package/src/atoms/date-picker/date-picker.ios.tsx +33 -13
  115. package/src/atoms/date-picker/date-picker.types.ts +14 -0
  116. package/src/atoms/divider/divider.types.ts +3 -0
  117. package/src/atoms/fab/fab.types.ts +7 -0
  118. package/src/atoms/glass-view/glass-view.types.ts +1 -0
  119. package/src/atoms/h-stack/h-stack.types.ts +6 -0
  120. package/src/atoms/icon/icon.types.ts +8 -0
  121. package/src/atoms/icon-button/icon-button.types.ts +5 -0
  122. package/src/atoms/index.ts +0 -1
  123. package/src/atoms/island/island.types.ts +4 -0
  124. package/src/atoms/list/list.types.ts +2 -0
  125. package/src/atoms/picker/picker.types.ts +12 -0
  126. package/src/atoms/pressable/pressable.types.ts +8 -0
  127. package/src/atoms/progress/progress.types.ts +6 -0
  128. package/src/atoms/rn-flat-list/rn-flat-list.tsx +8 -8
  129. package/src/atoms/rn-flat-list/rn-flat-list.types.ts +3 -1
  130. package/src/atoms/rn-scroll-view/rn-scroll-view.types.ts +4 -0
  131. package/src/atoms/rn-section-list/rn-section-list.tsx +5 -8
  132. package/src/atoms/rn-section-list/rn-section-list.types.ts +3 -1
  133. package/src/atoms/rn-text/rn-text.types.ts +4 -0
  134. package/src/atoms/rn-view/rn-view.types.ts +2 -0
  135. package/src/atoms/scroll-view/scroll-view.types.ts +4 -0
  136. package/src/atoms/segmented-control/segmented-control.android.tsx +79 -0
  137. package/src/atoms/segmented-control/segmented-control.ios.tsx +47 -0
  138. package/src/atoms/segmented-control/segmented-control.types.ts +13 -0
  139. package/src/atoms/skeleton/skeleton.types.ts +5 -0
  140. package/src/atoms/slider/slider.types.ts +7 -0
  141. package/src/atoms/spacer/spacer.types.ts +3 -0
  142. package/src/atoms/surface/surface.types.ts +7 -0
  143. package/src/atoms/switch/switch.android.tsx +4 -1
  144. package/src/atoms/switch/switch.types.ts +8 -0
  145. package/src/atoms/text/text.types.ts +12 -0
  146. package/src/atoms/text-field/text-field.types.ts +12 -0
  147. package/src/atoms/v-stack/v-stack.types.ts +9 -0
  148. package/src/atoms/z-stack/z-stack.types.ts +8 -0
  149. package/src/molecules/collapsible/collapsible.types.ts +8 -0
  150. package/src/molecules/empty-state/empty-state.types.ts +5 -0
  151. package/src/molecules/label/label.types.ts +6 -0
  152. package/src/molecules/labeled-content/labeled-content.types.ts +6 -0
  153. package/src/molecules/link/link.types.ts +6 -0
  154. package/src/molecules/list-item/list-item.types.ts +9 -0
  155. package/src/molecules/navigation-bar/navigation-bar.types.ts +8 -0
  156. package/src/molecules/pager/pager.types.ts +2 -0
  157. package/src/molecules/radio-group/radio-group.types.ts +10 -0
  158. package/src/molecules/rn-list-item/rn-list-item.types.ts +1 -1
  159. package/src/molecules/rn-tooltip/rn-tooltip.types.ts +11 -0
  160. package/src/molecules/scroll-edge-container/scroll-edge-container.types.ts +3 -0
  161. package/src/molecules/search-bar/search-bar.tsx +9 -2
  162. package/src/molecules/search-bar/search-bar.types.ts +8 -0
  163. package/src/molecules/stepper/stepper.types.ts +13 -0
  164. package/src/molecules/tooltip/tooltip.android.tsx +17 -9
  165. package/src/molecules/tooltip/tooltip.types.ts +12 -0
  166. package/src/organisms/action-sheet/action-sheet.android.tsx +37 -19
  167. package/src/organisms/action-sheet/action-sheet.ios.tsx +22 -9
  168. package/src/organisms/action-sheet/action-sheet.types.ts +8 -0
  169. package/src/organisms/alert/alert.ios.tsx +11 -1
  170. package/src/organisms/alert/alert.types.ts +11 -0
  171. package/src/organisms/context-menu/context-menu.types.ts +4 -0
  172. package/src/organisms/fab-menu/fab-menu.types.ts +2 -0
  173. package/src/organisms/form/form.android.tsx +15 -7
  174. package/src/organisms/form/form.types.ts +6 -0
  175. package/src/organisms/menu/menu.types.ts +17 -0
  176. package/src/organisms/sheet/sheet.types.ts +19 -0
  177. package/src/organisms/snackbar/snackbar.types.ts +8 -0
  178. package/src/organisms/swipe-actions/swipe-actions.android.tsx +129 -9
  179. package/src/organisms/swipe-actions/swipe-actions.ios.tsx +45 -11
  180. package/src/organisms/swipe-actions/swipe-actions.types.ts +37 -14
  181. package/src/templates/screen/screen.android.tsx +33 -12
  182. package/src/templates/screen/screen.types.ts +9 -0
  183. package/lib/module/atoms/flash-list/flash-list.js +0 -31
  184. package/lib/module/atoms/flash-list/flash-list.js.map +0 -1
  185. package/lib/module/atoms/flash-list/flash-list.types.js +0 -4
  186. package/lib/module/atoms/flash-list/flash-list.types.js.map +0 -1
  187. package/lib/module/atoms/flash-list/index.js +0 -5
  188. package/lib/module/atoms/flash-list/index.js.map +0 -1
  189. package/lib/module/atoms/segmented-control/segmented-control.js +0 -40
  190. package/lib/module/atoms/segmented-control/segmented-control.js.map +0 -1
  191. package/lib/typescript/atoms/flash-list/flash-list.d.ts +0 -8
  192. package/lib/typescript/atoms/flash-list/flash-list.types.d.ts +0 -18
  193. package/lib/typescript/atoms/flash-list/index.d.ts +0 -2
  194. package/src/atoms/flash-list/flash-list.tsx +0 -28
  195. package/src/atoms/flash-list/flash-list.types.ts +0 -20
  196. package/src/atoms/flash-list/index.ts +0 -2
  197. package/src/atoms/segmented-control/segmented-control.tsx +0 -47
@@ -2,8 +2,11 @@ import type {ReactElement, ReactNode} from 'react'
2
2
 
3
3
  export type RnTooltipActionVariant = 'link' | 'primary' | 'secondary'
4
4
 
5
+ /** A button in an `RnTooltip`. */
5
6
  export type RnTooltipAction = {
7
+ /** The button's text. */
6
8
  label: string
9
+ /** Called on press. The tooltip stays up — turn `visible` off here if the action should close it. */
7
10
  onPress: () => void
8
11
  /** `link` by default — an underlined text. `primary`/`secondary` are small filled/outlined buttons. */
9
12
  variant?: RnTooltipActionVariant
@@ -18,6 +21,7 @@ export type RnTooltipDismissReason = 'anchorHidden' | 'outside'
18
21
  * Native tier, unlike `Tooltip`, whose anchor is a native view inside a host.
19
22
  */
20
23
  export type RnTooltipProps = {
24
+ /** A row of buttons under the text, in order. */
21
25
  actions?: RnTooltipAction[]
22
26
  /** Which end of the bubble the actions sit at. `end` by default. */
23
27
  actionsAlignment?: 'end' | 'start'
@@ -28,11 +32,18 @@ export type RnTooltipProps = {
28
32
  boundaryInsets?: {bottom?: number; top?: number}
29
33
  /** The anchor — a single React Native view. */
30
34
  children: ReactElement
35
+ /** The body text, under the title. */
31
36
  message?: string
37
+ /**
38
+ * Asks for the tooltip to close, with the reason — turn `visible` off. On Android any touch outside asks, the start
39
+ * of a scroll included; iOS keeps the tooltip through a scroll.
40
+ */
32
41
  onDismiss: (reason: RnTooltipDismissReason) => void
33
42
  /** The appear animation finished. */
34
43
  onShown?: () => void
44
+ /** The heading line, above the message. */
35
45
  title?: string
46
+ /** Shows the tooltip while true. It never hides itself. */
36
47
  visible: boolean
37
48
  }
38
49
 
@@ -17,12 +17,15 @@ export type ScrollEdgeContainerProps = ResponsiveViewSx & {
17
17
  * content begins below the top bar and scrolls under it. On by default.
18
18
  */
19
19
  automaticInsets?: boolean
20
+ /** Laid over the scroll view's bottom edge on iOS; stacked below it on Android, where it wants a background. */
20
21
  bottomBar?: ReactNode
21
22
  /** Exactly one React Native scroll view — `RnScrollView`, `RnFlatList`, `RnSectionList`. */
22
23
  children: ReactElement<ScrollEdgeScrollableProps>
23
24
  /** iOS 26: how hard the edge cuts. `soft` by default. */
24
25
  effect?: ScrollEdgeEffect
26
+ /** Test identifier, forwarded to the container view. */
25
27
  testID?: string
28
+ /** Laid over the scroll view's top edge on iOS; stacked above it on Android, where it wants a background. */
26
29
  topBar?: ReactNode
27
30
  }
28
31
 
@@ -1,5 +1,5 @@
1
1
  import {useAppTheme} from '@hzblj/kara-theme'
2
- import {TextInput} from 'react-native'
2
+ import {Platform, TextInput} from 'react-native'
3
3
 
4
4
  import {Box} from '../../atoms/box'
5
5
  import {Pressable} from '../../atoms/pressable'
@@ -13,6 +13,13 @@ export const SearchBar: SearchBarComponent = ({
13
13
  value,
14
14
  }: SearchBarProps) => {
15
15
  const theme = useAppTheme()
16
+ const {lineHeight, ...face} = theme.typography.body
17
+ /**
18
+ * A single-line `UITextField` sets its text against the bottom of a line taller than the font, so the variant's
19
+ * `lineHeight` pushed the text below the magnifier beside it. iOS takes the face without it, in a field as tall as
20
+ * the line would have been; Android centres the line and keeps it.
21
+ */
22
+ const text = Platform.OS === 'ios' ? {...face, height: lineHeight} : theme.typography.body
16
23
 
17
24
  return (
18
25
  <Box
@@ -31,7 +38,7 @@ export const SearchBar: SearchBarComponent = ({
31
38
  onChangeText={onChangeText}
32
39
  placeholder={placeholder}
33
40
  placeholderTextColor={theme.color('content.quaternary')}
34
- style={[theme.typography.body, {color: theme.color('content.primary'), flex: 1, padding: 0}]}
41
+ style={[text, {color: theme.color('content.primary'), flex: 1, padding: 0}]}
35
42
  value={value}
36
43
  />
37
44
  {value.length > 0 ? (
@@ -1,9 +1,17 @@
1
1
  import type {ReactNode} from 'react'
2
2
 
3
+ /**
4
+ * A search field drawn the same on both platforms — a rounded box with a magnifier, a `TextInput` and a clear button
5
+ * while there is text. The React Native tier: it needs no host.
6
+ */
3
7
  export type SearchBarProps = {
8
+ /** Every edit, and `''` when the clear button is pressed. */
4
9
  onChangeText?: (text: string) => void
10
+ /** Shown while the field is empty. `Search` by default. */
5
11
  placeholder?: string
12
+ /** Test identifier, put on the field's container view rather than on the `TextInput`. */
6
13
  testID?: string
14
+ /** The field's text. Controlled — pass back what `onChangeText` reports. */
7
15
  value: string
8
16
  }
9
17
 
@@ -1,11 +1,24 @@
1
1
  import type {ReactNode} from 'react'
2
2
 
3
+ /**
4
+ * A number with minus and plus buttons beside a label: SwiftUI's `Stepper` on iOS; on Android the label, the value and
5
+ * two icon buttons in a row. A native atom — it renders inside `<Screen>` or `<Island>`.
6
+ */
3
7
  export type StepperProps = {
8
+ /**
9
+ * The leading text. iOS shows only the label, not the value — put the value in it if it should be seen. Android
10
+ * shows the value between its buttons.
11
+ */
4
12
  label: string
13
+ /** The highest value. When unset, Android has no upper limit and iOS stops at `100`. */
5
14
  max?: number
15
+ /** The lowest value. When unset, Android has no lower limit and iOS stops at `0`. */
6
16
  min?: number
17
+ /** A button was pressed; it passes the new value, kept within `min` and `max`. */
7
18
  onValueChange: (value: number) => void
19
+ /** How much one press adds or takes away. `1` by default. */
8
20
  step?: number
21
+ /** The current value. Update it from `onValueChange`. iOS's native stepper counts in whole numbers. */
9
22
  value: number
10
23
  }
11
24
 
@@ -1,24 +1,32 @@
1
- import {Text as ComposeText, TooltipBox} from '@expo/ui/jetpack-compose'
1
+ import {Text as ComposeText} from '@expo/ui/jetpack-compose'
2
+ import {TooltipBox} from '@hzblj/kara-native/jetpack-compose'
2
3
  import {useAppTheme} from '@hzblj/kara-theme'
4
+ import {useCallback} from 'react'
3
5
 
4
6
  import {useHostGuard} from '../../host-context'
5
7
  import type {TooltipComponent, TooltipProps} from './tooltip.types'
6
8
 
7
- export const Tooltip: TooltipComponent = ({children, text}: TooltipProps) => {
9
+ /**
10
+ * Material's plain tooltip in kara's controlled `TooltipBox`: shown while `visible`, centred above the anchor and kept
11
+ * inside the window. Material's own would open on a long press and hide itself without a word to JS.
12
+ */
13
+ export const Tooltip: TooltipComponent = ({children, onDismiss, text, visible}: TooltipProps) => {
8
14
  useHostGuard('Tooltip')
9
-
10
15
  const theme = useAppTheme()
16
+ const onDismissRequest = useCallback(() => onDismiss(), [onDismiss])
11
17
 
12
18
  return (
13
- <TooltipBox>
14
- <TooltipBox.PlainTooltip
15
- containerColor={theme.colorString('surface.high.contrast')}
16
- contentColor={theme.colorString('content.on.high.contrast')}
17
- >
19
+ <TooltipBox
20
+ containerColor={theme.color('surface.high.contrast')}
21
+ isPresented={visible}
22
+ onDismissRequest={onDismissRequest}
23
+ plain
24
+ >
25
+ <TooltipBox.Text>
18
26
  <ComposeText color={theme.colorString('content.on.high.contrast')} style={theme.typography.footnote}>
19
27
  {text}
20
28
  </ComposeText>
21
- </TooltipBox.PlainTooltip>
29
+ </TooltipBox.Text>
22
30
  {children}
23
31
  </TooltipBox>
24
32
  )
@@ -1,9 +1,21 @@
1
1
  import type {ReactNode} from 'react'
2
2
 
3
+ /**
4
+ * A short text tip on a native view, shown while `visible` — a SwiftUI popover from `children` on iOS, Material's plain
5
+ * tooltip centred above them on Android. A native atom — it renders inside `<Screen>` or `<Island>`; `RnTooltip`
6
+ * anchors to a React Native view.
7
+ */
3
8
  export type TooltipProps = {
9
+ /** The anchor — a native view. */
4
10
  children: ReactNode
11
+ /** The tip. */
5
12
  text: string
13
+ /** Shows the tip while true. Controlled: nothing opens it but this — wire a long press to it if you want one. */
6
14
  visible: boolean
15
+ /**
16
+ * The user dismissed the tip — turn `visible` off. iOS: a tap outside the popover. Android: any touch outside it, the
17
+ * start of a scroll included, or the anchor scrolling out of the window.
18
+ */
7
19
  onDismiss: () => void
8
20
  }
9
21
 
@@ -1,35 +1,53 @@
1
- import {Divider} from '../../atoms/divider'
2
1
  import {HStack} from '../../atoms/h-stack'
2
+ import {Icon} from '../../atoms/icon'
3
+ import {Island} from '../../atoms/island'
3
4
  import {Text} from '../../atoms/text'
4
5
  import {VStack} from '../../atoms/v-stack'
5
6
  import {useHostGuard} from '../../host-context'
6
7
  import {Sheet} from '../sheet'
7
8
  import type {ActionSheetComponent, ActionSheetProps} from './action-sheet.types'
8
9
 
10
+ /**
11
+ * Material's bottom-sheet menu: the title, then a full-width row per action, its icon leading. The sheet is the React
12
+ * Native tier, so the rows — Compose views — sit in an `Island` of their own; rendered straight into the sheet they had
13
+ * no host and threw.
14
+ */
9
15
  export const ActionSheet: ActionSheetComponent = ({actions, onDismiss, title, visible}: ActionSheetProps) => {
10
16
  useHostGuard('ActionSheet')
11
17
 
12
18
  return (
13
19
  <Sheet onDismiss={onDismiss} visible={visible}>
14
- <VStack p="s16" spacing="s4" wide>
15
- <Text color="content.secondary" variant="labelMedium">
16
- {title}
17
- </Text>
18
- <Divider />
19
- {actions.map(action => (
20
- <HStack
21
- key={action.label}
22
- onPress={() => {
23
- onDismiss()
24
- action.onPress()
25
- }}
26
- py="s12"
27
- wide
28
- >
29
- <Text color={action.destructive ? 'content.destructive' : 'content.primary'}>{action.label}</Text>
20
+ <Island>
21
+ <VStack pb="s16" wide>
22
+ <HStack px="s24" py="s12" wide>
23
+ <Text color="content.secondary" variant="labelMedium">
24
+ {title}
25
+ </Text>
30
26
  </HStack>
31
- ))}
32
- </VStack>
27
+ {actions.map(action => {
28
+ const color = action.destructive ? 'content.destructive' : 'content.primary'
29
+
30
+ return (
31
+ <HStack
32
+ key={action.label}
33
+ onPress={() => {
34
+ onDismiss()
35
+ action.onPress()
36
+ }}
37
+ px="s24"
38
+ py="s16"
39
+ spacing="s16"
40
+ wide
41
+ >
42
+ {action.icon ? <Icon color={color} name={action.icon} /> : null}
43
+ <Text color={color} variant="body">
44
+ {action.label}
45
+ </Text>
46
+ </HStack>
47
+ )
48
+ })}
49
+ </VStack>
50
+ </Island>
33
51
  </Sheet>
34
52
  )
35
53
  }
@@ -1,8 +1,16 @@
1
- import {Button, ConfirmationDialog} from '@expo/ui/swift-ui'
1
+ import {Button, ConfirmationDialog, Spacer} from '@expo/ui/swift-ui'
2
+ import {frame} from '@expo/ui/swift-ui/modifiers'
2
3
 
3
4
  import {useHostGuard} from '../../host-context'
4
5
  import type {ActionSheetComponent, ActionSheetProps} from './action-sheet.types'
5
6
 
7
+ /**
8
+ * `@expo/ui` hangs the dialog on its `Trigger` and reads the buttons from its `Actions` slot. Without a trigger it
9
+ * attaches to an `EmptyView`, which SwiftUI never presents from — a spacer framed to nothing is a real view that takes
10
+ * no room.
11
+ */
12
+ const ANCHOR = [frame({height: 0, width: 0})]
13
+
6
14
  export const ActionSheet: ActionSheetComponent = ({actions, onDismiss, title, visible}: ActionSheetProps) => {
7
15
  useHostGuard('ActionSheet')
8
16
 
@@ -16,14 +24,19 @@ export const ActionSheet: ActionSheetComponent = ({actions, onDismiss, title, vi
16
24
  }}
17
25
  title={title}
18
26
  >
19
- {actions.map(action => (
20
- <Button
21
- key={action.label}
22
- label={action.label}
23
- onPress={action.onPress}
24
- role={action.destructive ? 'destructive' : 'default'}
25
- />
26
- ))}
27
+ <ConfirmationDialog.Trigger>
28
+ <Spacer modifiers={ANCHOR} />
29
+ </ConfirmationDialog.Trigger>
30
+ <ConfirmationDialog.Actions>
31
+ {actions.map(action => (
32
+ <Button
33
+ key={action.label}
34
+ label={action.label}
35
+ onPress={action.onPress}
36
+ role={action.destructive ? 'destructive' : 'default'}
37
+ />
38
+ ))}
39
+ </ConfirmationDialog.Actions>
27
40
  </ConfirmationDialog>
28
41
  )
29
42
  }
@@ -2,10 +2,18 @@ import type {ReactNode} from 'react'
2
2
 
3
3
  import type {MenuAction} from '../menu'
4
4
 
5
+ /**
6
+ * A list of actions to pick one from: SwiftUI's confirmation dialog on iOS, a `Sheet` of Material rows — icon and label
7
+ * — under the title on Android. A native atom — it renders inside `<Screen>` or `<Island>`.
8
+ */
5
9
  export type ActionSheetProps = {
10
+ /** The choices, top to bottom. Picking one closes the sheet. */
6
11
  actions: MenuAction[]
12
+ /** The sheet closed — after a pick too — so turn `visible` off. */
7
13
  onDismiss: () => void
14
+ /** The heading above the actions. Android always shows it; on iOS the system decides, and may hide it. */
8
15
  title: string
16
+ /** Presents the sheet while true. */
9
17
  visible: boolean
10
18
  }
11
19
 
@@ -1,8 +1,15 @@
1
- import {Button, Alert as SwiftUIAlert, Text as SwiftUIText} from '@expo/ui/swift-ui'
1
+ import {Button, Spacer, Alert as SwiftUIAlert, Text as SwiftUIText} from '@expo/ui/swift-ui'
2
+ import {frame} from '@expo/ui/swift-ui/modifiers'
2
3
 
3
4
  import {useHostGuard} from '../../host-context'
4
5
  import type {AlertComponent, AlertProps} from './alert.types'
5
6
 
7
+ /**
8
+ * `@expo/ui` hangs the alert on its `Alert.Trigger`, and on an `EmptyView` when there is none — which SwiftUI never
9
+ * presents from, so the alert would not appear at all. A spacer framed to nothing is a real view that takes no room.
10
+ */
11
+ const ANCHOR = [frame({height: 0, width: 0})]
12
+
6
13
  export const Alert: AlertComponent = ({
7
14
  confirmLabel = 'OK',
8
15
  destructive = false,
@@ -24,6 +31,9 @@ export const Alert: AlertComponent = ({
24
31
  }}
25
32
  title={title}
26
33
  >
34
+ <SwiftUIAlert.Trigger>
35
+ <Spacer modifiers={ANCHOR} />
36
+ </SwiftUIAlert.Trigger>
27
37
  <SwiftUIAlert.Actions>
28
38
  <Button label={confirmLabel} onPress={onConfirm ?? onDismiss} role={destructive ? 'destructive' : 'default'} />
29
39
  <Button label="Cancel" onPress={onDismiss} role="cancel" />
@@ -1,12 +1,23 @@
1
1
  import type {ReactNode} from 'react'
2
2
 
3
+ /**
4
+ * A modal alert with a confirm button and Cancel: SwiftUI's alert on iOS, Material's `AlertDialog` on Android. A native
5
+ * atom — it renders inside `<Screen>` or `<Island>`.
6
+ */
3
7
  export type AlertProps = {
8
+ /** The confirm button's label. `OK` by default. */
4
9
  confirmLabel?: string
10
+ /** Marks the confirm button destructive — the system's destructive role on iOS, the destructive colour on Android. */
5
11
  destructive?: boolean
12
+ /** The body text, under the title. */
6
13
  message?: string
14
+ /** The confirm button was pressed. `onDismiss` follows, as it does for every way the alert closes. */
7
15
  onConfirm?: () => void
16
+ /** The alert closed — either button, or on Android a tap outside or back — so turn `visible` off. */
8
17
  onDismiss: () => void
18
+ /** The alert's heading. */
9
19
  title: string
20
+ /** Shows the alert while true. */
10
21
  visible: boolean
11
22
  }
12
23
 
@@ -10,6 +10,7 @@ import type {MenuAction} from '../menu'
10
10
  * needs no `Screen` or `Island`.
11
11
  */
12
12
  export type ContextMenuProps = ResponsiveViewSx & {
13
+ /** The menu's actions, top to bottom. */
13
14
  actions: MenuAction[]
14
15
  /** The trigger, laid out as usual. */
15
16
  children: ReactNode
@@ -29,10 +30,13 @@ export type ContextMenuProps = ResponsiveViewSx & {
29
30
  * `ZoomTransition.Source`, `pop` otherwise.
30
31
  */
31
32
  previewTransition?: 'dismiss' | 'pop' | 'zoom'
33
+ /** Test identifier — on the native view around the trigger on iOS, on the trigger's `Pressable` on Android. */
32
34
  testID?: string
33
35
  }
34
36
 
37
+ /** A region of a `ContextMenu`'s trigger that keeps its own long press — see `ContextMenu.Exclusion`. */
35
38
  export type ContextMenuExclusionProps = {
39
+ /** The region — a button inside the card, say. */
36
40
  children: ReactNode
37
41
  }
38
42
 
@@ -9,9 +9,11 @@ import type {MenuAction} from '../menu'
9
9
  * of a SwiftUI `Menu`. A native atom — it renders inside `<Screen>` or `<Island>`.
10
10
  */
11
11
  export type FabMenuProps = {
12
+ /** The actions the button unfolds into. */
12
13
  actions: MenuAction[]
13
14
  /** The closed button's icon — one of the app's. A plus by default. */
14
15
  icon?: IconName
16
+ /** Test identifier, forwarded to the SwiftUI `Menu`. iOS only — Android ignores it. */
15
17
  testID?: string
16
18
  }
17
19
 
@@ -4,11 +4,15 @@ import {VStack} from '../../atoms/v-stack'
4
4
  import {useHostGuard} from '../../host-context'
5
5
  import type {FormComponent, FormProps, FormSectionProps} from './form.types'
6
6
 
7
+ /**
8
+ * Inset from its container on every side, as SwiftUI's grouped form is — in a `Screen` the cards would otherwise run
9
+ * into the screen's edges — and the section titles and footers indented to the cards' content.
10
+ */
7
11
  const FormRoot = ({children, testID}: FormProps) => {
8
12
  useHostGuard('Form')
9
13
 
10
14
  return (
11
- <VStack spacing="s16" testID={testID} wide>
15
+ <VStack p="s16" spacing="s16" testID={testID} wide>
12
16
  {children}
13
17
  </VStack>
14
18
  )
@@ -17,15 +21,19 @@ const FormRoot = ({children, testID}: FormProps) => {
17
21
  const FormSection = ({children, footer, title}: FormSectionProps) => (
18
22
  <VStack spacing="s4" wide>
19
23
  {title ? (
20
- <Text color="content.secondary" transform="uppercase" variant="labelMedium">
21
- {title}
22
- </Text>
24
+ <VStack px="s16" wide>
25
+ <Text color="content.secondary" transform="uppercase" variant="labelMedium">
26
+ {title}
27
+ </Text>
28
+ </VStack>
23
29
  ) : null}
24
30
  <Card wide>{children}</Card>
25
31
  {footer ? (
26
- <Text color="content.tertiary" variant="footnote">
27
- {footer}
28
- </Text>
32
+ <VStack px="s16" wide>
33
+ <Text color="content.tertiary" variant="footnote">
34
+ {footer}
35
+ </Text>
36
+ </VStack>
29
37
  ) : null}
30
38
  </VStack>
31
39
  )
@@ -6,13 +6,19 @@ import type {ReactNode} from 'react'
6
6
  * an island that sizes itself to its content it has no height and shows nothing.
7
7
  */
8
8
  export type FormProps = {
9
+ /** The form's `Form.Section`s. */
9
10
  children: ReactNode
11
+ /** Test identifier, forwarded to the native view. */
10
12
  testID?: string
11
13
  }
12
14
 
15
+ /** A group of rows in a `Form`: a SwiftUI `Section` on iOS, a `Card` under a heading on Android. */
13
16
  export type FormSectionProps = {
17
+ /** The section's rows. */
14
18
  children: ReactNode
19
+ /** Small print under the section. */
15
20
  footer?: string
21
+ /** The section's heading. */
16
22
  title?: string
17
23
  }
18
24
 
@@ -2,15 +2,32 @@ import type {ReactNode} from 'react'
2
2
 
3
3
  import type {IconName} from '../../atoms/icon'
4
4
 
5
+ /** One action of a `Menu`, an `ActionSheet`, a `ContextMenu` or a `FabMenu`. */
5
6
  export type MenuAction = {
7
+ /**
8
+ * Draws the action in the destructive colour — the system's destructive role on iOS. `FabMenu` ignores it on
9
+ * Android.
10
+ */
6
11
  destructive?: boolean
12
+ /**
13
+ * One of the app's icons, before the label. `ContextMenu` and `FabMenu` show it on both platforms, `Menu` and
14
+ * `ActionSheet` on Android only.
15
+ */
7
16
  icon?: IconName
17
+ /** The action's text. Rows are keyed by it, so keep labels unique within one list. */
8
18
  label: string
19
+ /** Called when the action is chosen; the menu closes by itself. */
9
20
  onPress: () => void
10
21
  }
11
22
 
23
+ /**
24
+ * A text button that opens a list of actions: a SwiftUI `Menu` on iOS, a Material dropdown anchored to it on Android.
25
+ * A native atom — it renders inside `<Screen>` or `<Island>`.
26
+ */
12
27
  export type MenuProps = {
28
+ /** The menu's actions, top to bottom. */
13
29
  actions: MenuAction[]
30
+ /** The trigger's text. Android draws it in the accent colour, with a chevron. */
14
31
  label: string
15
32
  }
16
33
 
@@ -27,6 +27,7 @@ export type SheetHeaderProps = {
27
27
  leadingItems?: NavigationBarItem[]
28
28
  /** A search field in place of the title (iOS). */
29
29
  search?: NavigationBarSearch
30
+ /** The title — in the bar, or above the content with a `large` `titleStyle`. */
30
31
  title?: string
31
32
  /** `center` by default. */
32
33
  titleStyle?: SheetTitleStyle
@@ -34,7 +35,9 @@ export type SheetHeaderProps = {
34
35
  trailingItems?: NavigationBarItem[]
35
36
  }
36
37
 
38
+ /** Imperative control of a `Sheet`, through its `ref`. */
37
39
  export type SheetRef = {
40
+ /** Dismisses it without calling `onDismiss`, which reports the user's dismissals only. */
38
41
  dismiss: () => Promise<void>
39
42
  /** Presents at a detent — the first by default. */
40
43
  present: (detentIndex?: number) => Promise<void>
@@ -50,6 +53,7 @@ export type SheetRef = {
50
53
  export type SheetProps = {
51
54
  /** The sheet's colour. `surface.primary` by default. */
52
55
  bg?: ColorToken
56
+ /** The content. A `<Sheet.Header>` among the direct children becomes the native header instead. */
53
57
  children: ReactNode
54
58
  /** Where the sheet can rest, smallest first. `['auto']` — fit the content — by default. */
55
59
  detents?: SheetDetent[]
@@ -65,15 +69,20 @@ export type SheetProps = {
65
69
  grabber?: boolean
66
70
  /** The user dismissed it — `visible` going false does not call this. */
67
71
  onDismiss: () => void
72
+ /** The sheet moved to another detent — its index in `detents`. */
68
73
  onDetentChange?: (detentIndex: number) => void
74
+ /** The sheet finished presenting. */
69
75
  onPresent?: () => void
76
+ /** `present`, `dismiss` and `resize`, for driving the sheet imperatively. */
70
77
  ref?: Ref<SheetRef>
71
78
  /**
72
79
  * The content is a scroll view (`<Sheet.ScrollView>`) the sheet drives: dragging past its top resizes the sheet,
73
80
  * and a header scrolls with the iOS 26 edge effect. Off by default — set it with a scrolling body.
74
81
  */
75
82
  scrollable?: boolean
83
+ /** Test identifier, forwarded to the native sheet. */
76
84
  testID?: string
85
+ /** Presents the sheet while true; going false dismisses it. */
77
86
  visible: boolean
78
87
  }
79
88
 
@@ -81,16 +90,26 @@ export type SheetScrollHandler = (event: NativeSyntheticEvent<NativeScrollEvent>
81
90
 
82
91
  /** What a scroll view inside a sheet needs: the room the header takes, the large title, the scroll listener. */
83
92
  export type SheetScrollContextValue = {
93
+ /** Render it first in the content. `null` unless the header's `titleStyle` is `large`. */
84
94
  largeTitle: ReactNode
95
+ /** Forward the scroll view's scroll events to it — it tracks the large title. Unset when there is none. */
85
96
  onScroll?: SheetScrollHandler
97
+ /** The room an overlaid header takes, to add to the content's top padding. `0` where the header sits above it. */
86
98
  topInset: number
87
99
  }
88
100
 
101
+ /**
102
+ * The body of a `scrollable` sheet: its content starts below an overlaid header, it carries a large title, and it
103
+ * reports its scroll to the sheet.
104
+ */
89
105
  export type SheetScrollViewProps = Pick<ScrollViewProps, 'keyboardShouldPersistTaps'> & {
106
+ /** The scrolling content, after the large title if there is one. */
90
107
  children: ReactNode
91
108
  /** Styles the scrolling content — padding and gap belong here, as with `RnScrollView`. */
92
109
  content?: ResponsiveViewSx
110
+ /** Called on every scroll event, after the sheet's own listener. */
93
111
  onScroll?: SheetScrollHandler
112
+ /** Test identifier, forwarded to the scroll view. */
94
113
  testID?: string
95
114
  }
96
115
 
@@ -1,9 +1,17 @@
1
1
  import type {ReactNode} from 'react'
2
2
 
3
+ /**
4
+ * A short message laid over the bottom of its parent, with an optional action. The React Native tier, drawn the same on
5
+ * both platforms: it needs no host, and it never hides itself.
6
+ */
3
7
  export type SnackbarProps = {
8
+ /** The action button's text, on the trailing side. No button without it. */
4
9
  actionLabel?: string
10
+ /** The message. */
5
11
  message: string
12
+ /** The action was pressed. The snackbar stays up — turn `visible` off to hide it. */
6
13
  onAction?: () => void
14
+ /** Shows the snackbar while true, fading it in and out. It sets no timer of its own. */
7
15
  visible: boolean
8
16
  }
9
17