carbon-components-angular/breadcrumb/breadcrumb-item.interface.d.ts

Next generation components

/**
 *
 * carbon-angular v0.0.0 | breadcrumb-item.interface.d.ts
 *
 * Copyright 2014, 2025 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 { TemplateRef } from "@angular/core";
/**
 * A structure that represents a breadcrumb item.
 */
export interface BreadcrumbItem {
    /**
     * Content to be displayed in the breadcrumb item.
     */
    content: string;
    /**
     * Href for the breadcrumb item.
     */
    href?: string;
    /**
     * 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;
    /**
     * Optional `TemplateRef` for the breadcrumb item. Receives the content as an `$implicit` template variable
     */
    template?: TemplateRef<any>;
    /**
     * aria-current for the breadcrumb item.
     */
    ariaCurrent?: string;
    /**
     * Sets the current class for the breadcrumb item.
     */
    current?: boolean;
}