@bitforgehq/ui 0.3.0

package/ai/reference/bf-tab-bar-host.md

@@ -0,0 +1,52 @@
+# BfTabBarHost
+
+What each tab reads from its tab bar: the selection, tab stop and link mode
+
+Interface from `@bitforgehq/ui` · since 0.1.0
+
+What `bf-tab` needs from its enclosing `bf-tab-bar`, provided through an injection token so
+`tab-bar.component.ts` and `tab.component.ts` never import each other.
+
+```ts
+import { type BfTabBarHost } from '@bitforgehq/ui';
+```
+
+## Properties
+
+| Name       | Type             | Default  | Description                                                                                                                                                                                                                                           |
+| ---------- | ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `active`   | `Signal<string>` | required | The id of the selected tab, the bar's `active` model.                                                                                                                                                                                                 |
+| `selected` | `Signal<string>` |          | The id of the tab shown as selected: `active`, or the controller's `current()` inside a parent that provides `BF_TAB_BAR_CONTROLLER` (`bf-tabs`). Optional, so a custom `BF_TAB_BAR` provider without it keeps working: `bf-tab` then reads `active`. |
+| `tabStop`  | `Signal<string>` | required | The id that currently owns the roving tab stop: the active enabled tab, or the first enabled tab when nothing valid is selected.                                                                                                                      |
+| `linkMode` | `boolean`        | required | True when a router-aware parent provides `BF_TAB_LINKS`: the tabs render as links in a `nav`, not as a `tablist`.                                                                                                                                     |
+
+## Methods
+
+### `linkHref(id: string): string | null`
+
+The URL of tab `id` in link mode; `null` without `BF_TAB_LINKS`.
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The `id` of the tab. |
+
+### `linkIsRoot(id: string): boolean`
+
+Whether the current page is tab `id`'s root page (`aria-current="page"`) rather than a
+child page of it (`aria-current="true"`); `true` without `BF_TAB_LINKS`.
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The `id` of the tab. |
+
+### `select(id: string): void`
+
+Selects tab `id`, as a click on it would.
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The `id` of the tab. |
+
+## Used by
+
+- [BF_TAB_BAR](bf_tab_bar.md)

package/ai/reference/bf-tab-context.md

@@ -0,0 +1,32 @@
+# BfTabContext
+
+What the tabs page tells its stack outlet: which tab a URL belongs to
+
+Interface from `@bitforgehq/ui/mobile` · since 0.2.0
+
+What `bf-tabs` tells the `bf-stack-outlet` inside it: which tab a URL belongs to. The outlet
+keeps one stack per tab key and switches stacks when a navigation lands on another key.
+
+```ts
+import { type BfTabContext } from '@bitforgehq/ui/mobile';
+```
+
+## Properties
+
+| Name     | Type                     | Default  | Description                                                                            |
+| -------- | ------------------------ | -------- | -------------------------------------------------------------------------------------- |
+| `tabKey` | `Signal<string \| null>` | required | The active tab's key (the URL segment after the tabs route), or null outside the tabs. |
+
+## Methods
+
+### `keyOf(url: string): string | null`
+
+The tab key of `url` (query and fragment ignored), or null when it is not under the tabs route.
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `url`     | `string` | The URL to read. |
+
+## Used by
+
+- [BF_TAB_CONTEXT](bf_tab_context.md)

package/ai/reference/bf-tab-links.md

@@ -0,0 +1,37 @@
+# BfTabLinks
+
+The URLs a router-aware parent gives a tab bar to render its tabs as links
+
+Interface from `@bitforgehq/ui` · since 0.3.0
+
+Provided by a router-aware parent (`bf-tabs`) to render the projected bar as a `nav` of links:
+`href(id)` is the URL of tab `id`, used for the link's `href` (open in a new tab, copy the
+link, see the URL). A plain click still goes through `bf-tab-bar`'s `select()`.
+
+```ts
+import { type BfTabLinks } from '@bitforgehq/ui';
+```
+
+## Methods
+
+### `href(id: string): string`
+
+The URL of tab `id`'s root page, the link's `href`.
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The `id` of the tab. |
+
+### `isRoot(id: string): boolean`
+
+Whether the current page is tab `id`'s root page; read in a reactive context, so back it
+with signals.
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The `id` of the tab. |
+
+## Used by
+
+- [BfTabBarController](bf-tab-bar-controller.md)
+- [BF_TAB_LINKS](bf_tab_links.md)

