Skip to main content
cngx-src documentation

CngxTabHandle

Interface

projects/common/tabs/tab-group-host.token.ts

Referenced by#

Import#

import { CngxTabHandle } from '@cngx/common/tabs'

Description#

Registration handle a CngxTab atom passes to its presenter via CngxTabGroupHost.register. Fields are exposed by reference so subsequent input changes propagate without re-registration. errorAggregator is a Signal<...> slot so consumer aggregators resolved via viewChild after first registration still bind.

Index#

Instance Properties#

closable#Signal
Readonly

Per-tab closable override. undefined (default) inherits the group-level closable resolution; true/false pin this tab's close affordance regardless of the group default (e.g. a non-closable "Home" tab inside an otherwise dismissable group).

disabled#Signal
Readonly
errorAggregator#Signal
Readonly
errorMessage#Signal
Readonly

Resolved direct-error message - the [error] string when non-empty, else undefined. Rides the handle so the error badge slot can render it via ctx.tab.errorMessage(). [cngxMatTabs] pins this to undefined - Material owns its own tab chrome.

hasError#Signal
Readonly

Folded per-tab error state, exposed by reference. true when the direct [error] flag is set OR the aggregator wants to reveal (shouldShow(), so deferred-reveal validation stays silent until revealed). The organism gates the error badge + SR descriptor on this; both handle producers (CngxTab, createMatTabHandle) carry it.

Readonly
label#Signal
Readonly
subLabel#Signal
Readonly

Optional secondary label line. Rendered stacked under the primary label by the organism and folded into the tab's accessible name. undefined (default) renders byte-identically to a single-line tab. [cngxMatTabs] pins this to undefined - Material owns its own tab chrome.