carbon-components-angular
Version:
Next generation components
59 lines (55 loc) • 2.27 kB
TypeScript
/**
*
* carbon-angular v0.0.0 | sidenav.component.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 { I18n } from "carbon-components-angular/i18n";
import { NavigationItem } from "../header/header-navigation-items.interface";
import * as i0 from "@angular/core";
/**
* `Sidenav` is a fixed left navigation that may contain `SideNavItem`s or `SideNavMenu`s
*
* [See demo](../../?path=/story/components-ui-shell--side-navigation)
*/
export declare class SideNav {
i18n: I18n;
hostClass: boolean;
ariaLabel: string;
/**
* Controls the expanded (`true`) or collapsed (`false`) state when on a small screen.
*/
expanded: boolean;
/**
* Controls the hidden (`true`) or visible (`false`) state
*/
hidden: boolean;
rail: boolean;
ux: boolean;
allowExpansion: boolean;
/**
* NavigationItems from the header navigation component which are displayed on the sidenav when the window
* innerWidth is small enough. Sidenav items and menus are created using the model used to create header
* navigation items.
*/
navigationItems: NavigationItem[];
/**
* Use the routerLink attribute on <a> tag for navigation instead of using event handlers
*/
useRouter: boolean;
constructor(i18n: I18n);
toggle(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<SideNav, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<SideNav, "cds-sidenav, ibm-sidenav", never, { "ariaLabel": "ariaLabel"; "expanded": "expanded"; "hidden": "hidden"; "rail": "rail"; "allowExpansion": "allowExpansion"; "navigationItems": "navigationItems"; "useRouter": "useRouter"; }, {}, never, ["cds-sidenav-header,ibm-sidenav-header", "*"], false>;
}