package/ai/reference/bf-testing-options.md

@@ -0,0 +1,27 @@
+# BfTestingOptions
+
+Options of the test providers: the size defaults and labels a spec runs with
+
+Interface from `@bitforgehq/ui/testing` · since 0.3.0
+
+Options of `provideBfTesting()`.
+
+```ts
+import { type BfTestingOptions } from '@bitforgehq/ui/testing';
+```
+
+## Properties
+
+| Name       | Type                                      | Default | Description                                                                                           |
+| ---------- | ----------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------- |
+| `defaults` | `Parameters<typeof provideBfDefaults>[0]` |         | Passed to `provideBfDefaults()`, e.g. `{ fieldSize: 'sm' }`; left out, the library defaults apply.    |
+| `labels`   | `Parameters<typeof provideBfLabels>[0]`   |         | Passed to `provideBfLabels()`, e.g. German validation messages; left out, the English defaults apply. |
+
+## Uses
+
+- [provideBfDefaults](provide-bf-defaults.md)
+- [provideBfLabels](provide-bf-labels.md)
+
+## Used by
+
+- [provideBfTesting](provide-bf-testing.md)

package/ai/reference/bf-text-scale-service.md

@@ -0,0 +1,35 @@
+# BfTextScaleService
+
+Follows iOS Dynamic Type by scaling the root font size of the app
+
+Service from `@bitforgehq/ui/mobile` · since 0.2.0
+
+Scales the root font size with iOS Dynamic Type inside the native shell. WKWebView resolves the
+system text style `font: -apple-system-body` to the user's text size (17 px at the default
+"Large", 21 px at xxL, 40 px at AX3, 53 px at AX5); a hidden, persistent probe element with that
+font gives the size, and `<html>` gets `font-size: probe / 17 × 100 %` (rounded to 0.1 %). Every
+type token and spacing step of the library is in `rem`, so text and rem-based layout grow
+together, as UIKit's Dynamic Type does.
+
+A `ResizeObserver` on the probe re-applies the scale when the setting changes while the app
+runs (WebKit re-resolves system fonts then); `visibilitychange` re-probes as the fallback. The
+scale never goes below 1 (the smaller iOS sizes, and a Mac running the iOS app, keep the design
+size) and is capped at `BfShellConfig.dynamicType.maxScale` (default 2.35; `Infinity` means no
+cap; `NaN` falls back to the default). A missing or non-finite probe value gives 1; at 1 the
+root font size is left unset.
+
+Acts only with `provideBfShell()` (which starts it at bootstrap), on native iOS, and while
+`dynamicType` is not `false`. Android needs nothing: its WebView applies the system font scale
+(`textZoom`) itself, so probing there would scale twice. On the web the browser's own text
+size and zoom apply. Destroying the service removes the probe, its listeners and the root font
+size.
+
+```ts
+import { BfTextScaleService } from '@bitforgehq/ui/mobile';
+```
+
+## Properties
+
+| Name    | Type             | Default | Description                                                                           |
+| ------- | ---------------- | ------- | ------------------------------------------------------------------------------------- |
+| `scale` | `Signal<number>` |         | Current root scale (1 = the system default "Large"); always 1 on Android and the web. |

package/ai/reference/bf-theme.md

@@ -0,0 +1,27 @@
+# BfTheme
+
+The app theme choice, following the system or forcing light or dark
+
+Type from `@bitforgehq/ui/mobile` · since 0.2.0
+
+The app theme choice: follow the system, or force light or dark.
+
+```ts
+import { type BfTheme } from '@bitforgehq/ui/mobile';
+```
+
+## Signature
+
+```ts
+type BfTheme = 'system' | 'light' | 'dark'
+```
+
+## Values
+
+- `system`
+- `light`
+- `dark`
+
+## Used by
+
+- [BfPlatformService](bf-platform-service.md)

