@bitforgehq/ui 0.3.0

package/ai/reference/bf-desktop-toast-config.md

@@ -0,0 +1,28 @@
+# BfDesktopToastConfig
+
+App-wide settings of desktop toasts: where they sit and how many show at once
+
+Interface from `@bitforgehq/ui/overlay` · since 0.3.0
+
+App-wide settings of `BfDesktopToastService`; set them with `provideBfDesktopToast()`.
+
+```ts
+import { type BfDesktopToastConfig } from '@bitforgehq/ui/overlay';
+```
+
+## Properties
+
+| Name         | Type                                                                                      | Default        | Description                                                                                  |
+| ------------ | ----------------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------- |
+| `position`   | `BfDesktopToastPosition` (`'bottom-end' \| 'bottom-center' \| 'top-end' \| 'top-center'`) | `'bottom-end'` | Where the stack sits (default `'bottom-end'`: bottom right, bottom left in RTL).             |
+| `maxVisible` | `number`                                                                                  | `3`            | How many toasts are visible at once (default 3); later ones wait.                            |
+| `ariaLabel`  | `string`                                                                                  | `''`           | Name of the stack's region landmark; empty uses the `notifications` label ("Notifications"). |
+
+## Uses
+
+- [BfDesktopToastPosition](bf-desktop-toast-position.md)
+
+## Used by
+
+- [BF_DESKTOP_TOAST_DEFAULTS](bf_desktop_toast_defaults.md)
+- [provideBfDesktopToast](provide-bf-desktop-toast.md)

package/ai/reference/bf-desktop-toast-harness.md

@@ -0,0 +1,33 @@
+# BfDesktopToastHarness
+
+Test harness for a desktop toast: its message, its action and Escape
+
+Class from `@bitforgehq/ui/testing` · since 0.3.0
+
+Harness for `bf-desktop-toast`, the card `BfDesktopToastService.show()` renders. Toasts render
+in the CDK overlay container, so get it through
+`TestbedHarnessEnvironment.documentRootLoader(fixture)`.
+
+```ts
+import { BfDesktopToastHarness } from '@bitforgehq/ui/testing';
+```
+
+## Signature
+
+```ts
+class BfDesktopToastHarness extends ComponentHarness
+```
+
+## Methods
+
+### `getMessage(): Promise<string>`
+
+The toast's message.
+
+### `clickAction(): Promise<void>`
+
+Clicks the action button, which dismisses the toast with `'action'`. Throws without one.
+
+### `pressEscape(): Promise<void>`
+
+Presses `Escape` inside the toast, which dismisses it with `'dismiss'`.

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

@@ -0,0 +1,28 @@
+# BfDesktopToastOptions
+
+Options of one desktop toast: its message, an action and its duration
+
+Interface from `@bitforgehq/ui/overlay` · since 0.3.0
+
+Options of `BfDesktopToastService.show()`.
+
+```ts
+import { type BfDesktopToastOptions } from '@bitforgehq/ui/overlay';
+```
+
+## Properties
+
+| Name       | Type            | Default  | Description                                                                                                                                                                                                           |
+| ---------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `message`  | `string`        | required | Text of the toast.                                                                                                                                                                                                    |
+| `action`   | `BfToastAction` |          | An optional action button (the toast then persists by default).                                                                                                                                                       |
+| `duration` | `number`        | `3000`   | Milliseconds before the toast auto-dismisses, not counting time the pointer is over the stack or focus is inside it; `0` keeps it until dismissed or its action fires (default 3000 without an action, `0` with one). |
+| `injector` | `Injector`      |          | Source of the region's labels when this toast opens the stack (default the root injector): pass the feature's `inject(Injector)` so its `provideBfLabels()` names the region.                                         |
+
+## Uses
+
+- [BfToastAction](bf-toast-action.md)
+
+## Used by
+
+- [BfDesktopToastService](bf-desktop-toast-service.md)

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

@@ -0,0 +1,28 @@
+# BfDesktopToastPosition
+
+The viewport corners and edges a desktop toast stack can anchor to
+
+Type from `@bitforgehq/ui/overlay` · since 0.3.0
+
+The viewport corner or edge the desktop toast stack anchors to.
+
+```ts
+import { type BfDesktopToastPosition } from '@bitforgehq/ui/overlay';
+```
+
+## Signature
+
+```ts
+type BfDesktopToastPosition = 'bottom-end' | 'bottom-center' | 'top-end' | 'top-center'
+```
+
+## Values
+
+- `bottom-end`
+- `bottom-center`
+- `top-end`
+- `top-center`
+
+## Used by
+
+- [BfDesktopToastConfig](bf-desktop-toast-config.md)

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

