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.

Disables the automatic loading state that tracks async click handlers (enabled by default).

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.

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. Do not ship an icon-only button without slot text or an explicit aria-label.

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.

Lifecycle hook invoked by Inertia when the server responds with VALIDATION errors — the ordinary 422 path. This is the only failure callback Inertia's Link accepts. onHttpException (server answered 5xx) and onNetworkError (the request never arrived) are router.visit() / useForm() options, NOT Link props — declaring them here would only paste bogus listeners onto the anchor. Use a form or an explicit visit when you need to tell them apart.

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.

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.

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.

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. Controls colors and surface style while keeping spacing and sizing unchanged.

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.

Primary content rendered inside the button. Falls back to the text prop when empty.

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