package/ai/reference/bf-toast-action.md

@@ -0,0 +1,25 @@
+# BfToastAction
+
+The action button of a toast: its label and what it runs when clicked
+
+Interface from `@bitforgehq/ui/overlay` · since 0.2.0
+
+Also exported from `@bitforgehq/ui/mobile`.
+
+The action rendered as a real button inside a toast.
+
+```ts
+import { type BfToastAction } from '@bitforgehq/ui/overlay';
+```
+
+## Properties
+
+| Name      | Type         | Default  | Description                                          |
+| --------- | ------------ | -------- | ---------------------------------------------------- |
+| `label`   | `string`     | required | Text of the action button.                           |
+| `handler` | `() => void` |          | Runs before the toast closes with reason `'action'`. |
+
+## Used by
+
+- [BfDesktopToastOptions](bf-desktop-toast-options.md)
+- [BfToastOptions](bf-toast-options.md)

package/ai/reference/bf-toast-controller.md

@@ -0,0 +1,17 @@
+# BfToastController
+
+What the toast queue does for a toast ref: dismiss the toast now
+
+Interface from `@bitforgehq/ui/overlay` · since 0.2.0
+
+What the toast queue does for a toast ref; internal.
+
+```ts
+import { type BfToastController } from '@bitforgehq/ui/overlay';
+```
+
+## Methods
+
+### `dismiss(): void`
+
+Ends the toast now: closes it if shown, or drops it from the queue if it never showed.

package/ai/reference/bf-toast-dismiss-reason.md

@@ -0,0 +1,29 @@
+# BfToastDismissReason
+
+Why a toast ended: its time ran out, its action fired or it was dismissed
+
+Type from `@bitforgehq/ui/overlay` · since 0.2.0
+
+Also exported from `@bitforgehq/ui/mobile`.
+
+Why a toast ended.
+
+```ts
+import { type BfToastDismissReason } from '@bitforgehq/ui/overlay';
+```
+
+## Signature
+
+```ts
+type BfToastDismissReason = 'timeout' | 'action' | 'dismiss'
+```
+
+## Values
+
+- `timeout`
+- `action`
+- `dismiss`
+
+## Used by
+
+- [BfToastRef](bf-toast-ref.md)

package/ai/reference/bf-toast-options.md

@@ -0,0 +1,29 @@
+# BfToastOptions
+
+Options of a mobile toast: its message, an action, its duration and position
+
+Interface from `@bitforgehq/ui/mobile` · since 0.2.0
+
+Options of `BfToastService.show()`.
+
+```ts
+import { type BfToastOptions } from '@bitforgehq/ui/mobile';
+```
+
+## Properties
+
+| Name       | Type                                    | Default    | Description                                                                                                                                                                                                    |
+| ---------- | --------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `message`  | `string`                                | required   | Text of the pill, truncated to two lines.                                                                                                                                                                      |
+| `action`   | `BfToastAction`                         |            | An optional action button.                                                                                                                                                                                     |
+| `duration` | `number`                                | `3000`     | Milliseconds before the toast auto-dismisses, not counting time the pointer is over it or focus is inside it; `0` keeps it until dismissed or its action fires (default 3000 without an action, `0` with one). |
+| `position` | `BfToastPosition` (`'bottom' \| 'top'`) | `'bottom'` | Where the pill anchors (default `'bottom'`).                                                                                                                                                                   |
+
+## Uses
+
+- [BfToastAction](bf-toast-action.md)
+- [BfToastPosition](bf-toast-position.md)
+
+## Used by
+
+- [BfToastService](bf-toast-service.md)

package/ai/reference/bf-toast-position.md

@@ -0,0 +1,26 @@
+# BfToastPosition
+
+Where a mobile toast pill anchors in the viewport, at the bottom or top
+
+Type from `@bitforgehq/ui/mobile` · since 0.2.0
+
+Where the toast pill anchors in the viewport.
+
+```ts
+import { type BfToastPosition } from '@bitforgehq/ui/mobile';
+```
+
+## Signature
+
+```ts
+type BfToastPosition = 'bottom' | 'top'
+```
+
+## Values
+
+- `bottom`
+- `top`
+
+## Used by
+
+- [BfToastOptions](bf-toast-options.md)

