carbon-components-angular
Version:
Next generation components
89 lines (85 loc) • 3.07 kB
TypeScript
/**
*
* carbon-angular v0.0.0 | overflow-menu.directive.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 { ElementRef, ViewContainerRef, TemplateRef } from "@angular/core";
import { DialogDirective } from "../dialog.directive";
import { DialogService } from "../dialog.service";
import { EventService } from "carbon-components-angular/utils";
import * as i0 from "@angular/core";
/**
* Directive for extending `Dialog` to create overflow menus.
*
* class: OverflowMenuDirective (extends DialogDirective)
*
*
* selector: `cdsOverflowMenu`
*
*
* ```html
* <div [cdsOverflowMenu]="templateRef"></div>
* <ng-template #templateRef>
* <!-- overflow menu options here -->
* </ng-template>
* ```
*
* ```html
* <div [cdsOverflowMenu]="templateRef" [customPane]="true"></div>
* <ng-template #templateRef>
* <!-- custom content goes here -->
* </ng-template>
* ```
*/
export declare class OverflowMenuDirective extends DialogDirective {
protected elementRef: ElementRef;
protected viewContainerRef: ViewContainerRef;
protected dialogService: DialogService;
protected eventService: EventService;
/**
* @deprecated as of v5
* Takes a template ref of `OverflowMenuOptions`s
*/
set ibmOverflowMenu(template: TemplateRef<any>);
cdsOverflowMenu: TemplateRef<any>;
/**
* Controls wether the overflow menu is flipped
*/
flip: boolean;
/**
* This specifies any vertical and horizontal offset for the position of the dialog
*/
offset: {
x: number;
y: number;
};
/**
* Classes to add to the dialog container
*/
wrapperClass: string;
/**
* Set to true to for custom content
*/
customPane: boolean;
/**
* Creates an instance of `OverflowMenuDirective`.
*/
constructor(elementRef: ElementRef, viewContainerRef: ViewContainerRef, dialogService: DialogService, eventService: EventService);
updateConfig(): void;
hostkeys(event: KeyboardEvent): void;
open(): import("@angular/core").ComponentRef<import("carbon-components-angular/dialog").Dialog>;
static ɵfac: i0.ɵɵFactoryDeclaration<OverflowMenuDirective, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<OverflowMenuDirective, "[cdsOverflowMenu], [ibmOverflowMenu]", ["overflowMenu"], { "ibmOverflowMenu": "ibmOverflowMenu"; "cdsOverflowMenu": "cdsOverflowMenu"; "flip": "flip"; "offset": "offset"; "wrapperClass": "wrapperClass"; "customPane": "customPane"; }, {}, never, never, false>;
}