BbButton

Class to apply when the link is active.

Icon to be added on the right of the text.

Value passed to the attribute aria-current when the link is exact active.

Inertia: runs the visit without blocking — the page stays interactive and several async visits can be in flight at once.

Displays the component as full width.

Inertia: how long a prefetched response stays fresh before it is re-fetched. A single duration, or [staleAfter, expiresAfter]. Typed platform-agnostically (matching BbButton) so the library's types never require @inertiajs/vue3 to be installed.

Inertia: tags to file this visit's prefetch cache under, so a later request can invalidate the whole tagged group.

Inertia: the page component this visit resolves to. Rarely set by hand — the server normally decides it.

Request payload forwarded to Inertia when navigating via href in an Inertia-enabled app. Ignored when not using Inertia.

Disables every spinner the button starts on its own: the one that tracks an async click handler, and a type="submit" button's spin while its BbForm saves. Only an explicit loading shows the spinner then.

Use only when an async click should intentionally remain interactive without automatic pending state.

Disables the component: native disabled (or aria-disabled on a link), muted paint. Beside loading, loading wins the look (spinner and variant colours) and this only adds the native blocking — redundant but harmless.

Marks an href link as a download: renders a plain <a download> doing a native navigation (never an Inertia/router visit), so file downloads work. Pass a string for the suggested filename. A native-anchor signal alongside target and external.

Class to apply when the link is exact active.

Inertia: the inverse of only — properties to EXCLUDE from a partial reload. Pass one or the other, not both.

Forces an href link to render as a plain <a> (native navigation), bypassing Inertia/router interception — same intent as Nuxt's external. A native-anchor signal alongside target and download.

Value emitted when the toggle is deactivated.

Identifies the button as part of a button group: adjacent group buttons fuse into one segment (shared borders and radius). Adjacent group toggles (each with a v-model) are also one Tab stop, with ArrowLeft / ArrowRight / Home / End moving between them.

Additional HTTP headers forwarded to Inertia when navigating via href in an Inertia-enabled app.

Returns the hyperlink's URL. Can be set, to change the URL.

Use for a destination, not an action. The rendered link keeps browser navigation behaviour.

Used when only an icon with no text should be displayed.

Slot content becomes the visually hidden accessible name. An icon-only button without slot text or an explicit aria-label is an error for bitboss-ui check and the ESLint rule bitboss-ui/require-accessible-name.

Inertia: navigate optimistically on click and reconcile when the response lands, instead of waiting for the round trip.

Keeps the button clickable while it is loading. Buttons are disabled while loading by default; this escape hatch exists for toggles that must stay interactive (e.g. the dropdown-button caret).

Triggers a loading indicator. A loading button is soft-disabled on its own (aria-disabled, out of the tab order, clicks and navigation blocked) and keeps its variant colours; with disabled set too, loading still wins the look.

Bind this when pending state is owned outside the click handler, such as a form or store request.

HTTP method used for Inertia navigation when href is provided in an Inertia-enabled app. Ignored otherwise.

Only with href in an Inertia app. A to link is a router link and sends no method; the ESLint rule bitboss-ui/require-partner-prop flags method without href.

Makes the button a toggle: clicking flips the model between trueValue and falseValue, and the button reports aria-pressed. Leave it unbound for a plain button.

Lifecycle hook invoked by Inertia right before the request is sent.

Lifecycle hook invoked by Inertia when a request is cancelled.

Receives the Inertia cancel token source when a request is initiated. Can be used to cancel the request. Typed platform-agnostically (matching BbButton) so the library's types never require @inertiajs/vue3 to be installed.

Inertia's hook for a VALIDATION error answer (the 422 path): the only failure callback Link accepts. onHttpException (5xx) and onNetworkError are router.visit() / useForm() options, never Link props.

Lifecycle hook invoked by Inertia after the request has finished (regardless of success or error).

Limits the properties that are preserved in Inertia partial reloads.

Lifecycle hook invoked by Inertia when a prefetch for this link has completed and is cached.

Lifecycle hook invoked by Inertia when a prefetch for this link starts.

Progress callback invoked by Inertia with the upload/download percentage when available.

Lifecycle hook invoked by Inertia when a request starts.

Lifecycle hook invoked by Inertia when a request succeeds.

Inertia: props to merge into the next page optimistically, before the server responds. Either an object or a function of the current props. Typed platform-agnostically (matching BbButton) so the library's types never require @inertiajs/vue3 to be installed.

Inertia: fetch and cache this link's page ahead of the click. true uses the default trigger; a string or list of strings picks them ('mount', 'hover', 'click').

Icon to be added on the left of the text.

Controls whether Inertia should preserve the current scroll position after navigation. Can be a boolean or a predicate receiving the visit props.

Controls whether Inertia should preserve the current state after navigation. Can be a boolean or a predicate receiving the visit props.

Inertia: keep the current URL in the address bar even though the page content changes.

Passthrough, object form: { icon: '…', 'icon:loading': '…' } — the same keys as the pt:* attributes without the prefix. Parts: root, icon, spinner, text. States: loading, disabled, pressed, and the registered variants (an app's own included).

Passthrough, attribute form: one attribute per part, pt:<part>, and per part and state, pt:<part>:<state>. Parts: icon, root, spinner, text. States: activeLink, destructive, disabled, exactActiveLink, ghost, link, loading, outline, pressed, primary, secondary.

Format to use when serializing array values into the query string for Inertia requests.

Calls router.replace instead of router.push.

Sets the size of the button. A single value applies at every breakpoint; a per-breakpoint map (e.g. { default: 'sm', lg: 'md' }) switches responsively. Purely CSS-driven — no runtime breakpoint watching.

Element to render for the plain (non-link, non-router) button: 'button' (default), 'div'/'span' when nesting inside another button or link, or 'label' for a file-upload trigger. Ignored when href/to make the button render as a link.

Sets or retrieves the window or frame at which to target content.

Text content of the component.

Route Location the link should navigate to when clicked on.

Use for internal Vue Router or Nuxt navigation instead of calling the router from @click.

Value emitted when the toggle is activated.

Gets the classification and default behavior of the button.

Defaults to button. Set submit only when the surrounding form owns the action.

Visual variant of the button: colours and surface only, never spacing or size. 'none' takes no look (you own hover, focus and disabled); register a real one with the plugin's buttonVariants and style .bb-button--<name> (no CSS ships for it).

Choose by hierarchy, not colour. Register recurring project variants; use BbBaseButton for a completely custom primitive.

Inertia: run the page swap inside a View Transition, where the browser supports one.

Binding it is what makes the button a toggle, with aria-pressed and the bb-button--active class. A hand-bound aria-pressed is ignored, with a development warning.

Emitted with the new value whenever v-model changes.

The trailing icon, replacing append:icon; inside the icon part.

Primary content rendered inside the button. Falls back to the text prop when empty. A link's slot gets { activeLink, exactActiveLink }: whether it points at the current page (both false on a button).

The visible label, or the accessible name when icon makes the text visually hidden.

The icon of an icon-only button, replacing the icon prop. Renders inside the icon part: pt:icon, --icon-size and the loading spinner apply.

The leading icon, replacing prepend:icon; inside the icon part.