package/ai/reference/bf-toast-ref.md

@@ -0,0 +1,41 @@
+# BfToastRef
+
+Handle on a shown or queued toast that dismisses it and reports why it ended
+
+Class from `@bitforgehq/ui/overlay` · since 0.2.0
+
+Also exported from `@bitforgehq/ui/mobile`.
+
+Handle to a toast, returned by `BfToastService.show()` (`/mobile`) and
+`BfDesktopToastService.show()` (`/overlay`). `dismiss()` ends it immediately — closing it right
+away if it is shown, or removing it from the queue before it ever shows. `afterDismissed`
+resolves with why it ended: `'timeout'` (its duration elapsed), `'action'` (the action button
+was clicked) or `'dismiss'` (`dismiss()` was called). The duration never runs out while the
+toast is hovered or focused, and a toast with an action has none by default, so it only ends
+with `'action'` or `'dismiss'` (`dismiss()`, `Escape` inside it, or the next `show()` replacing
+it).
+
+```ts
+import { BfToastRef } from '@bitforgehq/ui/overlay';
+```
+
+## Properties
+
+| Name             | Type                            | Default | Description                        |
+| ---------------- | ------------------------------- | ------- | ---------------------------------- |
+| `afterDismissed` | `Promise<BfToastDismissReason>` |         | Resolves with why the toast ended. |
+
+## Methods
+
+### `dismiss(): void`
+
+Ends the toast now; see the class doc.
+
+## Uses
+
+- [BfToastDismissReason](bf-toast-dismiss-reason.md)
+
+## Used by
+
+- [BfDesktopToastService](bf-desktop-toast-service.md)
+- [BfToastService](bf-toast-service.md)

package/ai/reference/bf-toast-service.md

@@ -0,0 +1,39 @@
+# BfToastService
+
+Shows brief toast pills on phones, one at a time, queued in order
+
+Service from `@bitforgehq/ui/mobile` · since 0.2.0
+
+Queues status pills: `show(options)` renders `bf-toast` on the overlay core (`passive: true` —
+no backdrop, no focus trap, the page stays interactive, and it never counts towards
+`BfOverlayStack.count()`) and returns a `BfToastRef`. One toast is visible at a time; later
+calls queue in order and show once the current one ends. A toast auto-dismisses after
+`duration` ms (default 3000, resolving `'timeout'`); a toast with an action defaults to
+`duration: 0`, which keeps it until `dismiss()`, `Escape` inside it (`'dismiss'`) or its action
+button (`'action'`) ends it; such a persistent toast never blocks the queue — the next `show()`
+replaces it (`'dismiss'`). The timer pauses while the pointer is over the toast or focus is
+inside it and resumes with the remaining time. When a toast still holding focus closes, focus
+returns to the element focused last outside it. Each toast is announced once, politely, through
+CDK `LiveAnnouncer` as it shows. A navigation (a pushed or popped page, a tab switch) never
+closes it.
+
+```ts
+import { BfToastService } from '@bitforgehq/ui/mobile';
+```
+
+## Methods
+
+### `show(options: BfToastOptions): BfToastRef`
+
+Queues `options` as a toast; shows it now if none is visible, else once the current one ends.
+A persistent toast (`duration` 0, the default with an action) never blocks the queue: a later
+`show()` dismisses it (`'dismiss'`), whether it is visible or still waiting.
+
+| Parameter | Type             | Description                                         |
+| --------- | ---------------- | --------------------------------------------------- |
+| `options` | `BfToastOptions` | The toast's message, action, duration and position. |
+
+## Uses
+
+- [BfToastOptions](bf-toast-options.md)
+- [BfToastRef](bf-toast-ref.md)

package/ai/reference/bf-toggle-label-position.md

@@ -0,0 +1,26 @@
+# BfToggleLabelPosition
+
+Whether a toggle's label sits after or before its switch
+
+Type from `@bitforgehq/ui` · since 0.3.0
+
+The side of a `bf-toggle`'s switch its label sits on: after it (`end`) or before it (`start`).
+
+```ts
+import { type BfToggleLabelPosition } from '@bitforgehq/ui';
+```
+
+## Signature
+
+```ts
+type BfToggleLabelPosition = 'end' | 'start'
+```
+
+## Values
+
+- `end`
+- `start`
+
+## Used by
+
+- [bf-toggle](../components/toggle.md)

