carbon-components-angular
Version:
Next generation components
92 lines (88 loc) • 3.2 kB
TypeScript
/**
*
* carbon-angular v0.0.0 | tab-header.component.d.ts
*
* Copyright 2014, 2026 IBM
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AfterViewInit, ElementRef } from "@angular/core";
import { TabHeaderBase } from "./tab-header.directive";
import * as i0 from "@angular/core";
/**
* Tab header with template for label, optional icon, secondary label, badge, and dismissable close.
*
* ```html
* <cds-tab-header-group>
* <cds-tab-header [paneReference]="c1">Dashboard</cds-tab-header>
* <cds-tab-header [paneReference]="c2" [icon]="iconTpl" secondaryLabel="(1/4)">
* Monitoring
* </cds-tab-header>
* </cds-tab-header-group>
* <cds-tab #c1>...</cds-tab>
* <cds-tab #c2>...</cds-tab>
* ```
*/
export declare class TabHeaderComponent extends TabHeaderBase implements AfterViewInit {
/**
* Icon-only tab: set `icon` and `iconLabel`.
*/
iconOnly: boolean;
/**
* Icon-only tabs: accessible name (`aria-label` / `title`).
*/
iconLabel: string;
/**
* **Preview**: Icon-only tabs — show a notification dot on the icon.
*/
badgeIndicator: boolean;
/**
* Icon-only tabs: icon size `default` (16px) or `lg` (20px); usually set on the parent group.
*/
iconSize: "default" | "lg";
/**
* `aria-label` for the dismissable close button.
*/
closeButtonAriaLabel: string;
/**
* Icon-only tabs: tooltip show delay (ms).
*/
enterDelayMs: number;
/**
* Icon-only tabs: tooltip hide delay (ms).
*/
leaveDelayMs: number;
/**
* Icon-only tabs: open the tooltip on first render.
*/
isTooltipOpen: boolean;
displayContents: string;
tabButton: ElementRef<HTMLButtonElement>;
ngAfterViewInit(): void;
/**
* Focus the rendered tab button (not the host).
*/
focus(): void;
onTabButtonClick(): void;
/**
* `Delete` closes dismissable tabs when focus is on the tab.
*/
onTabButtonKeyDown(event: KeyboardEvent): void;
/**
* Close button click; stops propagation so the tab does not activate.
*/
onClose(event: Event): void;
get resolvedTitle(): string | null;
get closeButtonTitle(): string;
static ɵfac: i0.ɵɵFactoryDeclaration<TabHeaderComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<TabHeaderComponent, "cds-tab-header, ibm-tab-header", never, { "iconOnly": "iconOnly"; "iconLabel": "iconLabel"; "badgeIndicator": "badgeIndicator"; "iconSize": "iconSize"; "closeButtonAriaLabel": "closeButtonAriaLabel"; "enterDelayMs": "enterDelayMs"; "leaveDelayMs": "leaveDelayMs"; "isTooltipOpen": "isTooltipOpen"; }, {}, never, ["*"], false>;
}