@bitforgehq/ui 0.3.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 (281) hide show
  1. package/CHANGELOG.md +3665 -0
  2. package/LICENSE +21 -0
  3. package/README.md +175 -0
  4. package/ai/MANIFEST.index.json +383 -0
  5. package/ai/MANIFEST.json +7528 -0
  6. package/ai/REFERENCE.index.json +1461 -0
  7. package/ai/REFERENCE.json +7213 -0
  8. package/ai/UI_GUIDE.md +1159 -0
  9. package/ai/components/action-bar.md +209 -0
  10. package/ai/components/action-sheet.md +526 -0
  11. package/ai/components/alert-dialog.md +509 -0
  12. package/ai/components/alert.md +376 -0
  13. package/ai/components/avatar.md +146 -0
  14. package/ai/components/back-button.md +286 -0
  15. package/ai/components/badge.md +171 -0
  16. package/ai/components/button.md +431 -0
  17. package/ai/components/card.md +303 -0
  18. package/ai/components/checkbox.md +418 -0
  19. package/ai/components/chip-group.md +205 -0
  20. package/ai/components/chip.md +300 -0
  21. package/ai/components/content.md +474 -0
  22. package/ai/components/desktop-toast.md +420 -0
  23. package/ai/components/dialog.md +962 -0
  24. package/ai/components/empty-state.md +146 -0
  25. package/ai/components/field.md +319 -0
  26. package/ai/components/header.md +809 -0
  27. package/ai/components/icon-button.md +221 -0
  28. package/ai/components/icon.md +176 -0
  29. package/ai/components/input.md +455 -0
  30. package/ai/components/list-item.md +326 -0
  31. package/ai/components/list.md +178 -0
  32. package/ai/components/menu-button.md +377 -0
  33. package/ai/components/menu.md +661 -0
  34. package/ai/components/modal.md +613 -0
  35. package/ai/components/number-input.md +423 -0
  36. package/ai/components/page.md +299 -0
  37. package/ai/components/progress.md +215 -0
  38. package/ai/components/radio-group.md +432 -0
  39. package/ai/components/refresher.md +377 -0
  40. package/ai/components/segmented.md +517 -0
  41. package/ai/components/select.md +510 -0
  42. package/ai/components/sheet.md +845 -0
  43. package/ai/components/spinner.md +171 -0
  44. package/ai/components/stack-outlet.md +661 -0
  45. package/ai/components/tab-bar.md +427 -0
  46. package/ai/components/tab.md +295 -0
  47. package/ai/components/tabs.md +408 -0
  48. package/ai/components/textarea.md +371 -0
  49. package/ai/components/toast.md +522 -0
  50. package/ai/components/toggle.md +387 -0
  51. package/ai/reference/bf-action-directive.md +21 -0
  52. package/ai/reference/bf-action-sheet-action-role.md +27 -0
  53. package/ai/reference/bf-action-sheet-action.md +28 -0
  54. package/ai/reference/bf-action-sheet-options.md +28 -0
  55. package/ai/reference/bf-action-sheet-service.md +33 -0
  56. package/ai/reference/bf-alert-dialog-button-role.md +27 -0
  57. package/ai/reference/bf-alert-dialog-button.md +27 -0
  58. package/ai/reference/bf-alert-dialog-options.md +29 -0
  59. package/ai/reference/bf-alert-dialog-service.md +34 -0
  60. package/ai/reference/bf-alert-variant.md +28 -0
  61. package/ai/reference/bf-autocapitalize.md +30 -0
  62. package/ai/reference/bf-avatar-size.md +27 -0
  63. package/ai/reference/bf-avatar-variant.md +28 -0
  64. package/ai/reference/bf-back-at-root.md +28 -0
  65. package/ai/reference/bf-back-button-service.md +40 -0
  66. package/ai/reference/bf-badge-variant.md +29 -0
  67. package/ai/reference/bf-button-size.md +29 -0
  68. package/ai/reference/bf-button-type.md +28 -0
  69. package/ai/reference/bf-button-variant.md +29 -0
  70. package/ai/reference/bf-card-padding.md +26 -0
  71. package/ai/reference/bf-card-variant.md +28 -0
  72. package/ai/reference/bf-chip-group-mode.md +27 -0
  73. package/ai/reference/bf-chip-variant.md +26 -0
  74. package/ai/reference/bf-compare-with.md +24 -0
  75. package/ai/reference/bf-component-overlay-ref.md +33 -0
  76. package/ai/reference/bf-confirm-button-role.md +26 -0
  77. package/ai/reference/bf-confirm-button.md +27 -0
  78. package/ai/reference/bf-confirm-options.md +31 -0
  79. package/ai/reference/bf-confirm-size.md +26 -0
  80. package/ai/reference/bf-content-scroll-event.md +21 -0
  81. package/ai/reference/bf-defaults-options.md +32 -0
  82. package/ai/reference/bf-defaults.md +28 -0
  83. package/ai/reference/bf-desktop-toast-config.md +28 -0
  84. package/ai/reference/bf-desktop-toast-harness.md +33 -0
  85. package/ai/reference/bf-desktop-toast-options.md +28 -0
  86. package/ai/reference/bf-desktop-toast-position.md +28 -0
  87. package/ai/reference/bf-desktop-toast-service.md +42 -0
  88. package/ai/reference/bf-dialog-config.md +44 -0
  89. package/ai/reference/bf-dialog-harness.md +52 -0
  90. package/ai/reference/bf-dialog-ref.md +44 -0
  91. package/ai/reference/bf-dialog-role.md +26 -0
  92. package/ai/reference/bf-dialog-service.md +55 -0
  93. package/ai/reference/bf-dialog-size.md +31 -0
  94. package/ai/reference/bf-dialog-template-context.md +32 -0
  95. package/ai/reference/bf-empty-state-heading-level.md +26 -0
  96. package/ai/reference/bf-enter-key-hint.md +31 -0
  97. package/ai/reference/bf-field-control-class.md +32 -0
  98. package/ai/reference/bf-field-control-state.md +28 -0
  99. package/ai/reference/bf-field-size.md +29 -0
  100. package/ai/reference/bf-haptics-impact-style.md +27 -0
  101. package/ai/reference/bf-haptics-notification-type.md +27 -0
  102. package/ai/reference/bf-haptics-service.md +41 -0
  103. package/ai/reference/bf-harness-filters.md +29 -0
  104. package/ai/reference/bf-horizontal-scroll-directive.md +129 -0
  105. package/ai/reference/bf-icon-button-variant.md +28 -0
  106. package/ai/reference/bf-icon-size.md +27 -0
  107. package/ai/reference/bf-input-autocapitalize.md +36 -0
  108. package/ai/reference/bf-input-enter-key-hint.md +38 -0
  109. package/ai/reference/bf-input-input-mode.md +38 -0
  110. package/ai/reference/bf-input-mode.md +32 -0
  111. package/ai/reference/bf-input-type.md +35 -0
  112. package/ai/reference/bf-jsdom-shim-options.md +22 -0
  113. package/ai/reference/bf-keyboard-assist-behavior.md +26 -0
  114. package/ai/reference/bf-keyboard-assist-directive.md +185 -0
  115. package/ai/reference/bf-keyboard-phase.md +30 -0
  116. package/ai/reference/bf-keyboard-service.md +50 -0
  117. package/ai/reference/bf-labels-overrides.md +26 -0
  118. package/ai/reference/bf-labels.md +44 -0
  119. package/ai/reference/bf-menu-button-harness.md +40 -0
  120. package/ai/reference/bf-menu-button-variant.md +27 -0
  121. package/ai/reference/bf-menu-divider-directive.md +13 -0
  122. package/ai/reference/bf-menu-group-directive.md +14 -0
  123. package/ai/reference/bf-menu-harness.md +55 -0
  124. package/ai/reference/bf-menu-item-checkbox-directive.md +31 -0
  125. package/ai/reference/bf-menu-item-directive.md +31 -0
  126. package/ai/reference/bf-menu-item-harness.md +52 -0
  127. package/ai/reference/bf-menu-item-radio-directive.md +29 -0
  128. package/ai/reference/bf-menu-placement.md +29 -0
  129. package/ai/reference/bf-menu-trigger-directive.md +46 -0
  130. package/ai/reference/bf-modal-options.md +30 -0
  131. package/ai/reference/bf-modal-presentation.md +26 -0
  132. package/ai/reference/bf-modal-service.md +38 -0
  133. package/ai/reference/bf-nav-controller.md +59 -0
  134. package/ai/reference/bf-nav-direction.md +23 -0
  135. package/ai/reference/bf-nav-target.md +21 -0
  136. package/ai/reference/bf-number-input-mode.md +28 -0
  137. package/ai/reference/bf-number-input-step.md +25 -0
  138. package/ai/reference/bf-overlay-auto-focus.md +29 -0
  139. package/ai/reference/bf-overlay-controller.md +22 -0
  140. package/ai/reference/bf-overlay-host.md +36 -0
  141. package/ai/reference/bf-overlay-options.md +53 -0
  142. package/ai/reference/bf-overlay-position.md +30 -0
  143. package/ai/reference/bf-overlay-ref.md +53 -0
  144. package/ai/reference/bf-overlay-role.md +27 -0
  145. package/ai/reference/bf-overlay-service.md +53 -0
  146. package/ai/reference/bf-overlay-stack-options.md +24 -0
  147. package/ai/reference/bf-overlay-stack.md +81 -0
  148. package/ai/reference/bf-overlay-template-context.md +24 -0
  149. package/ai/reference/bf-overscroll-stretch-directive.md +163 -0
  150. package/ai/reference/bf-page-context.md +24 -0
  151. package/ai/reference/bf-platform-service.md +53 -0
  152. package/ai/reference/bf-platform.md +28 -0
  153. package/ai/reference/bf-progress-size.md +26 -0
  154. package/ai/reference/bf-progress-tone.md +28 -0
  155. package/ai/reference/bf-radio-group-harness.md +49 -0
  156. package/ai/reference/bf-radio-group-orientation.md +26 -0
  157. package/ai/reference/bf-radio-option.md +30 -0
  158. package/ai/reference/bf-refresher-refresh-event.md +22 -0
  159. package/ai/reference/bf-segment-option.md +29 -0
  160. package/ai/reference/bf-segmented-harness.md +48 -0
  161. package/ai/reference/bf-segmented-size.md +29 -0
  162. package/ai/reference/bf-select-harness.md +70 -0
  163. package/ai/reference/bf-select-option.md +29 -0
  164. package/ai/reference/bf-sheet-auto-focus.md +29 -0
  165. package/ai/reference/bf-sheet-options.md +32 -0
  166. package/ai/reference/bf-sheet-ref.md +45 -0
  167. package/ai/reference/bf-sheet-service.md +34 -0
  168. package/ai/reference/bf-shell-config-mode.md +28 -0
  169. package/ai/reference/bf-shell-config.md +38 -0
  170. package/ai/reference/bf-shell-dynamic-type-limit.md +21 -0
  171. package/ai/reference/bf-shell-dynamic-type.md +25 -0
  172. package/ai/reference/bf-shell-mode.md +28 -0
  173. package/ai/reference/bf-shell-testing-options.md +26 -0
  174. package/ai/reference/bf-size.md +45 -0
  175. package/ai/reference/bf-spinner-size.md +27 -0
  176. package/ai/reference/bf-stack-change.md +22 -0
  177. package/ai/reference/bf-stack-reuse-strategy.md +32 -0
  178. package/ai/reference/bf-stack-transition-event.md +26 -0
  179. package/ai/reference/bf-stack-transition.md +26 -0
  180. package/ai/reference/bf-stacked-overlay.md +23 -0
  181. package/ai/reference/bf-system-bars-style.md +38 -0
  182. package/ai/reference/bf-tab-bar-controller.md +51 -0
  183. package/ai/reference/bf-tab-bar-host.md +52 -0
  184. package/ai/reference/bf-tab-context.md +32 -0
  185. package/ai/reference/bf-tab-links.md +37 -0
  186. package/ai/reference/bf-testing-options.md +27 -0
  187. package/ai/reference/bf-text-scale-service.md +35 -0
  188. package/ai/reference/bf-theme.md +27 -0
  189. package/ai/reference/bf-toast-action.md +25 -0
  190. package/ai/reference/bf-toast-controller.md +17 -0
  191. package/ai/reference/bf-toast-dismiss-reason.md +29 -0
  192. package/ai/reference/bf-toast-options.md +29 -0
  193. package/ai/reference/bf-toast-position.md +26 -0
  194. package/ai/reference/bf-toast-ref.md +41 -0
  195. package/ai/reference/bf-toast-service.md +39 -0
  196. package/ai/reference/bf-toggle-label-position.md +26 -0
  197. package/ai/reference/bf-transition-kind.md +28 -0
  198. package/ai/reference/bf-validation-message.md +31 -0
  199. package/ai/reference/bf-validation-messages.md +33 -0
  200. package/ai/reference/bf-view-event.md +28 -0
  201. package/ai/reference/bf-view-lifecycle.md +41 -0
  202. package/ai/reference/bf-view-state.md +28 -0
  203. package/ai/reference/bf_default_labels.md +21 -0
  204. package/ai/reference/bf_default_values.md +21 -0
  205. package/ai/reference/bf_defaults.md +21 -0
  206. package/ai/reference/bf_desktop_toast_defaults.md +21 -0
  207. package/ai/reference/bf_dialog_data.md +17 -0
  208. package/ai/reference/bf_labels.md +21 -0
  209. package/ai/reference/bf_overlay_data.md +19 -0
  210. package/ai/reference/bf_overlay_host.md +21 -0
  211. package/ai/reference/bf_sheet_default_snap_points.md +17 -0
  212. package/ai/reference/bf_shell_config.md +21 -0
  213. package/ai/reference/bf_shell_defaults.md +21 -0
  214. package/ai/reference/bf_tab_bar.md +21 -0
  215. package/ai/reference/bf_tab_bar_controller.md +21 -0
  216. package/ai/reference/bf_tab_context.md +21 -0
  217. package/ai/reference/bf_tab_links.md +21 -0
  218. package/ai/reference/bf_theme_storage.md +19 -0
  219. package/ai/reference/create-transition.md +36 -0
  220. package/ai/reference/duration_fast.md +17 -0
  221. package/ai/reference/duration_md.md +17 -0
  222. package/ai/reference/duration_overlay.md +17 -0
  223. package/ai/reference/duration_push.md +17 -0
  224. package/ai/reference/fade-down.md +26 -0
  225. package/ai/reference/fade-in.md +25 -0
  226. package/ai/reference/fade-out.md +25 -0
  227. package/ai/reference/fade-up.md +26 -0
  228. package/ai/reference/inject-shell-mode.md +23 -0
  229. package/ai/reference/install-bf-jsdom-shims.md +31 -0
  230. package/ai/reference/ios_duration.md +17 -0
  231. package/ai/reference/ios_easing.md +17 -0
  232. package/ai/reference/is-text-entry.md +25 -0
  233. package/ai/reference/max_complete_ms.md +17 -0
  234. package/ai/reference/md-transition.md +31 -0
  235. package/ai/reference/md_duration.md +17 -0
  236. package/ai/reference/md_easing.md +17 -0
  237. package/ai/reference/overlay_duration.md +21 -0
  238. package/ai/reference/overlay_easing.md +19 -0
  239. package/ai/reference/overlay_reduced_duration.md +17 -0
  240. package/ai/reference/pop-frames-at.md +25 -0
  241. package/ai/reference/prefers-reduced-motion.md +25 -0
  242. package/ai/reference/provide-bf-defaults.md +33 -0
  243. package/ai/reference/provide-bf-desktop-toast.md +28 -0
  244. package/ai/reference/provide-bf-labels.md +38 -0
  245. package/ai/reference/provide-bf-shell-testing.md +34 -0
  246. package/ai/reference/provide-bf-shell.md +41 -0
  247. package/ai/reference/provide-bf-testing.md +33 -0
  248. package/ai/reference/reduced-transition.md +28 -0
  249. package/ai/reference/reduced_duration.md +17 -0
  250. package/ai/reference/resolve-shell-mode.md +33 -0
  251. package/ai/reference/scale-in.md +25 -0
  252. package/ai/reference/settle-duration.md +25 -0
  253. package/ai/reference/settle-pop.md +33 -0
  254. package/ai/reference/settle_easing.md +17 -0
  255. package/ai/reference/should-complete-pop.md +26 -0
  256. package/ai/reference/slide-down.md +26 -0
  257. package/ai/reference/slide-up.md +26 -0
  258. package/ai/reference/with-bf-shell-routing.md +19 -0
  259. package/bin/bf-ui.js +81 -0
  260. package/fesm2022/bitforgehq-ui-icons.mjs +230 -0
  261. package/fesm2022/bitforgehq-ui-icons.mjs.map +1 -0
  262. package/fesm2022/bitforgehq-ui-mobile.mjs +5530 -0
  263. package/fesm2022/bitforgehq-ui-mobile.mjs.map +1 -0
  264. package/fesm2022/bitforgehq-ui-number-input.mjs +680 -0
  265. package/fesm2022/bitforgehq-ui-number-input.mjs.map +1 -0
  266. package/fesm2022/bitforgehq-ui-overlay.mjs +2675 -0
  267. package/fesm2022/bitforgehq-ui-overlay.mjs.map +1 -0
  268. package/fesm2022/bitforgehq-ui-testing.mjs +402 -0
  269. package/fesm2022/bitforgehq-ui-testing.mjs.map +1 -0
  270. package/fesm2022/bitforgehq-ui.mjs +7765 -0
  271. package/fesm2022/bitforgehq-ui.mjs.map +1 -0
  272. package/llms-full.txt +25394 -0
  273. package/llms.txt +329 -0
  274. package/package.json +94 -0
  275. package/theme.css +253 -0
  276. package/types/bitforgehq-ui-icons.d.ts +50 -0
  277. package/types/bitforgehq-ui-mobile.d.ts +2914 -0
  278. package/types/bitforgehq-ui-number-input.d.ts +282 -0
  279. package/types/bitforgehq-ui-overlay.d.ts +1514 -0
  280. package/types/bitforgehq-ui-testing.d.ts +495 -0
  281. package/types/bitforgehq-ui.d.ts +3499 -0