package/ai/reference/bf-transition-kind.md

@@ -0,0 +1,28 @@
+# BfTransitionKind
+
+The direction of a stack transition, a page pushed on or popped off
+
+Type from `@bitforgehq/ui/mobile` · since 0.2.0
+
+The direction of a stack transition: a page pushed on, or popped off.
+
+```ts
+import { type BfTransitionKind } from '@bitforgehq/ui/mobile';
+```
+
+## Signature
+
+```ts
+type BfTransitionKind = 'push' | 'pop'
+```
+
+## Values
+
+- `push`
+- `pop`
+
+## Used by
+
+- [BfStackTransitionEvent](bf-stack-transition-event.md)
+- [createTransition](create-transition.md)
+- [mdTransition](md-transition.md)

package/ai/reference/bf-validation-message.md

@@ -0,0 +1,31 @@
+# bfValidationMessage
+
+Turns one validation error into the text a form field shows under it
+
+Function from `@bitforgehq/ui` · since 0.3.0
+
+The text for one error: its own `message`, else the default for its `kind` (Signal Forms kinds
+`required|email|pattern|parse|min|max|minLength|maxLength|minDate|maxDate`, and the Reactive
+interop kinds `required|email|pattern|min|max|minlength|maxlength` whose limits sit
+in `context`), else `fallback`. Reads limits through type guards, never `any`.
+
+```ts
+import { bfValidationMessage } from '@bitforgehq/ui';
+```
+
+## Signature
+
+```ts
+function bfValidationMessage(error: ValidationError, messages: BfValidationMessages): string
+```
+
+## Parameters
+
+| Parameter  | Type                   | Description                                                     |
+| ---------- | ---------------------- | --------------------------------------------------------------- |
+| `error`    | `ValidationError`      | A Signal Forms error, or a Reactive Forms error adapted to one. |
+| `messages` | `BfValidationMessages` | The default texts, usually `inject(BF_LABELS).validation`.      |
+
+## Uses
+
+- [BfValidationMessages](bf-validation-messages.md)

package/ai/reference/bf-validation-messages.md

@@ -0,0 +1,33 @@
+# BfValidationMessages
+
+The default error text of each validator kind, shown under a form field
+
+Interface from `@bitforgehq/ui` · since 0.3.0
+
+Default text per validator kind, part of `BfLabels`; override with `provideBfLabels()`.
+
+```ts
+import { type BfValidationMessages } from '@bitforgehq/ui';
+```
+
+## Properties
+
+| Name        | Type                         | Default                                                        | Description                                                                                     |
+| ----------- | ---------------------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
+| `required`  | `string`                     | `'Fill in this field'`                                         | `required` (Signal Forms and Reactive Forms; `Validators.requiredTrue` reports `required` too). |
+| `email`     | `string`                     | `'Enter a valid email address'`                                | `email`.                                                                                        |
+| `pattern`   | `string`                     | `'Use the expected format'`                                    | `pattern`.                                                                                      |
+| `parse`     | `string`                     | `'Enter a valid number'`                                       | `parse`: the text could not be read as a value (e.g. a number field).                           |
+| `min`       | `(min: number) => string`    | `` (min) => `Enter ${min} or more` ``                          | `min`, given the lower limit.                                                                   |
+| `max`       | `(max: number) => string`    | `` (max) => `Enter ${max} or less` ``                          | `max`, given the upper limit.                                                                   |
+| `minLength` | `(length: number) => string` | `` (length) => `Use at least ${length} characters` ``          | `minLength` (Signal Forms) and `minlength` (Reactive Forms), given the required length.         |
+| `maxLength` | `(length: number) => string` | `` (length) => `Use at most ${length} characters` ``           | `maxLength` (Signal Forms) and `maxlength` (Reactive Forms), given the allowed length.          |
+| `minDate`   | `(date: Date) => string`     | `` (date) => `Pick ${date.toLocaleDateString()} or later` ``   | `minDate`, given the earliest date.                                                             |
+| `maxDate`   | `(date: Date) => string`     | `` (date) => `Pick ${date.toLocaleDateString()} or earlier` `` | `maxDate`, given the latest date.                                                               |
+| `fallback`  | `string`                     | `'Check this value'`                                           | Any other kind without its own message.                                                         |
+
+## Used by
+
+- [BfLabels](bf-labels.md)
+- [BfLabelsOverrides](bf-labels-overrides.md)
+- [bfValidationMessage](bf-validation-message.md)