@@ -0,0 +1,42 @@
+# BfDesktopToastService
+
+Shows brief desktop notifications in a stack at a corner of the viewport
+
+Service from `@bitforgehq/ui/overlay` · since 0.3.0
+
+Shows desktop notifications: `show(options)` adds a `bf-desktop-toast` card to one passive
+overlay stack (bottom right by default, 24 px in, a `region` landmark named "Notifications")
+and returns a `BfToastRef`. Up to three are visible at once, the newest nearest the anchored
+edge; later calls wait and show as earlier ones end. A toast auto-dismisses after `duration` ms
+(default 3000, `'timeout'`); one with an action persists by default until its action
+(`'action'`), `Escape` inside it or `dismiss()` (`'dismiss'`), and the next `show()` replaces it
+(`'dismiss'`), visible or waiting. The pointer over the stack or focus inside it pauses every
+visible toast, which resume with their remaining time. Each toast is announced once, politely,
+through CDK `LiveAnnouncer`; focus never moves on show, and returns to the element focused
+last outside a toast that closes while holding it. `F6` from the page moves focus to the
+action of the newest toast that has one, and `F6` inside the stack moves it back (otherwise
+the key is left to the browser); it does nothing while a modal overlay is open
+(`BfOverlayStack.count() > 0`), since that overlay's focus trap must not be escaped. No
+backdrop, no scroll lock, nothing inert, and a navigation never closes it (a "Saved" survives
+the navigation after the save). Needs `@angular/cdk`, no Capacitor.
+
+```ts
+import { BfDesktopToastService } from '@bitforgehq/ui/overlay';
+```
+
+## Methods
+
+### `show(options: BfDesktopToastOptions): BfToastRef`
+
+Queues `options` as a toast; shows it now while fewer than `maxVisible` are visible, else once
+one ends. Every persistent toast (`duration` 0, the default with an action), visible or
+waiting, is dismissed first (`'dismiss'`).
+
+| Parameter | Type                    | Description                                         |
+| --------- | ----------------------- | --------------------------------------------------- |
+| `options` | `BfDesktopToastOptions` | The toast's message, action, duration and injector. |
+
+## Uses
+
+- [BfDesktopToastOptions](bf-desktop-toast-options.md)
+- [BfToastRef](bf-toast-ref.md)

package/ai/reference/bf-dialog-config.md