@@ -0,0 +1,1461 @@
1
+ {
2
+ "generatedFrom": "tools/gen-ai-docs.ts",
3
+ "symbols": [
4
+ {
5
+ "name": "BF_DEFAULT_LABELS",
6
+ "slug": "bf_default_labels",
7
+ "kind": "const",
8
+ "entryPoint": "@bitforgehq/ui",
9
+ "summary": "The library's built-in English strings, the labels every widget starts from"
10
+ },
11
+ {
12
+ "name": "BF_DEFAULT_VALUES",
13
+ "slug": "bf_default_values",
14
+ "kind": "const",
15
+ "entryPoint": "@bitforgehq/ui",
16
+ "summary": "The library's built-in widget defaults, the compact md step everywhere"
17
+ },
18
+ {
19
+ "name": "BF_DEFAULTS",
20
+ "slug": "bf_defaults",
21
+ "kind": "token",
22
+ "entryPoint": "@bitforgehq/ui",
23
+ "summary": "Injection token holding the widget defaults in effect for an injector"
24
+ },
25
+ {
26
+ "name": "BF_LABELS",
27
+ "slug": "bf_labels",
28
+ "kind": "token",
29
+ "entryPoint": "@bitforgehq/ui",
30
+ "summary": "Injection token holding the user-facing strings in effect for an injector"
31
+ },
32
+ {
33
+ "name": "BF_TAB_BAR",
34
+ "slug": "bf_tab_bar",
35
+ "kind": "token",
36
+ "entryPoint": "@bitforgehq/ui",
37
+ "summary": "Injection token through which each tab reaches its enclosing tab bar"
38
+ },
39
+ {
40
+ "name": "BF_TAB_BAR_CONTROLLER",
41
+ "slug": "bf_tab_bar_controller",
42
+ "kind": "token",
43
+ "entryPoint": "@bitforgehq/ui",
44
+ "summary": "Injection token through which a parent drives the selection and hiding of its tab bar"
45
+ },
46
+ {
47
+ "name": "BF_TAB_LINKS",
48
+ "slug": "bf_tab_links",
49
+ "kind": "token",
50
+ "entryPoint": "@bitforgehq/ui",
51
+ "summary": "Injection token that turns a projected tab bar into a navigation of links"
52
+ },
53
+ {
54
+ "name": "BfActionDirective",
55
+ "slug": "bf-action-directive",
56
+ "kind": "directive",
57
+ "entryPoint": "@bitforgehq/ui",
58
+ "summary": "Makes one link or button the click target of a whole card or list row"
59
+ },
60
+ {
61
+ "name": "BfAlertVariant",
62
+ "slug": "bf-alert-variant",
63
+ "kind": "type",
64
+ "entryPoint": "@bitforgehq/ui",
65
+ "summary": "The four tones of an alert, from neutral information to a danger message"
66
+ },
67
+ {
68
+ "name": "BfAutocapitalize",
69
+ "slug": "bf-autocapitalize",
70
+ "kind": "type",
71
+ "entryPoint": "@bitforgehq/ui",
72
+ "summary": "How a phone keyboard capitalises the text typed into a field"
73
+ },
74
+ {
75
+ "name": "BfAvatarSize",
76
+ "slug": "bf-avatar-size",
77
+ "kind": "type",
78
+ "entryPoint": "@bitforgehq/ui",
79
+ "summary": "The three sizes of an avatar, from a list row to a profile header"
80
+ },
81
+ {
82
+ "name": "BfAvatarVariant",
83
+ "slug": "bf-avatar-variant",
84
+ "kind": "type",
85
+ "entryPoint": "@bitforgehq/ui",
86
+ "summary": "The four colour schemes of an avatar behind its initials or icon"
87
+ },
88
+ {
89
+ "name": "BfBadgeVariant",
90
+ "slug": "bf-badge-variant",
91
+ "kind": "type",
92
+ "entryPoint": "@bitforgehq/ui",
93
+ "summary": "The five tones of a badge, from neutral counts to danger states"
94
+ },
95
+ {
96
+ "name": "BfButtonSize",
97
+ "slug": "bf-button-size",
98
+ "kind": "type",
99
+ "entryPoint": "@bitforgehq/ui",
100
+ "summary": "Former name of the shared size scale for buttons, kept until 1.0.0"
101
+ },
102
+ {
103
+ "name": "BfButtonType",
104
+ "slug": "bf-button-type",
105
+ "kind": "type",
106
+ "entryPoint": "@bitforgehq/ui",
107
+ "summary": "The native button types, for a plain action, a form submit or reset"
108
+ },
109
+ {
110
+ "name": "BfButtonVariant",
111
+ "slug": "bf-button-variant",
112
+ "kind": "type",
113
+ "entryPoint": "@bitforgehq/ui",
114
+ "summary": "The five visual styles of a button, from filled primary to plain text"
115
+ },
116
+ {
117
+ "name": "BfCardPadding",
118
+ "slug": "bf-card-padding",
119
+ "kind": "type",
120
+ "entryPoint": "@bitforgehq/ui",
121
+ "summary": "The two inner paddings of a card, regular and roomy"
122
+ },
123
+ {
124
+ "name": "BfCardVariant",
125
+ "slug": "bf-card-variant",
126
+ "kind": "type",
127
+ "entryPoint": "@bitforgehq/ui",
128
+ "summary": "The four card surfaces, from a raised panel to a flat outline"
129
+ },
130
+ {
131
+ "name": "BfChipGroupMode",
132
+ "slug": "bf-chip-group-mode",
133
+ "kind": "type",
134
+ "entryPoint": "@bitforgehq/ui",
135
+ "summary": "Whether a chip group picks exactly one chip or lets each chip toggle alone"
136
+ },
137
+ {
138
+ "name": "BfChipVariant",
139
+ "slug": "bf-chip-variant",
140
+ "kind": "type",
141
+ "entryPoint": "@bitforgehq/ui",
142
+ "summary": "The two chip colours, a soft tonal tint or a dark ink fill"
143
+ },
144
+ {
145
+ "name": "BfCompareWith",
146
+ "slug": "bf-compare-with",
147
+ "kind": "type",
148
+ "entryPoint": "@bitforgehq/ui",
149
+ "summary": "Equality of choice values, for options that are objects rather than primitives"
150
+ },
151
+ {
152
+ "name": "BfDefaults",
153
+ "slug": "bf-defaults",
154
+ "kind": "interface",
155
+ "entryPoint": "@bitforgehq/ui",
156
+ "summary": "The default height steps of text fields and of actions and choice controls"
157
+ },
158
+ {
159
+ "name": "BfDefaultsOptions",
160
+ "slug": "bf-defaults-options",
161
+ "kind": "interface",
162
+ "entryPoint": "@bitforgehq/ui",
163
+ "summary": "The size steps provideBfDefaults sets, each one falling back to the parent"
164
+ },
165
+ {
166
+ "name": "BfEmptyStateHeadingLevel",
167
+ "slug": "bf-empty-state-heading-level",
168
+ "kind": "type",
169
+ "entryPoint": "@bitforgehq/ui",
170
+ "summary": "The heading level of an empty state title, two for a screen or three"
171
+ },
172
+ {
173
+ "name": "BfEnterKeyHint",
174
+ "slug": "bf-enter-key-hint",
175
+ "kind": "type",
176
+ "entryPoint": "@bitforgehq/ui",
177
+ "summary": "The labels a phone keyboard can put on its Enter key"
178
+ },
179
+ {
180
+ "name": "bfFieldControlClass",
181
+ "slug": "bf-field-control-class",
182
+ "kind": "function",
183
+ "entryPoint": "@bitforgehq/ui",
184
+ "summary": "The class list that makes a custom control look like a library text field"
185
+ },
186
+ {
187
+ "name": "BfFieldControlState",
188
+ "slug": "bf-field-control-state",
189
+ "kind": "interface",
190
+ "entryPoint": "@bitforgehq/ui",
191
+ "summary": "The size and state a custom field control is styled for by bfFieldControlClass"
192
+ },
193
+ {
194
+ "name": "BfFieldSize",
195
+ "slug": "bf-field-size",
196
+ "kind": "type",
197
+ "entryPoint": "@bitforgehq/ui",
198
+ "summary": "Former name of the shared size scale for text fields, kept until 1.0.0"
199
+ },
200
+ {
201
+ "name": "BfIconButtonVariant",
202
+ "slug": "bf-icon-button-variant",
203
+ "kind": "type",
204
+ "entryPoint": "@bitforgehq/ui",
205
+ "summary": "The four visual styles of an icon button, from tonal to plain text"
206
+ },
207
+ {
208
+ "name": "BfInputAutocapitalize",
209
+ "slug": "bf-input-autocapitalize",
210
+ "kind": "type",
211
+ "entryPoint": "@bitforgehq/ui",
212
+ "summary": "A text field's capitalisation setting, a mode or empty to leave it off"
213
+ },
214
+ {
215
+ "name": "BfInputEnterKeyHint",
216
+ "slug": "bf-input-enter-key-hint",
217
+ "kind": "type",
218
+ "entryPoint": "@bitforgehq/ui",
219
+ "summary": "A field's Enter key label setting, a label or empty to leave it off"
220
+ },
221
+ {
222
+ "name": "BfInputInputMode",
223
+ "slug": "bf-input-input-mode",
224
+ "kind": "type",
225
+ "entryPoint": "@bitforgehq/ui",
226
+ "summary": "A text field's virtual keyboard setting, a keyboard or empty to leave it off"
227
+ },
228
+ {
229
+ "name": "BfInputMode",
230
+ "slug": "bf-input-mode",
231
+ "kind": "type",
232
+ "entryPoint": "@bitforgehq/ui",
233
+ "summary": "The virtual keyboards a phone can show for a text field"
234
+ },
235
+ {
236
+ "name": "BfInputType",
237
+ "slug": "bf-input-type",
238
+ "kind": "type",
239
+ "entryPoint": "@bitforgehq/ui",
240
+ "summary": "The native input types a text field supports, all bound as strings"
241
+ },
242
+ {
243
+ "name": "BfLabels",
244
+ "slug": "bf-labels",
245
+ "kind": "interface",
246
+ "entryPoint": "@bitforgehq/ui",
247
+ "summary": "Every built-in user-facing string of the library, one key per string"
248
+ },
249
+ {
250
+ "name": "BfLabelsOverrides",
251
+ "slug": "bf-labels-overrides",
252
+ "kind": "type",
253
+ "entryPoint": "@bitforgehq/ui",
254
+ "summary": "The strings provideBfLabels replaces, each one falling back to the parent"
255
+ },
256
+ {
257
+ "name": "BfProgressSize",
258
+ "slug": "bf-progress-size",
259
+ "kind": "type",
260
+ "entryPoint": "@bitforgehq/ui",
261
+ "summary": "The two track heights of a progress bar, thin and regular"
262
+ },
263
+ {
264
+ "name": "BfProgressTone",
265
+ "slug": "bf-progress-tone",
266
+ "kind": "type",
267
+ "entryPoint": "@bitforgehq/ui",
268
+ "summary": "The four fill colours of a progress bar, from primary to danger"
269
+ },
270
+ {
271
+ "name": "BfRadioGroupOrientation",
272
+ "slug": "bf-radio-group-orientation",
273
+ "kind": "type",
274
+ "entryPoint": "@bitforgehq/ui",
275
+ "summary": "Whether a radio group stacks its options or sets them in a row"
276
+ },
277
+ {
278
+ "name": "BfRadioOption",
279
+ "slug": "bf-radio-option",
280
+ "kind": "interface",
281
+ "entryPoint": "@bitforgehq/ui",
282
+ "summary": "One choice of a radio group with its value, label and optional description"
283
+ },
284
+ {
285
+ "name": "BfSegmentedSize",
286
+ "slug": "bf-segmented-size",
287
+ "kind": "type",
288
+ "entryPoint": "@bitforgehq/ui",
289
+ "summary": "Former name of the shared size scale for segmented controls, kept until 1.0.0"
290
+ },
291
+ {
292
+ "name": "BfSegmentOption",
293
+ "slug": "bf-segment-option",
294
+ "kind": "interface",
295
+ "entryPoint": "@bitforgehq/ui",
296
+ "summary": "One segment of a segmented control with its value, its label and a disabled flag"
297
+ },
298
+ {
299
+ "name": "BfSelectOption",
300
+ "slug": "bf-select-option",
301
+ "kind": "interface",
302
+ "entryPoint": "@bitforgehq/ui",
303
+ "summary": "One choice of a select with its value, its label and a disabled flag"
304
+ },
305
+ {
306
+ "name": "BfSize",
307
+ "slug": "bf-size",
308
+ "kind": "type",
309
+ "entryPoint": "@bitforgehq/ui",
310
+ "summary": "The three height steps every sized field and control shares"
311
+ },
312
+ {
313
+ "name": "BfSpinnerSize",
314
+ "slug": "bf-spinner-size",
315
+ "kind": "type",
316
+ "entryPoint": "@bitforgehq/ui",
317
+ "summary": "The three spinner diameters, from inline text to a page loading state"
318
+ },
319
+ {
320
+ "name": "BfTabBarController",
321
+ "slug": "bf-tab-bar-controller",
322
+ "kind": "interface",
323
+ "entryPoint": "@bitforgehq/ui",
324
+ "summary": "The state a parent that drives a projected tab bar gives it to derive from"
325
+ },
326
+ {
327
+ "name": "BfTabBarHost",
328
+ "slug": "bf-tab-bar-host",
329
+ "kind": "interface",
330
+ "entryPoint": "@bitforgehq/ui",
331
+ "summary": "What each tab reads from its tab bar: the selection, tab stop and link mode"
332
+ },
333
+ {
334
+ "name": "BfTabLinks",
335
+ "slug": "bf-tab-links",
336
+ "kind": "interface",
337
+ "entryPoint": "@bitforgehq/ui",
338
+ "summary": "The URLs a router-aware parent gives a tab bar to render its tabs as links"
339
+ },
340
+ {
341
+ "name": "BfToggleLabelPosition",
342
+ "slug": "bf-toggle-label-position",
343
+ "kind": "type",
344
+ "entryPoint": "@bitforgehq/ui",
345
+ "summary": "Whether a toggle's label sits after or before its switch"
346
+ },
347
+ {
348
+ "name": "bfValidationMessage",
349
+ "slug": "bf-validation-message",
350
+ "kind": "function",
351
+ "entryPoint": "@bitforgehq/ui",
352
+ "summary": "Turns one validation error into the text a form field shows under it"
353
+ },
354
+ {
355
+ "name": "BfValidationMessages",
356
+ "slug": "bf-validation-messages",
357
+ "kind": "interface",
358
+ "entryPoint": "@bitforgehq/ui",
359
+ "summary": "The default error text of each validator kind, shown under a form field"
360
+ },
361
+ {
362
+ "name": "provideBfDefaults",
363
+ "slug": "provide-bf-defaults",
364
+ "kind": "function",
365
+ "entryPoint": "@bitforgehq/ui",
366
+ "summary": "Sets the default field and control sizes for an app or a sub-tree"
367
+ },
368
+ {
369
+ "name": "provideBfLabels",
370
+ "slug": "provide-bf-labels",
371
+ "kind": "function",
372
+ "entryPoint": "@bitforgehq/ui",
373
+ "summary": "Replaces built-in strings for an app or a sub-tree, such as a translation"
374
+ },
375
+ {
376
+ "name": "BF_DESKTOP_TOAST_DEFAULTS",
377
+ "slug": "bf_desktop_toast_defaults",
378
+ "kind": "const",
379
+ "entryPoint": "@bitforgehq/ui/overlay",
380
+ "summary": "The library defaults of the desktop toast settings, bottom end with three visible"
381
+ },
382
+ {
383
+ "name": "BF_DIALOG_DATA",
384
+ "slug": "bf_dialog_data",
385
+ "kind": "token",
386
+ "entryPoint": "@bitforgehq/ui/overlay",
387
+ "summary": "Injection token carrying the data a dialog was opened with, for its content"
388
+ },
389
+ {
390
+ "name": "BF_OVERLAY_DATA",
391
+ "slug": "bf_overlay_data",
392
+ "kind": "token",
393
+ "entryPoint": "@bitforgehq/ui/overlay",
394
+ "summary": "Injection token carrying the data an overlay was opened with, for its content"
395
+ },
396
+ {
397
+ "name": "BF_OVERLAY_HOST",
398
+ "slug": "bf_overlay_host",
399
+ "kind": "token",
400
+ "entryPoint": "@bitforgehq/ui/overlay",
401
+ "summary": "Optional injection token through which a host shell plugs into the overlay core"
402
+ },
403
+ {
404
+ "name": "BfComponentOverlayRef",
405
+ "slug": "bf-component-overlay-ref",
406
+ "kind": "class",
407
+ "entryPoint": "@bitforgehq/ui/overlay",
408
+ "summary": "Overlay handle whose content is a component, with access to its ComponentRef"
409
+ },
410
+ {
411
+ "name": "BfConfirmButton",
412
+ "slug": "bf-confirm-button",
413
+ "kind": "interface",
414
+ "entryPoint": "@bitforgehq/ui/overlay",
415
+ "summary": "One button of a confirm dialog: its answer, its label and its role"
416
+ },
417
+ {
418
+ "name": "BfConfirmButtonRole",
419
+ "slug": "bf-confirm-button-role",
420
+ "kind": "type",
421
+ "entryPoint": "@bitforgehq/ui/overlay",
422
+ "summary": "The role of a confirm dialog button, the cancel answer or a destructive action"
423
+ },
424
+ {
425
+ "name": "BfConfirmOptions",
426
+ "slug": "bf-confirm-options",
427
+ "kind": "interface",
428
+ "entryPoint": "@bitforgehq/ui/overlay",
429
+ "summary": "Options of a confirm dialog: its title, message, buttons and width"
430
+ },
431
+ {
432
+ "name": "BfConfirmSize",
433
+ "slug": "bf-confirm-size",
434
+ "kind": "type",
435
+ "entryPoint": "@bitforgehq/ui/overlay",
436
+ "summary": "The two widths a confirm dialog comes in, small or medium"
437
+ },
438
+ {
439
+ "name": "BfDesktopToastConfig",
440
+ "slug": "bf-desktop-toast-config",
441
+ "kind": "interface",
442
+ "entryPoint": "@bitforgehq/ui/overlay",
443
+ "summary": "App-wide settings of desktop toasts: where they sit and how many show at once"
444
+ },
445
+ {
446
+ "name": "BfDesktopToastOptions",
447
+ "slug": "bf-desktop-toast-options",
448
+ "kind": "interface",
449
+ "entryPoint": "@bitforgehq/ui/overlay",
450
+ "summary": "Options of one desktop toast: its message, an action and its duration"
451
+ },
452
+ {
453
+ "name": "BfDesktopToastPosition",
454
+ "slug": "bf-desktop-toast-position",
455
+ "kind": "type",
456
+ "entryPoint": "@bitforgehq/ui/overlay",
457
+ "summary": "The viewport corners and edges a desktop toast stack can anchor to"
458
+ },
459
+ {
460
+ "name": "BfDesktopToastService",
461
+ "slug": "bf-desktop-toast-service",
462
+ "kind": "service",
463
+ "entryPoint": "@bitforgehq/ui/overlay",
464
+ "summary": "Shows brief desktop notifications in a stack at a corner of the viewport"
465
+ },
466
+ {
467
+ "name": "BfDialogConfig",
468
+ "slug": "bf-dialog-config",
469
+ "kind": "interface",
470
+ "entryPoint": "@bitforgehq/ui/overlay",
471
+ "summary": "Options of a dialog: its data, width, role, dismissal, focus and injector"
472
+ },
473
+ {
474
+ "name": "BfDialogRef",
475
+ "slug": "bf-dialog-ref",
476
+ "kind": "class",
477
+ "entryPoint": "@bitforgehq/ui/overlay",
478
+ "summary": "Handle on an open dialog that closes it and resolves with its result"
479
+ },
480
+ {
481
+ "name": "BfDialogRole",
482
+ "slug": "bf-dialog-role",
483
+ "kind": "type",
484
+ "entryPoint": "@bitforgehq/ui/overlay",
485
+ "summary": "The role a dialog carries, plain or an alert dialog that demands an answer"
486
+ },
487
+ {
488
+ "name": "BfDialogService",
489
+ "slug": "bf-dialog-service",
490
+ "kind": "service",
491
+ "entryPoint": "@bitforgehq/ui/overlay",
492
+ "summary": "Opens modal dialogs and confirm prompts, centred over the page with focus trapped"
493
+ },
494
+ {
495
+ "name": "BfDialogSize",
496
+ "slug": "bf-dialog-size",
497
+ "kind": "type",
498
+ "entryPoint": "@bitforgehq/ui/overlay",
499
+ "summary": "The dialog width scale from a 24 rem confirm to an edge-to-edge fullscreen dialog"
500
+ },
501
+ {
502
+ "name": "BfDialogTemplateContext",
503
+ "slug": "bf-dialog-template-context",
504
+ "kind": "interface",
505
+ "entryPoint": "@bitforgehq/ui/overlay",
506
+ "summary": "The context a template opened as a dialog receives: its ref and its data"
507
+ },
508
+ {
509
+ "name": "BfMenuButtonVariant",
510
+ "slug": "bf-menu-button-variant",
511
+ "kind": "type",
512
+ "entryPoint": "@bitforgehq/ui/overlay",
513
+ "summary": "The three visual styles of a menu button, matching the button styles"
514
+ },
515
+ {
516
+ "name": "BfMenuDividerDirective",
517
+ "slug": "bf-menu-divider-directive",
518
+ "kind": "directive",
519
+ "entryPoint": "@bitforgehq/ui/overlay",
520
+ "summary": "A line between groups of menu items that keyboard focus never lands on"
521
+ },
522
+ {
523
+ "name": "BfMenuGroupDirective",
524
+ "slug": "bf-menu-group-directive",
525
+ "kind": "directive",
526
+ "entryPoint": "@bitforgehq/ui/overlay",
527
+ "summary": "Groups related menu items; radio items in one group exclude each other"
528
+ },
529
+ {
530
+ "name": "BfMenuItemCheckboxDirective",
531
+ "slug": "bf-menu-item-checkbox-directive",
532
+ "kind": "directive",
533
+ "entryPoint": "@bitforgehq/ui/overlay",
534
+ "summary": "A menu row that toggles an option on and off with a check mark"
535
+ },
536
+ {
537
+ "name": "BfMenuItemDirective",
538
+ "slug": "bf-menu-item-directive",
539
+ "kind": "directive",
540
+ "entryPoint": "@bitforgehq/ui/overlay",
541
+ "summary": "An action row of a menu on a native button or link, with keyboard rules"
542
+ },
543
+ {
544
+ "name": "BfMenuItemRadioDirective",
545
+ "slug": "bf-menu-item-radio-directive",
546
+ "kind": "directive",
547
+ "entryPoint": "@bitforgehq/ui/overlay",
548
+ "summary": "One choice of a set of exclusive options in a menu, marked with a dot"
549
+ },
550
+ {
551
+ "name": "BfMenuPlacement",
552
+ "slug": "bf-menu-placement",
553
+ "kind": "type",
554
+ "entryPoint": "@bitforgehq/ui/overlay",
555
+ "summary": "Where a menu opens against its trigger, above or below, at either end"
556
+ },
557
+ {
558
+ "name": "BfMenuTriggerDirective",
559
+ "slug": "bf-menu-trigger-directive",
560
+ "kind": "directive",
561
+ "entryPoint": "@bitforgehq/ui/overlay",
562
+ "summary": "Opens a menu from any element with the keyboard and focus rules of menus"
563
+ },
564
+ {
565
+ "name": "BfOverlayAutoFocus",
566
+ "slug": "bf-overlay-auto-focus",
567
+ "kind": "type",
568
+ "entryPoint": "@bitforgehq/ui/overlay",
569
+ "summary": "Where focus lands when an overlay opens, its first control or the panel"
570
+ },
571
+ {
572
+ "name": "BfOverlayController",
573
+ "slug": "bf-overlay-controller",
574
+ "kind": "interface",
575
+ "entryPoint": "@bitforgehq/ui/overlay",
576
+ "summary": "What the overlay service does for a ref: close it and re-apply its position"
577
+ },
578
+ {
579
+ "name": "BfOverlayHost",
580
+ "slug": "bf-overlay-host",
581
+ "kind": "interface",
582
+ "entryPoint": "@bitforgehq/ui/overlay",
583
+ "summary": "What a host shell tells the overlay core: back handling and document scroll"
584
+ },
585
+ {
586
+ "name": "BfOverlayOptions",
587
+ "slug": "bf-overlay-options",
588
+ "kind": "interface",
589
+ "entryPoint": "@bitforgehq/ui/overlay",
590
+ "summary": "Options of an overlay: its data, backdrop, focus, dismissal, position and motion"
591
+ },
592
+ {
593
+ "name": "BfOverlayPosition",
594
+ "slug": "bf-overlay-position",
595
+ "kind": "type",
596
+ "entryPoint": "@bitforgehq/ui/overlay",
597
+ "summary": "Where an overlay panel sits in the viewport: bottom, centre, top or fullscreen"
598
+ },
599
+ {
600
+ "name": "BfOverlayRef",
601
+ "slug": "bf-overlay-ref",
602
+ "kind": "class",
603
+ "entryPoint": "@bitforgehq/ui/overlay",
604
+ "summary": "Handle on an open overlay that closes it and resolves with its result"
605
+ },
606
+ {
607
+ "name": "BfOverlayRole",
608
+ "slug": "bf-overlay-role",
609
+ "kind": "type",
610
+ "entryPoint": "@bitforgehq/ui/overlay",
611
+ "summary": "The role an overlay panel carries: a dialog, an alert dialog or a status"
612
+ },
613
+ {
614
+ "name": "BfOverlayService",
615
+ "slug": "bf-overlay-service",
616
+ "kind": "service",
617
+ "entryPoint": "@bitforgehq/ui/overlay",
618
+ "summary": "Opens a component or template in an overlay panel on the Angular CDK"
619
+ },
620
+ {
621
+ "name": "BfOverlayStack",
622
+ "slug": "bf-overlay-stack",
623
+ "kind": "service",
624
+ "entryPoint": "@bitforgehq/ui/overlay",
625
+ "summary": "Keeps the open overlays in order and makes the page behind them inert"
626
+ },
627
+ {
628
+ "name": "BfOverlayStackOptions",
629
+ "slug": "bf-overlay-stack-options",
630
+ "kind": "interface",
631
+ "entryPoint": "@bitforgehq/ui/overlay",
632
+ "summary": "How an overlay takes part in the stack: its back priority and modal depth"
633
+ },
634
+ {
635
+ "name": "BfOverlayTemplateContext",
636
+ "slug": "bf-overlay-template-context",
637
+ "kind": "interface",
638
+ "entryPoint": "@bitforgehq/ui/overlay",
639
+ "summary": "The context a template opened as an overlay receives: its ref and data"
640
+ },
641
+ {
642
+ "name": "BfStackedOverlay",
643
+ "slug": "bf-stacked-overlay",
644
+ "kind": "interface",
645
+ "entryPoint": "@bitforgehq/ui/overlay",
646
+ "summary": "What the overlay stack needs of an overlay: a way to close it"
647
+ },
648
+ {
649
+ "name": "BfToastAction",
650
+ "slug": "bf-toast-action",
651
+ "kind": "interface",
652
+ "entryPoint": "@bitforgehq/ui/overlay",
653
+ "summary": "The action button of a toast: its label and what it runs when clicked"
654
+ },
655
+ {
656
+ "name": "BfToastController",
657
+ "slug": "bf-toast-controller",
658
+ "kind": "interface",
659
+ "entryPoint": "@bitforgehq/ui/overlay",
660
+ "summary": "What the toast queue does for a toast ref: dismiss the toast now"
661
+ },
662
+ {
663
+ "name": "BfToastDismissReason",
664
+ "slug": "bf-toast-dismiss-reason",
665
+ "kind": "type",
666
+ "entryPoint": "@bitforgehq/ui/overlay",
667
+ "summary": "Why a toast ended: its time ran out, its action fired or it was dismissed"
668
+ },
669
+ {
670
+ "name": "BfToastRef",
671
+ "slug": "bf-toast-ref",
672
+ "kind": "class",
673
+ "entryPoint": "@bitforgehq/ui/overlay",
674
+ "summary": "Handle on a shown or queued toast that dismisses it and reports why it ended"
675
+ },
676
+ {
677
+ "name": "fadeDown",
678
+ "slug": "fade-down",
679
+ "kind": "function",
680
+ "entryPoint": "@bitforgehq/ui/overlay",
681
+ "summary": "Fades an element out while it sinks, the reverse of the fadeUp animation"
682
+ },
683
+ {
684
+ "name": "fadeIn",
685
+ "slug": "fade-in",
686
+ "kind": "function",
687
+ "entryPoint": "@bitforgehq/ui/overlay",
688
+ "summary": "Fades an element in, the default enter animation of an overlay"
689
+ },
690
+ {
691
+ "name": "fadeOut",
692
+ "slug": "fade-out",
693
+ "kind": "function",
694
+ "entryPoint": "@bitforgehq/ui/overlay",
695
+ "summary": "Fades an element out, the default exit animation of an overlay"
696
+ },
697
+ {
698
+ "name": "fadeUp",
699
+ "slug": "fade-up",
700
+ "kind": "function",
701
+ "entryPoint": "@bitforgehq/ui/overlay",
702
+ "summary": "Fades an element in while it rises, the Material modal enter animation"
703
+ },
704
+ {
705
+ "name": "OVERLAY_DURATION",
706
+ "slug": "overlay_duration",
707
+ "kind": "const",
708
+ "entryPoint": "@bitforgehq/ui/overlay",
709
+ "summary": "The duration of every overlay enter and exit animation, in milliseconds"
710
+ },
711
+ {
712
+ "name": "OVERLAY_EASING",
713
+ "slug": "overlay_easing",
714
+ "kind": "const",
715
+ "entryPoint": "@bitforgehq/ui/overlay",
716
+ "summary": "The easing curve of the overlay animations, the UIKit sheet curve"
717
+ },
718
+ {
719
+ "name": "OVERLAY_REDUCED_DURATION",
720
+ "slug": "overlay_reduced_duration",
721
+ "kind": "const",
722
+ "entryPoint": "@bitforgehq/ui/overlay",
723
+ "summary": "The duration of the fade that replaces overlay motion under reduced motion"
724
+ },
725
+ {
726
+ "name": "prefersReducedMotion",
727
+ "slug": "prefers-reduced-motion",
728
+ "kind": "function",
729
+ "entryPoint": "@bitforgehq/ui/overlay",
730
+ "summary": "Tells whether the user asked the system to minimise motion"
731
+ },
732
+ {
733
+ "name": "provideBfDesktopToast",
734
+ "slug": "provide-bf-desktop-toast",
735
+ "kind": "function",
736
+ "entryPoint": "@bitforgehq/ui/overlay",
737
+ "summary": "Sets where desktop toasts appear and how many show at once, app-wide"
738
+ },
739
+ {
740
+ "name": "scaleIn",
741
+ "slug": "scale-in",
742
+ "kind": "function",
743
+ "entryPoint": "@bitforgehq/ui/overlay",
744
+ "summary": "Scales an element up while fading it in, the enter animation of centred dialogs"
745
+ },
746
+ {
747
+ "name": "slideDown",
748
+ "slug": "slide-down",
749
+ "kind": "function",
750
+ "entryPoint": "@bitforgehq/ui/overlay",
751
+ "summary": "Slides an element down out of place, the exit animation of a bottom sheet"
752
+ },
753
+ {
754
+ "name": "slideUp",
755
+ "slug": "slide-up",
756
+ "kind": "function",
757
+ "entryPoint": "@bitforgehq/ui/overlay",
758
+ "summary": "Slides an element up into place, the enter animation of a bottom sheet"
759
+ },
760
+ {
761
+ "name": "BfIconSize",
762
+ "slug": "bf-icon-size",
763
+ "kind": "type",
764
+ "entryPoint": "@bitforgehq/ui/icons",
765
+ "summary": "The three icon sizes, 16, 20 and 24 pixels, matching the text sizes"
766
+ },
767
+ {
768
+ "name": "BfNumberInputMode",
769
+ "slug": "bf-number-input-mode",
770
+ "kind": "type",
771
+ "entryPoint": "@bitforgehq/ui/number-input",
772
+ "summary": "The virtual keyboards a number field can ask a phone to show"
773
+ },
774
+ {
775
+ "name": "BfNumberInputStep",
776
+ "slug": "bf-number-input-step",
777
+ "kind": "type",
778
+ "entryPoint": "@bitforgehq/ui/number-input",
779
+ "summary": "The step of a number field, a number or any for no step check"
780
+ },
781
+ {
782
+ "name": "BF_SHEET_DEFAULT_SNAP_POINTS",
783
+ "slug": "bf_sheet_default_snap_points",
784
+ "kind": "const",
785
+ "entryPoint": "@bitforgehq/ui/mobile",
786
+ "summary": "The snap points a bottom sheet rests at when none are given, half and full"
787
+ },
788
+ {
789
+ "name": "BF_SHELL_CONFIG",
790
+ "slug": "bf_shell_config",
791
+ "kind": "token",
792
+ "entryPoint": "@bitforgehq/ui/mobile",
793
+ "summary": "Injection token holding the resolved mobile shell configuration of the app"
794
+ },
795
+ {
796
+ "name": "BF_SHELL_DEFAULTS",
797
+ "slug": "bf_shell_defaults",
798
+ "kind": "const",
799
+ "entryPoint": "@bitforgehq/ui/mobile",
800
+ "summary": "The mobile shell defaults that provideBfShell merges the app settings over"
801
+ },
802
+ {
803
+ "name": "BF_TAB_CONTEXT",
804
+ "slug": "bf_tab_context",
805
+ "kind": "token",
806
+ "entryPoint": "@bitforgehq/ui/mobile",
807
+ "summary": "Injection token through which the tabs page tells its outlet about the tabs"
808
+ },
809
+ {
810
+ "name": "BF_THEME_STORAGE",
811
+ "slug": "bf_theme_storage",
812
+ "kind": "token",
813
+ "entryPoint": "@bitforgehq/ui/mobile",
814
+ "summary": "Injection token for the store that keeps the app theme choice between visits"
815
+ },
816
+ {
817
+ "name": "BfActionSheetAction",
818
+ "slug": "bf-action-sheet-action",
819
+ "kind": "interface",
820
+ "entryPoint": "@bitforgehq/ui/mobile",
821
+ "summary": "One row of an action sheet, or its cancel button, with its answer and role"
822
+ },
823
+ {
824
+ "name": "BfActionSheetActionRole",
825
+ "slug": "bf-action-sheet-action-role",
826
+ "kind": "type",
827
+ "entryPoint": "@bitforgehq/ui/mobile",
828
+ "summary": "The role of an action sheet row, a destructive action or the cancel button"
829
+ },
830
+ {
831
+ "name": "BfActionSheetOptions",
832
+ "slug": "bf-action-sheet-options",
833
+ "kind": "interface",
834
+ "entryPoint": "@bitforgehq/ui/mobile",
835
+ "summary": "Options of an action sheet: its title, its rows and when it closes"
836
+ },
837
+ {
838
+ "name": "BfActionSheetService",
839
+ "slug": "bf-action-sheet-service",
840
+ "kind": "service",
841
+ "entryPoint": "@bitforgehq/ui/mobile",
842
+ "summary": "Opens bottom action sheets that resolve with the row the user tapped"
843
+ },
844
+ {
845
+ "name": "BfAlertDialogButton",
846
+ "slug": "bf-alert-dialog-button",
847
+ "kind": "interface",
848
+ "entryPoint": "@bitforgehq/ui/mobile",
849
+ "summary": "One button of an alert dialog: its answer, its label and its role"
850
+ },
851
+ {
852
+ "name": "BfAlertDialogButtonRole",
853
+ "slug": "bf-alert-dialog-button-role",
854
+ "kind": "type",
855
+ "entryPoint": "@bitforgehq/ui/mobile",
856
+ "summary": "The role of an alert dialog button, the cancel answer or a destructive action"
857
+ },
858
+ {
859
+ "name": "BfAlertDialogOptions",
860
+ "slug": "bf-alert-dialog-options",
861
+ "kind": "interface",
862
+ "entryPoint": "@bitforgehq/ui/mobile",
863
+ "summary": "Options of an alert dialog: its title, message, buttons and when it closes"
864
+ },
865
+ {
866
+ "name": "BfAlertDialogService",
867
+ "slug": "bf-alert-dialog-service",
868
+ "kind": "service",
869
+ "entryPoint": "@bitforgehq/ui/mobile",
870
+ "summary": "Opens small centred alerts that resolve with the button the user tapped"
871
+ },
872
+ {
873
+ "name": "BfBackAtRoot",
874
+ "slug": "bf-back-at-root",
875
+ "kind": "type",
876
+ "entryPoint": "@bitforgehq/ui/mobile",
877
+ "summary": "What Android back does at a stack root, background the app or exit it"
878
+ },
879
+ {
880
+ "name": "BfBackButtonService",
881
+ "slug": "bf-back-button-service",
882
+ "kind": "service",
883
+ "entryPoint": "@bitforgehq/ui/mobile",
884
+ "summary": "The Android hardware back button queue that overlays and navigation stacks share"
885
+ },
886
+ {
887
+ "name": "BfContentScrollEvent",
888
+ "slug": "bf-content-scroll-event",
889
+ "kind": "interface",
890
+ "entryPoint": "@bitforgehq/ui/mobile",
891
+ "summary": "What a content scroll event carries: the scroller's current top offset"
892
+ },
893
+ {
894
+ "name": "BfHapticsImpactStyle",
895
+ "slug": "bf-haptics-impact-style",
896
+ "kind": "type",
897
+ "entryPoint": "@bitforgehq/ui/mobile",
898
+ "summary": "The weight of an impact haptic, light, medium or heavy"
899
+ },
900
+ {
901
+ "name": "BfHapticsNotificationType",
902
+ "slug": "bf-haptics-notification-type",
903
+ "kind": "type",
904
+ "entryPoint": "@bitforgehq/ui/mobile",
905
+ "summary": "The outcome a notification haptic reports: success, warning or error"
906
+ },
907
+ {
908
+ "name": "BfHapticsService",
909
+ "slug": "bf-haptics-service",
910
+ "kind": "service",
911
+ "entryPoint": "@bitforgehq/ui/mobile",
912
+ "summary": "Haptic feedback on native devices that silently does nothing on the web"
913
+ },
914
+ {
915
+ "name": "BfHorizontalScrollDirective",
916
+ "slug": "bf-horizontal-scroll-directive",
917
+ "kind": "directive",
918
+ "entryPoint": "@bitforgehq/ui/mobile",
919
+ "summary": "Deprecated touch-action opt-in for horizontal scrollers in stack pages, not needed"
920
+ },
921
+ {
922
+ "name": "BfKeyboardAssistBehavior",
923
+ "slug": "bf-keyboard-assist-behavior",
924
+ "kind": "type",
925
+ "entryPoint": "@bitforgehq/ui/mobile",
926
+ "summary": "Whether the keyboard assist scrolls a focused field into view smoothly or at once"
927
+ },
928
+ {
929
+ "name": "BfKeyboardAssistDirective",
930
+ "slug": "bf-keyboard-assist-directive",
931
+ "kind": "directive",
932
+ "entryPoint": "@bitforgehq/ui/mobile",
933
+ "summary": "Keeps the focused text field of a scroll container clear of the soft keyboard"
934
+ },
935
+ {
936
+ "name": "BfKeyboardPhase",
937
+ "slug": "bf-keyboard-phase",
938
+ "kind": "type",
939
+ "entryPoint": "@bitforgehq/ui/mobile",
940
+ "summary": "The soft keyboard phase, hidden, showing or shown, for animations only"
941
+ },
942
+ {
943
+ "name": "BfKeyboardService",
944
+ "slug": "bf-keyboard-service",
945
+ "kind": "service",
946
+ "entryPoint": "@bitforgehq/ui/mobile",
947
+ "summary": "The soft keyboard state as signals: visible, its height and its phase"
948
+ },
949
+ {
950
+ "name": "BfModalOptions",
951
+ "slug": "bf-modal-options",
952
+ "kind": "interface",
953
+ "entryPoint": "@bitforgehq/ui/mobile",
954
+ "summary": "Options of a modal: its data, presentation, dismissal and accessible name"
955
+ },
956
+ {
957
+ "name": "BfModalPresentation",
958
+ "slug": "bf-modal-presentation",
959
+ "kind": "type",
960
+ "entryPoint": "@bitforgehq/ui/mobile",
961
+ "summary": "How a modal is presented: a page-sheet card over the stack, or fullscreen"
962
+ },
963
+ {
964
+ "name": "BfModalService",
965
+ "slug": "bf-modal-service",
966
+ "kind": "service",
967
+ "entryPoint": "@bitforgehq/ui/mobile",
968
+ "summary": "Opens a component as a modal page sheet over the stack, or fullscreen"
969
+ },
970
+ {
971
+ "name": "BfNavController",
972
+ "slug": "bf-nav-controller",
973
+ "kind": "service",
974
+ "entryPoint": "@bitforgehq/ui/mobile",
975
+ "summary": "Stack-aware navigation that pushes, pops through the history and replaces the root"
976
+ },
977
+ {
978
+ "name": "BfNavDirection",
979
+ "slug": "bf-nav-direction",
980
+ "kind": "type",
981
+ "entryPoint": "@bitforgehq/ui/mobile",
982
+ "summary": "The direction a stack navigation animates in: forward, back or a new root"
983
+ },
984
+ {
985
+ "name": "BfNavTarget",
986
+ "slug": "bf-nav-target",
987
+ "kind": "type",
988
+ "entryPoint": "@bitforgehq/ui/mobile",
989
+ "summary": "A navigation target as the router accepts it: a URL, a UrlTree or commands"
990
+ },
991
+ {
992
+ "name": "BfOverscrollStretchDirective",
993
+ "slug": "bf-overscroll-stretch-directive",
994
+ "kind": "directive",
995
+ "entryPoint": "@bitforgehq/ui/mobile",
996
+ "summary": "Android-style stretch of a scroll container dragged past its top or bottom edge"
997
+ },
998
+ {
999
+ "name": "BfPageContext",
1000
+ "slug": "bf-page-context",
1001
+ "kind": "class",
1002
+ "entryPoint": "@bitforgehq/ui/mobile",
1003
+ "summary": "Per-page state that the header and content of one page share"
1004
+ },
1005
+ {
1006
+ "name": "BfPlatform",
1007
+ "slug": "bf-platform",
1008
+ "kind": "type",
1009
+ "entryPoint": "@bitforgehq/ui/mobile",
1010
+ "summary": "The platform the app runs on, native iOS, native Android or the web"
1011
+ },
1012
+ {
1013
+ "name": "BfPlatformService",
1014
+ "slug": "bf-platform-service",
1015
+ "kind": "service",
1016
+ "entryPoint": "@bitforgehq/ui/mobile",
1017
+ "summary": "Platform facts and the app theme: native or web, iOS or Android, light or dark"
1018
+ },
1019
+ {
1020
+ "name": "BfRefresherRefreshEvent",
1021
+ "slug": "bf-refresher-refresh-event",
1022
+ "kind": "interface",
1023
+ "entryPoint": "@bitforgehq/ui/mobile",
1024
+ "summary": "What a pull-to-refresh request carries: the callback that ends the refresh"
1025
+ },
1026
+ {
1027
+ "name": "BfSheetAutoFocus",
1028
+ "slug": "bf-sheet-auto-focus",
1029
+ "kind": "type",
1030
+ "entryPoint": "@bitforgehq/ui/mobile",
1031
+ "summary": "Where focus lands when a sheet opens, the sheet itself or its first field"
1032
+ },
1033
+ {
1034
+ "name": "BfSheetOptions",
1035
+ "slug": "bf-sheet-options",
1036
+ "kind": "interface",
1037
+ "entryPoint": "@bitforgehq/ui/mobile",
1038
+ "summary": "Options of a bottom sheet: where it rests, how it closes and its name"
1039
+ },
1040
+ {
1041
+ "name": "BfSheetRef",
1042
+ "slug": "bf-sheet-ref",
1043
+ "kind": "class",
1044
+ "entryPoint": "@bitforgehq/ui/mobile",
1045
+ "summary": "Handle on an open bottom sheet that moves it between snap points and closes it"
1046
+ },
1047
+ {
1048
+ "name": "BfSheetService",
1049
+ "slug": "bf-sheet-service",
1050
+ "kind": "service",
1051
+ "entryPoint": "@bitforgehq/ui/mobile",
1052
+ "summary": "Opens bottom sheets that rest at snap points and close with a result"
1053
+ },
1054
+ {
1055
+ "name": "BfShellConfig",
1056
+ "slug": "bf-shell-config",
1057
+ "kind": "interface",
1058
+ "entryPoint": "@bitforgehq/ui/mobile",
1059
+ "summary": "The mobile shell settings: mode, swipe-back, haptics, Dynamic Type and system bars"
1060
+ },
1061
+ {
1062
+ "name": "BfShellConfigMode",
1063
+ "slug": "bf-shell-config-mode",
1064
+ "kind": "type",
1065
+ "entryPoint": "@bitforgehq/ui/mobile",
1066
+ "summary": "The shell style setting, iOS, Material or automatic from the platform"
1067
+ },
1068
+ {
1069
+ "name": "BfShellDynamicType",
1070
+ "slug": "bf-shell-dynamic-type",
1071
+ "kind": "type",
1072
+ "entryPoint": "@bitforgehq/ui/mobile",
1073
+ "summary": "Whether the shell follows iOS Dynamic Type, and up to which scale"
1074
+ },
1075
+ {
1076
+ "name": "BfShellDynamicTypeLimit",
1077
+ "slug": "bf-shell-dynamic-type-limit",
1078
+ "kind": "interface",
1079
+ "entryPoint": "@bitforgehq/ui/mobile",
1080
+ "summary": "The largest root font scale iOS Dynamic Type may apply in the shell"
1081
+ },
1082
+ {
1083
+ "name": "BfShellMode",
1084
+ "slug": "bf-shell-mode",
1085
+ "kind": "type",
1086
+ "entryPoint": "@bitforgehq/ui/mobile",
1087
+ "summary": "The shell's look and motion conventions, iOS or Material Design"
1088
+ },
1089
+ {
1090
+ "name": "BfShellTestingOptions",
1091
+ "slug": "bf-shell-testing-options",
1092
+ "kind": "interface",
1093
+ "entryPoint": "@bitforgehq/ui/mobile",
1094
+ "summary": "Options of the shell test providers: the routes and the shell settings"
1095
+ },
1096
+ {
1097
+ "name": "BfStackChange",
1098
+ "slug": "bf-stack-change",
1099
+ "kind": "interface",
1100
+ "entryPoint": "@bitforgehq/ui/mobile",
1101
+ "summary": "What a stack outlet reports after its stack changed: the depth and the tab"
1102
+ },
1103
+ {
1104
+ "name": "BfStackReuseStrategy",
1105
+ "slug": "bf-stack-reuse-strategy",
1106
+ "kind": "service",
1107
+ "entryPoint": "@bitforgehq/ui/mobile",
1108
+ "summary": "Route reuse strategy that treats a changed path parameter as a new stack page"
1109
+ },
1110
+ {
1111
+ "name": "BfStackTransition",
1112
+ "slug": "bf-stack-transition",
1113
+ "kind": "interface",
1114
+ "entryPoint": "@bitforgehq/ui/mobile",
1115
+ "summary": "A running set of page transition animations that finish together"
1116
+ },
1117
+ {
1118
+ "name": "BfStackTransitionEvent",
1119
+ "slug": "bf-stack-transition-event",
1120
+ "kind": "interface",
1121
+ "entryPoint": "@bitforgehq/ui/mobile",
1122
+ "summary": "What a stack outlet reports around a page transition: its kind and animation"
1123
+ },
1124
+ {
1125
+ "name": "bfSystemBarsStyle",
1126
+ "slug": "bf-system-bars-style",
1127
+ "kind": "function",
1128
+ "entryPoint": "@bitforgehq/ui/mobile",
1129
+ "summary": "The system-bar icon style that keeps the bars readable in the in-app theme"
1130
+ },
1131
+ {
1132
+ "name": "BfTabContext",
1133
+ "slug": "bf-tab-context",
1134
+ "kind": "interface",
1135
+ "entryPoint": "@bitforgehq/ui/mobile",
1136
+ "summary": "What the tabs page tells its stack outlet: which tab a URL belongs to"
1137
+ },
1138
+ {
1139
+ "name": "BfTextScaleService",
1140
+ "slug": "bf-text-scale-service",
1141
+ "kind": "service",
1142
+ "entryPoint": "@bitforgehq/ui/mobile",
1143
+ "summary": "Follows iOS Dynamic Type by scaling the root font size of the app"
1144
+ },
1145
+ {
1146
+ "name": "BfTheme",
1147
+ "slug": "bf-theme",
1148
+ "kind": "type",
1149
+ "entryPoint": "@bitforgehq/ui/mobile",
1150
+ "summary": "The app theme choice, following the system or forcing light or dark"
1151
+ },
1152
+ {
1153
+ "name": "BfToastOptions",
1154
+ "slug": "bf-toast-options",
1155
+ "kind": "interface",
1156
+ "entryPoint": "@bitforgehq/ui/mobile",
1157
+ "summary": "Options of a mobile toast: its message, an action, its duration and position"
1158
+ },
1159
+ {
1160
+ "name": "BfToastPosition",
1161
+ "slug": "bf-toast-position",
1162
+ "kind": "type",
1163
+ "entryPoint": "@bitforgehq/ui/mobile",
1164
+ "summary": "Where a mobile toast pill anchors in the viewport, at the bottom or top"
1165
+ },
1166
+ {
1167
+ "name": "BfToastService",
1168
+ "slug": "bf-toast-service",
1169
+ "kind": "service",
1170
+ "entryPoint": "@bitforgehq/ui/mobile",
1171
+ "summary": "Shows brief toast pills on phones, one at a time, queued in order"
1172
+ },
1173
+ {
1174
+ "name": "BfTransitionKind",
1175
+ "slug": "bf-transition-kind",
1176
+ "kind": "type",
1177
+ "entryPoint": "@bitforgehq/ui/mobile",
1178
+ "summary": "The direction of a stack transition, a page pushed on or popped off"
1179
+ },
1180
+ {
1181
+ "name": "BfViewEvent",
1182
+ "slug": "bf-view-event",
1183
+ "kind": "type",
1184
+ "entryPoint": "@bitforgehq/ui/mobile",
1185
+ "summary": "The four lifecycle events of a stacked page as it enters and leaves"
1186
+ },
1187
+ {
1188
+ "name": "BfViewLifecycle",
1189
+ "slug": "bf-view-lifecycle",
1190
+ "kind": "class",
1191
+ "entryPoint": "@bitforgehq/ui/mobile",
1192
+ "summary": "The lifecycle of one stacked page as signals and events, from enter to leave"
1193
+ },
1194
+ {
1195
+ "name": "BfViewState",
1196
+ "slug": "bf-view-state",
1197
+ "kind": "type",
1198
+ "entryPoint": "@bitforgehq/ui/mobile",
1199
+ "summary": "Where a stacked page is in its lifecycle: entering, active, leaving or inactive"
1200
+ },
1201
+ {
1202
+ "name": "createTransition",
1203
+ "slug": "create-transition",
1204
+ "kind": "function",
1205
+ "entryPoint": "@bitforgehq/ui/mobile",
1206
+ "summary": "Builds the iOS push or pop with its slide, parallax and dimming layers"
1207
+ },
1208
+ {
1209
+ "name": "DURATION_FAST",
1210
+ "slug": "duration_fast",
1211
+ "kind": "const",
1212
+ "entryPoint": "@bitforgehq/ui/mobile",
1213
+ "summary": "The duration of colour transitions and the reduced-motion fade, in milliseconds"
1214
+ },
1215
+ {
1216
+ "name": "DURATION_MD",
1217
+ "slug": "duration_md",
1218
+ "kind": "const",
1219
+ "entryPoint": "@bitforgehq/ui/mobile",
1220
+ "summary": "The duration of the Material fade-up and the refresher settle, in milliseconds"
1221
+ },
1222
+ {
1223
+ "name": "DURATION_OVERLAY",
1224
+ "slug": "duration_overlay",
1225
+ "kind": "const",
1226
+ "entryPoint": "@bitforgehq/ui/mobile",
1227
+ "summary": "The duration of overlay enter and exit and the modal depth effect, in milliseconds"
1228
+ },
1229
+ {
1230
+ "name": "DURATION_PUSH",
1231
+ "slug": "duration_push",
1232
+ "kind": "const",
1233
+ "entryPoint": "@bitforgehq/ui/mobile",
1234
+ "summary": "The duration of the iOS push and pop page transitions, in milliseconds"
1235
+ },
1236
+ {
1237
+ "name": "injectShellMode",
1238
+ "slug": "inject-shell-mode",
1239
+ "kind": "function",
1240
+ "entryPoint": "@bitforgehq/ui/mobile",
1241
+ "summary": "Reads the shell mode in effect from the injector, iOS or Material"
1242
+ },
1243
+ {
1244
+ "name": "IOS_DURATION",
1245
+ "slug": "ios_duration",
1246
+ "kind": "const",
1247
+ "entryPoint": "@bitforgehq/ui/mobile",
1248
+ "summary": "The duration of the iOS push and pop stack transitions, in milliseconds"
1249
+ },
1250
+ {
1251
+ "name": "IOS_EASING",
1252
+ "slug": "ios_easing",
1253
+ "kind": "const",
1254
+ "entryPoint": "@bitforgehq/ui/mobile",
1255
+ "summary": "The UIKit navigation and sheet easing curve of pushes, pops and overlays"
1256
+ },
1257
+ {
1258
+ "name": "isTextEntry",
1259
+ "slug": "is-text-entry",
1260
+ "kind": "function",
1261
+ "entryPoint": "@bitforgehq/ui/mobile",
1262
+ "summary": "Tells whether focusing an element opens the soft keyboard on a phone"
1263
+ },
1264
+ {
1265
+ "name": "MAX_COMPLETE_MS",
1266
+ "slug": "max_complete_ms",
1267
+ "kind": "const",
1268
+ "entryPoint": "@bitforgehq/ui/mobile",
1269
+ "summary": "The longest a released swipe-back may take to settle, in milliseconds"
1270
+ },
1271
+ {
1272
+ "name": "MD_DURATION",
1273
+ "slug": "md_duration",
1274
+ "kind": "const",
1275
+ "entryPoint": "@bitforgehq/ui/mobile",
1276
+ "summary": "The duration of the Material fade-up stack transition, in milliseconds"
1277
+ },
1278
+ {
1279
+ "name": "MD_EASING",
1280
+ "slug": "md_easing",
1281
+ "kind": "const",
1282
+ "entryPoint": "@bitforgehq/ui/mobile",
1283
+ "summary": "The Material standard easing curve of the Android page fade-up transition"
1284
+ },
1285
+ {
1286
+ "name": "mdTransition",
1287
+ "slug": "md-transition",
1288
+ "kind": "function",
1289
+ "entryPoint": "@bitforgehq/ui/mobile",
1290
+ "summary": "Builds the Material fade-up page transition of a push or a pop"
1291
+ },
1292
+ {
1293
+ "name": "popFramesAt",
1294
+ "slug": "pop-frames-at",
1295
+ "kind": "function",
1296
+ "entryPoint": "@bitforgehq/ui/mobile",
1297
+ "summary": "The positions of the pop layers at a given progress, for scrubbing a swipe"
1298
+ },
1299
+ {
1300
+ "name": "provideBfShell",
1301
+ "slug": "provide-bf-shell",
1302
+ "kind": "function",
1303
+ "entryPoint": "@bitforgehq/ui/mobile",
1304
+ "summary": "Provides the Capacitor app shell: its configuration, navigation and platform services"
1305
+ },
1306
+ {
1307
+ "name": "provideBfShellTesting",
1308
+ "slug": "provide-bf-shell-testing",
1309
+ "kind": "function",
1310
+ "entryPoint": "@bitforgehq/ui/mobile",
1311
+ "summary": "Test providers for the mobile shell: router, shell, in-memory theme and cleanup"
1312
+ },
1313
+ {
1314
+ "name": "REDUCED_DURATION",
1315
+ "slug": "reduced_duration",
1316
+ "kind": "const",
1317
+ "entryPoint": "@bitforgehq/ui/mobile",
1318
+ "summary": "The duration of the cross-fade that replaces page motion under reduced motion"
1319
+ },
1320
+ {
1321
+ "name": "reducedTransition",
1322
+ "slug": "reduced-transition",
1323
+ "kind": "function",
1324
+ "entryPoint": "@bitforgehq/ui/mobile",
1325
+ "summary": "Builds the cross-fade that replaces page motion when the user reduces motion"
1326
+ },
1327
+ {
1328
+ "name": "resolveShellMode",
1329
+ "slug": "resolve-shell-mode",
1330
+ "kind": "function",
1331
+ "entryPoint": "@bitforgehq/ui/mobile",
1332
+ "summary": "Resolves the shell mode in effect from the configuration and the platform"
1333
+ },
1334
+ {
1335
+ "name": "SETTLE_EASING",
1336
+ "slug": "settle_easing",
1337
+ "kind": "const",
1338
+ "entryPoint": "@bitforgehq/ui/mobile",
1339
+ "summary": "The ease-out curve a released swipe-back or refresher gesture settles with"
1340
+ },
1341
+ {
1342
+ "name": "settleDuration",
1343
+ "slug": "settle-duration",
1344
+ "kind": "function",
1345
+ "entryPoint": "@bitforgehq/ui/mobile",
1346
+ "summary": "The duration of the settle animation after a released swipe-back gesture"
1347
+ },
1348
+ {
1349
+ "name": "settlePop",
1350
+ "slug": "settle-pop",
1351
+ "kind": "function",
1352
+ "entryPoint": "@bitforgehq/ui/mobile",
1353
+ "summary": "Animates a released swipe-back from its progress to done or back to the start"
1354
+ },
1355
+ {
1356
+ "name": "shouldCompletePop",
1357
+ "slug": "should-complete-pop",
1358
+ "kind": "function",
1359
+ "entryPoint": "@bitforgehq/ui/mobile",
1360
+ "summary": "Decides whether a released swipe-back completes the pop or settles back"
1361
+ },
1362
+ {
1363
+ "name": "withBfShellRouting",
1364
+ "slug": "with-bf-shell-routing",
1365
+ "kind": "function",
1366
+ "entryPoint": "@bitforgehq/ui/mobile",
1367
+ "summary": "The router setting the mobile shell's stack needs, passed to provideRouter"
1368
+ },
1369
+ {
1370
+ "name": "BfDesktopToastHarness",
1371
+ "slug": "bf-desktop-toast-harness",
1372
+ "kind": "class",
1373
+ "entryPoint": "@bitforgehq/ui/testing",
1374
+ "summary": "Test harness for a desktop toast: its message, its action and Escape"
1375
+ },
1376
+ {
1377
+ "name": "BfDialogHarness",
1378
+ "slug": "bf-dialog-harness",
1379
+ "kind": "class",
1380
+ "entryPoint": "@bitforgehq/ui/testing",
1381
+ "summary": "Test harness for a dialog: its title, text and role, its buttons and Escape"
1382
+ },
1383
+ {
1384
+ "name": "BfHarnessFilters",
1385
+ "slug": "bf-harness-filters",
1386
+ "kind": "interface",
1387
+ "entryPoint": "@bitforgehq/ui/testing",
1388
+ "summary": "Filters a library harness query by selector, ancestor and the widget label"
1389
+ },
1390
+ {
1391
+ "name": "BfJsdomShimOptions",
1392
+ "slug": "bf-jsdom-shim-options",
1393
+ "kind": "interface",
1394
+ "entryPoint": "@bitforgehq/ui/testing",
1395
+ "summary": "Options of the jsdom shims: the matchMedia stub and its reduced-motion answer"
1396
+ },
1397
+ {
1398
+ "name": "BfMenuButtonHarness",
1399
+ "slug": "bf-menu-button-harness",
1400
+ "kind": "class",
1401
+ "entryPoint": "@bitforgehq/ui/testing",
1402
+ "summary": "Test harness for a menu button: opens it and hands out the menu it opened"
1403
+ },
1404
+ {
1405
+ "name": "BfMenuHarness",
1406
+ "slug": "bf-menu-harness",
1407
+ "kind": "class",
1408
+ "entryPoint": "@bitforgehq/ui/testing",
1409
+ "summary": "Test harness for a menu: lists its items and clicks one, through submenus"
1410
+ },
1411
+ {
1412
+ "name": "BfMenuItemHarness",
1413
+ "slug": "bf-menu-item-harness",
1414
+ "kind": "class",
1415
+ "entryPoint": "@bitforgehq/ui/testing",
1416
+ "summary": "Test harness for a menu row: its text, disabled, checked and submenu state"
1417
+ },
1418
+ {
1419
+ "name": "BfRadioGroupHarness",
1420
+ "slug": "bf-radio-group-harness",
1421
+ "kind": "class",
1422
+ "entryPoint": "@bitforgehq/ui/testing",
1423
+ "summary": "Test harness for the radio group: reads its options and selects one by label"
1424
+ },
1425
+ {
1426
+ "name": "BfSegmentedHarness",
1427
+ "slug": "bf-segmented-harness",
1428
+ "kind": "class",
1429
+ "entryPoint": "@bitforgehq/ui/testing",
1430
+ "summary": "Test harness for the segmented control: reads its segments and selects one"
1431
+ },
1432
+ {
1433
+ "name": "BfSelectHarness",
1434
+ "slug": "bf-select-harness",
1435
+ "kind": "class",
1436
+ "entryPoint": "@bitforgehq/ui/testing",
1437
+ "summary": "Test harness for the select: reads its label and options and picks one"
1438
+ },
1439
+ {
1440
+ "name": "BfTestingOptions",
1441
+ "slug": "bf-testing-options",
1442
+ "kind": "interface",
1443
+ "entryPoint": "@bitforgehq/ui/testing",
1444
+ "summary": "Options of the test providers: the size defaults and labels a spec runs with"
1445
+ },
1446
+ {
1447
+ "name": "installBfJsdomShims",
1448
+ "slug": "install-bf-jsdom-shims",
1449
+ "kind": "function",
1450
+ "entryPoint": "@bitforgehq/ui/testing",
1451
+ "summary": "Installs the browser APIs jsdom lacks and the library needs, only where missing"
1452
+ },
1453
+ {
1454
+ "name": "provideBfTesting",
1455
+ "slug": "provide-bf-testing",
1456
+ "kind": "function",
1457
+ "entryPoint": "@bitforgehq/ui/testing",
1458
+ "summary": "Test providers for the widgets and overlays, with document cleanup after each test"
1459
+ }
1460
+ ]
1461
+ }