package/ai/reference/bf-view-event.md

@@ -0,0 +1,28 @@
+# BfViewEvent
+
+The four lifecycle events of a stacked page as it enters and leaves
+
+Type from `@bitforgehq/ui/mobile` · since 0.2.0
+
+One lifecycle event of a stacked page.
+
+```ts
+import { type BfViewEvent } from '@bitforgehq/ui/mobile';
+```
+
+## Signature
+
+```ts
+type BfViewEvent = 'willEnter' | 'didEnter' | 'willLeave' | 'didLeave'
+```
+
+## Values
+
+- `willEnter`
+- `didEnter`
+- `willLeave`
+- `didLeave`
+
+## Used by
+
+- [BfViewLifecycle](bf-view-lifecycle.md)

package/ai/reference/bf-view-lifecycle.md

@@ -0,0 +1,41 @@
+# BfViewLifecycle
+
+The lifecycle of one stacked page as signals and events, from enter to leave
+
+Class from `@bitforgehq/ui/mobile` · since 0.2.0
+
+Per-page lifecycle. `bf-stack-outlet` creates one per page and provides it through the page's
+element injector; `bf-page` re-exposes it as outputs, and any page or service can
+`inject(BfViewLifecycle)` to react to the page entering or leaving the top of the stack.
+`state` and the counters are signals for `computed`/`effect`; `on()` delivers every event
+synchronously, including the ones that happen before the page's first change detection and
+right before a popped page is destroyed.
+
+```ts
+import { BfViewLifecycle } from '@bitforgehq/ui/mobile';
+```
+
+## Properties
+
+| Name        | Type                          | Default | Description                                                                     |
+| ----------- | ----------------------------- | ------- | ------------------------------------------------------------------------------- |
+| `state`     | `WritableSignal<BfViewState>` |         | The page's current lifecycle state.                                             |
+| `willEnter` | `WritableSignal<number>`      |         | How often the page started entering; monotonic, so a page can `effect()` on it. |
+| `didEnter`  | `WritableSignal<number>`      |         | How often the page became the top page (its enter transition ended).            |
+| `willLeave` | `WritableSignal<number>`      |         | How often the page started leaving the top of the stack.                        |
+| `didLeave`  | `WritableSignal<number>`      |         | How often the page stopped being the top page (its leave transition ended).     |
+
+## Methods
+
+### `on(listener: (event: BfViewEvent) => void): () => void`
+
+Calls `listener` synchronously on every event; returns a function that removes it.
+
+| Parameter  | Type                           | Description                            |
+| ---------- | ------------------------------ | -------------------------------------- |
+| `listener` | `(event: BfViewEvent) => void` | Called with each event, synchronously. |
+
+## Uses
+
+- [BfViewEvent](bf-view-event.md)
+- [BfViewState](bf-view-state.md)

package/ai/reference/bf-view-state.md

@@ -0,0 +1,28 @@
+# BfViewState
+
+Where a stacked page is in its lifecycle: entering, active, leaving or inactive
+
+Type from `@bitforgehq/ui/mobile` · since 0.2.0
+
+Where a stacked page is in its lifecycle.
+
+```ts
+import { type BfViewState } from '@bitforgehq/ui/mobile';
+```
+
+## Signature
+
+```ts
+type BfViewState = 'entering' | 'active' | 'leaving' | 'inactive'
+```
+
+## Values
+
+- `entering`
+- `active`
+- `leaving`
+- `inactive`
+
+## Used by
+
+- [BfViewLifecycle](bf-view-lifecycle.md)