@@ -0,0 +1,44 @@
+# BfDialogConfig
+
+Options of a dialog: its data, width, role, dismissal, focus and injector
+
+Interface from `@bitforgehq/ui/overlay` · since 0.3.0
+
+Options of `BfDialogService.open()`.
+
+```ts
+import { type BfDialogConfig } from '@bitforgehq/ui/overlay';
+```
+
+## Signature
+
+```ts
+interface BfDialogConfig<D = unknown>
+```
+
+## Properties
+
+| Name                | Type                                                            | Default            | Description                                                                                                                                                                            |
+| ------------------- | --------------------------------------------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `data`              | `D`                                                             |                    | Injected into the content as `BF_DIALOG_DATA` (and a template's `data`).                                                                                                               |
+| `size`              | `BfDialogSize` (`'sm' \| 'md' \| 'lg' \| 'xl' \| 'fullscreen'`) | `'md'`             | Width of the `bf-dialog` in the content (default `md`, 32 rem).                                                                                                                        |
+| `role`              | `BfDialogRole` (`'dialog' \| 'alertdialog'`)                    | `'dialog'`         | `alertdialog` for a dialog that demands an answer (default `dialog`).                                                                                                                  |
+| `ariaLabel`         | `string`                                                        |                    | Accessible name, when the content renders no `bf-dialog` title and no heading.                                                                                                         |
+| `ariaDescribedBy`   | `string`                                                        |                    | Id of the element describing the dialog (e.g. its message).                                                                                                                            |
+| `dismissOnBackdrop` | `boolean`                                                       |                    | A backdrop click closes the dialog (default true for `dialog`, false for `alertdialog`).                                                                                               |
+| `dismissOnEscape`   | `boolean`                                                       | `true`             | `Escape` closes the dialog (default true); when false the key is claimed and ignored.                                                                                                  |
+| `autoFocus`         | `BfOverlayAutoFocus` (`'first-tabbable' \| 'panel'`)            | `'first-tabbable'` | Initial focus (default `first-tabbable`: an `[autofocus]`/`[cdkFocusInitial]` element, else the first tabbable element); `panel` focuses the dialog itself, for long text.             |
+| `restoreFocus`      | `boolean`                                                       | `true`             | Returns focus to the element that had it before opening (default true).                                                                                                                |
+| `closeOnNavigation` | `boolean`                                                       | `true`             | A navigation to another URL path closes the dialog with no result (default true).                                                                                                      |
+| `panelClass`        | `string[]`                                                      |                    | Extra classes on the overlay panel (it always carries `bf-overlay-panel bf-dialog-panel`).                                                                                             |
+| `injector`          | `Injector`                                                      |                    | Parent of the content's injector and source of its labels (default the root injector). Pass the opener's `inject(Injector)` so a feature-level `provideBfLabels()` reaches the dialog. |
+
+## Uses
+
+- [BfDialogRole](bf-dialog-role.md)
+- [BfDialogSize](bf-dialog-size.md)
+- [BfOverlayAutoFocus](bf-overlay-auto-focus.md)
+
+## Used by
+
+- [BfDialogService](bf-dialog-service.md)

package/ai/reference/bf-dialog-harness.md

@@ -0,0 +1,52 @@
+# BfDialogHarness
+
+Test harness for a dialog: its title, text and role, its buttons and Escape
+
+Class from `@bitforgehq/ui/testing` · since 0.3.0
+
+Harness for `bf-dialog`, the card `BfDialogService` opens (a `confirm()` alert dialog is built
+from it too). Dialogs render in the CDK overlay container outside the tested component, so get
+it through `TestbedHarnessEnvironment.documentRootLoader(fixture)`.
+
+```ts
+import { BfDialogHarness } from '@bitforgehq/ui/testing';
+```
+
+## Signature
+
+```ts
+class BfDialogHarness extends ComponentHarness
+```
+
+## Methods
+
+### `getTitle(): Promise<string>`
+
+The title heading.
+
+### `getText(): Promise<string>`
+
+The text of the dialog's body (its content, without the title and footer).
+
+### `getRole(): Promise<string | null>`
+
+The role of the overlay panel this dialog sits in: `dialog`, or `alertdialog` for
+`confirm()` and `role: 'alertdialog'`. The panel is found by the dialog's own
+`data-bf-dialog-id`, so a dialog under another one (a confirm opened from a dialog) reads its
+own panel.
+
+### `clickButton(label: string): Promise<void>`
+
+Clicks the button with this text (a footer or content button). Throws for an unknown label.
+
+| Parameter | Type     | Description        |
+| --------- | -------- | ------------------ |
+| `label`   | `string` | The button's text. |
+
+### `close(): Promise<void>`
+
+Clicks the close button (×), which closes the dialog with no result. Throws without one.
+
+### `pressEscape(): Promise<void>`
+
+Presses `Escape` inside the dialog: it closes, or a `confirm()` resolves its cancel answer.

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

@@ -0,0 +1,44 @@
+# BfDialogRef
+
+Handle on an open dialog that closes it and resolves with its result
+
+Class from `@bitforgehq/ui/overlay` · since 0.3.0
+
+Handle to an open dialog, returned by `BfDialogService.open()` and injectable in the dialog's
+content (`inject(BfDialogRef)`). `close(result)` plays the exit animation, detaches the dialog
+and resolves `afterClosed` with `result`; later calls are ignored. Closing with `Escape`, the
+backdrop or the `bf-dialog` close button resolves `undefined`.
+
+```ts
+import { BfDialogRef } from '@bitforgehq/ui/overlay';
+```
+
+## Signature
+
+```ts
+class BfDialogRef<R = unknown, C = unknown>
+```
+
+## Properties
+
+| Name                | Type                      | Default | Description                                                                               |
+| ------------------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------- |
+| `id`                | `string`                  |         | Unique id of the dialog (its overlay's `bf-overlay-N`).                                   |
+| `afterClosed`       | `Promise<R \| undefined>` |         | Resolves with the result given to `close()`, or `undefined`, once the dialog is detached. |
+| `closed`            | `Signal<boolean>`         |         | True once the dialog has been detached.                                                   |
+| `componentInstance` | `C \| null`               |         | The content component; `null` for a dialog opened from a template.                        |
+
+## Methods
+
+### `close(result?: R): void`
+
+Closes the dialog with an optional result; ignored once closing.
+
+| Parameter | Type | Description                            |
+| --------- | ---- | -------------------------------------- |
+| `result?` | `R`  | The value `afterClosed` resolves with. |
+
+## Used by
+
+- [BfDialogService](bf-dialog-service.md)
+- [BfDialogTemplateContext](bf-dialog-template-context.md)

package/ai/reference/bf-dialog-role.md

@@ -0,0 +1,26 @@
+# BfDialogRole
+
+The role a dialog carries, plain or an alert dialog that demands an answer
+
+Type from `@bitforgehq/ui/overlay` · since 0.3.0
+
+The ARIA role of a dialog: `dialog`, or `alertdialog` for one that demands an answer.
+
+```ts
+import { type BfDialogRole } from '@bitforgehq/ui/overlay';
+```
+
+## Signature
+
+```ts
+type BfDialogRole = 'dialog' | 'alertdialog'
+```
+
+## Values
+
+- `dialog`
+- `alertdialog`
+
+## Used by
+
+- [BfDialogConfig](bf-dialog-config.md)

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

@@ -0,0 +1,55 @@
+# BfDialogService
+
+Opens modal dialogs and confirm prompts, centred over the page with focus trapped
+
+Service from `@bitforgehq/ui/overlay` · since 0.3.0
+
+Opens modal dialogs on the overlay core, centred over a backdrop: a component or a template in
+a pane labelled by its `bf-dialog` title, with focus moved in and trapped, `Escape` and a
+backdrop click closing it (never the backdrop for an `alertdialog`), focus returned to the
+opener, document scroll locked and the page behind it `inert`. `confirm()` opens an alert
+dialog with a title, a message and a row of buttons and resolves with the pressed button's
+`id ?? label`.
+
+```ts
+import { BfDialogService } from '@bitforgehq/ui/overlay';
+```
+
+## Methods
+
+### `open<C, D = unknown, R = unknown>(component: Type<C>, config?: BfDialogConfig<D>): BfDialogRef<R, C>`
+
+Opens `component` as a dialog; it injects `BfDialogRef` and `BF_DIALOG_DATA`.
+
+| Parameter   | Type                | Description                                                             |
+| ----------- | ------------------- | ----------------------------------------------------------------------- |
+| `component` | `Type<C>`           | The component to render; it injects `BfDialogRef` and `BF_DIALOG_DATA`. |
+| `config?`   | `BfDialogConfig<D>` | The dialog's data, width, role, dismissal, focus and injector.          |
+
+### `open<D = unknown, R = unknown>(template: TemplateRef<BfDialogTemplateContext<D, R>>, config?: BfDialogConfig<D>): BfDialogRef<R>`
+
+Opens `template` as a dialog; its context is `{ $implicit: ref, data }`.
+
+| Parameter  | Type                                         | Description                                                          |
+| ---------- | -------------------------------------------- | -------------------------------------------------------------------- |
+| `template` | `TemplateRef<BfDialogTemplateContext<D, R>>` | The template to render, with the context `{ $implicit: ref, data }`. |
+| `config?`  | `BfDialogConfig<D>`                          | The dialog's data, width, role, dismissal, focus and injector.       |
+
+### `confirm(options: BfConfirmOptions): Promise<string | undefined>`
+
+Opens an alert dialog (`role="alertdialog"`, described by `message`, no backdrop dismiss)
+and resolves with the pressed button's `id ?? label`. Focus starts on the `cancel`-role
+button, else the first button; `Escape` resolves the cancel button's answer, or is ignored
+when there is none. A navigation to another path resolves the cancel button's answer, else
+`undefined`.
+
+| Parameter | Type               | Description                                                |
+| --------- | ------------------ | ---------------------------------------------------------- |
+| `options` | `BfConfirmOptions` | The title, message, buttons and width of the alert dialog. |
+
+## Uses
+
+- [BfConfirmOptions](bf-confirm-options.md)
+- [BfDialogConfig](bf-dialog-config.md)
+- [BfDialogRef](bf-dialog-ref.md)
+- [BfDialogTemplateContext](bf-dialog-template-context.md)

package/ai/reference/bf-dialog-size.md

@@ -0,0 +1,31 @@
+# BfDialogSize
+
+The dialog width scale from a 24 rem confirm to an edge-to-edge fullscreen dialog
+
+Type from `@bitforgehq/ui/overlay` · since 0.3.0
+
+The dialog's own width scale (not `BfSize`, which is a control-height scale): `sm` 24 rem,
+`md` 32 rem, `lg` 48 rem, `xl` 64 rem — each never wider than the viewport minus a gutter on
+both sides — and `fullscreen`, edge to edge.
+
+```ts
+import { type BfDialogSize } from '@bitforgehq/ui/overlay';
+```
+
+## Signature
+
+```ts
+type BfDialogSize = 'sm' | 'md' | 'lg' | 'xl' | 'fullscreen'
+```
+
+## Values
+
+- `sm`
+- `md`
+- `lg`
+- `xl`
+- `fullscreen`
+
+## Used by
+
+- [BfDialogConfig](bf-dialog-config.md)

package/ai/reference/bf-dialog-template-context.md

@@ -0,0 +1,32 @@
+# BfDialogTemplateContext
+
+The context a template opened as a dialog receives: its ref and its data
+
+Interface from `@bitforgehq/ui/overlay` · since 0.3.0
+
+Context of a template opened with `BfDialogService.open()`: `let-ref` and `let-data="data"`.
+
+```ts
+import { type BfDialogTemplateContext } from '@bitforgehq/ui/overlay';
+```
+
+## Signature
+
+```ts
+interface BfDialogTemplateContext<D = unknown, R = unknown>
+```
+
+## Properties
+
+| Name        | Type             | Default  | Description                                                |
+| ----------- | ---------------- | -------- | ---------------------------------------------------------- |
+| `$implicit` | `BfDialogRef<R>` | required | The dialog's ref (`let-ref`), to close it with a result.   |
+| `data`      | `D`              | required | The `data` the dialog was opened with (`let-data="data"`). |
+
+## Uses
+
+- [BfDialogRef](bf-dialog-ref.md)
+
+## Used by
+
+- [BfDialogService](bf-dialog-service.md)

package/ai/reference/bf-empty-state-heading-level.md

@@ -0,0 +1,26 @@
+# BfEmptyStateHeadingLevel
+
+The heading level of an empty state title, two for a screen or three
+
+Type from `@bitforgehq/ui` · since 0.3.0
+
+The heading level of a `bf-empty-state` title: `2` for a screen, `3` inside a section.
+
+```ts
+import { type BfEmptyStateHeadingLevel } from '@bitforgehq/ui';
+```
+
+## Signature
+
+```ts
+type BfEmptyStateHeadingLevel = 2 | 3
+```
+
+## Values
+
+- `2`
+- `3`
+
+## Used by
+
+- [bf-empty-state](../components/empty-state.md)

package/ai/reference/bf-enter-key-hint.md

@@ -0,0 +1,31 @@
+# BfEnterKeyHint
+
+The labels a phone keyboard can put on its Enter key
+
+Type from `@bitforgehq/ui` · since 0.2.0
+
+Native `enterkeyhint`: the label of the virtual keyboard's Enter key.
+
+```ts
+import { type BfEnterKeyHint } from '@bitforgehq/ui';
+```
+
+## Signature
+
+```ts
+type BfEnterKeyHint = 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'
+```
+
+## Values
+
+- `enter`
+- `done`
+- `go`
+- `next`
+- `previous`
+- `search`
+- `send`
+
+## Used by
+
+- [BfInputEnterKeyHint](bf-input-enter-key-hint.md)

package/ai/reference/bf-field-control-class.md

@@ -0,0 +1,32 @@
+# bfFieldControlClass
+
+The class list that makes a custom control look like a library text field
+
+Function from `@bitforgehq/ui` · since 0.3.0
+
+The class list `bf-input` puts on its native `<input>`, for a custom control inside `bf-field`
+(a native input with a mask, a combobox, a date picker's text box) that must look like the
+library's own fields: the same box, height and type per `size`, padding, focus ring and border,
+with the danger border while `invalid`. The disabled and read-only styles come from the
+control's native `disabled` / `readonly` attributes (`:disabled`, `:read-only`), so set those on
+the control as well; the class list is the one `bf-input` renders in the same state.
+
+```ts
+import { bfFieldControlClass } from '@bitforgehq/ui';
+```
+
+## Signature
+
+```ts
+function bfFieldControlClass(state: BfFieldControlState): string
+```
+
+## Parameters
+
+| Parameter | Type                  | Description                                  |
+| --------- | --------------------- | -------------------------------------------- |
+| `state`   | `BfFieldControlState` | The size and state to style the control for. |
+
+## Uses
+
+- [BfFieldControlState](bf-field-control-state.md)

package/ai/reference/bf-field-control-state.md

@@ -0,0 +1,28 @@
+# BfFieldControlState
+
+The size and state a custom field control is styled for by bfFieldControlClass
+
+Interface from `@bitforgehq/ui` · since 0.3.0
+
+The field state `bfFieldControlClass` styles a control for.
+
+```ts
+import { type BfFieldControlState } from '@bitforgehq/ui';
+```
+
+## Properties
+
+| Name       | Type                              | Default  | Description                                                                |
+| ---------- | --------------------------------- | -------- | -------------------------------------------------------------------------- |
+| `size`     | `BfSize` (`'sm' \| 'md' \| 'lg'`) | required | Height step: sm 32, md 40, lg 48 px, as `bf-input`'s `size`.               |
+| `invalid`  | `boolean`                         | required | Whether the control shows its error state (the danger border).             |
+| `disabled` | `boolean`                         | required | Whether the control is disabled; set the control's native `disabled` too.  |
+| `readonly` | `boolean`                         | required | Whether the control is read-only; set the control's native `readonly` too. |
+
+## Uses
+
+- [BfSize](bf-size.md)
+
+## Used by
+
+- [bfFieldControlClass](bf-field-control-class.md)

package/ai/reference/bf-field-size.md

@@ -0,0 +1,29 @@
+# BfFieldSize
+
+Former name of the shared size scale for text fields, kept until 1.0.0
+
+Type from `@bitforgehq/ui` · since 0.1.0
+
+**Deprecated** 0.3.0 use BfSize; removed in 1.0.0
+
+The height step of a text field; the same scale as every sized widget.
+
+```ts
+import { type BfFieldSize } from '@bitforgehq/ui';
+```
+
+## Signature
+
+```ts
+type BfFieldSize = BfSize
+```
+
+## Values
+
+- `sm`
+- `md`
+- `lg`
+
+## Uses
+
+- [BfSize](bf-size.md)

package/ai/reference/bf-haptics-impact-style.md

@@ -0,0 +1,27 @@
+# BfHapticsImpactStyle
+
+The weight of an impact haptic, light, medium or heavy
+
+Type from `@bitforgehq/ui/mobile` · since 0.2.0
+
+Impact weight, mapped to `ImpactStyle.Light` / `Medium` / `Heavy` on native.
+
+```ts
+import { type BfHapticsImpactStyle } from '@bitforgehq/ui/mobile';
+```
+
+## Signature
+
+```ts
+type BfHapticsImpactStyle = 'light' | 'medium' | 'heavy'
+```
+
+## Values
+
+- `light`
+- `medium`
+- `heavy`
+
+## Used by
+
+- [BfHapticsService](bf-haptics-service.md)

package/ai/reference/bf-haptics-notification-type.md

@@ -0,0 +1,27 @@
+# BfHapticsNotificationType
+
+The outcome a notification haptic reports: success, warning or error
+
+Type from `@bitforgehq/ui/mobile` · since 0.2.0
+
+Outcome of a task, mapped to `NotificationType.Success` / `Warning` / `Error` on native.
+
+```ts
+import { type BfHapticsNotificationType } from '@bitforgehq/ui/mobile';
+```
+
+## Signature
+
+```ts
+type BfHapticsNotificationType = 'success' | 'warning' | 'error'
+```
+
+## Values
+
+- `success`
+- `warning`
+- `error`
+
+## Used by
+
+- [BfHapticsService](bf-haptics-service.md)