carbon-components-angular
Version:
Next generation components
66 lines (62 loc) • 2.47 kB
TypeScript
/**
*
* carbon-angular v0.0.0 | header-item.component.d.ts
*
* Copyright 2014, 2024 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 { EventEmitter } from "@angular/core";
import { DomSanitizer } from "@angular/platform-browser";
import { Router } from "@angular/router";
import * as i0 from "@angular/core";
/**
* Individual item in the header. May be used a direct child of `HeaderNavigation` or `HeaderMenu`
*/
export declare class HeaderItem {
protected domSanitizer: DomSanitizer;
protected router: Router;
role: string;
set href(v: string);
get href(): string;
/**
* Use the routerLink attribute on <a> tag for navigation instead of using event handlers
*/
useRouter: boolean;
/**
* String or array of string class names to apply when active
*/
activeLinkClass: string | string[];
/**
* Applies selected styles to the item if a user sets this to true.
*/
isCurrentPage: boolean;
/**
* Array of commands to send to the router when the link is activated
* See: https://angular.io/api/router/Router#navigate
*/
route: any[];
/**
* Router options. Used in conjunction with `route`
* See: https://angular.io/api/router/Router#navigate
*/
routeExtras: any;
/**
* Emits the navigation status promise when the link is activated
*/
navigation: EventEmitter<Promise<boolean>>;
protected _href: string;
constructor(domSanitizer: DomSanitizer, router: Router);
navigate(event: any): void;
static ɵfac: i0.ɵɵFactoryDeclaration<HeaderItem, [null, { optional: true; }]>;
static ɵcmp: i0.ɵɵComponentDeclaration<HeaderItem, "cds-header-item, ibm-header-item", never, { "href": "href"; "useRouter": "useRouter"; "activeLinkClass": "activeLinkClass"; "isCurrentPage": "isCurrentPage"; "route": "route"; "routeExtras": "routeExtras"; }, { "navigation": "navigation"; }, never, ["*"], false>;
}