carbon-components-angular
Version:
Next generation components
75 lines (71 loc) • 2.83 kB
TypeScript
/**
*
* carbon-angular v0.0.0 | overflow-menu.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 { ElementRef, EventEmitter, TemplateRef } from "@angular/core";
import { I18n } from "carbon-components-angular/i18n";
import { OverflowMenuDirective } from "./overflow-menu.directive";
import { BaseIconButton } from "carbon-components-angular/button";
import * as i0 from "@angular/core";
/**
* The OverFlow menu component encapsulates the OverFlowMenu directive, and the menu iconography into one convienent component.
*
* Get started with importing the module:
*
* ```typescript
* import { DialogModule } from 'carbon-components-angular';
* ```
*
* ```html
* <cds-overflow-menu>
* <cds-overflow-menu-option>Option 1</cds-overflow-menu-option>
* <cds-overflow-menu-option>Option 2</cds-overflow-menu-option>
* </cds-overflow-menu>
* ```
*
* [See demo](../../?path=/story/components-overflow-menu--basic)
*/
export declare class OverflowMenu extends BaseIconButton {
protected elementRef: ElementRef;
protected i18n: I18n;
buttonLabel: any;
description: any;
flip: boolean;
placement: "bottom" | "top" | "bottom,top" | "top,bottom";
open: boolean;
openChange: EventEmitter<boolean>;
/**
* Sets the custom overflow menu trigger
*/
customTrigger: TemplateRef<any>;
/**
* This specifies any vertical and horizontal offset for the position of the dialog
*/
offset: {
x: number;
y: number;
};
wrapperClass: string;
/**
* This appends additional classes to the overflow trigger/button.
*/
triggerClass: string;
overflowMenuDirective: OverflowMenuDirective;
constructor(elementRef: ElementRef, i18n: I18n);
handleOpenChange(event: boolean): void;
static ɵfac: i0.ɵɵFactoryDeclaration<OverflowMenu, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<OverflowMenu, "cds-overflow-menu, ibm-overflow-menu", never, { "buttonLabel": "buttonLabel"; "description": "description"; "flip": "flip"; "placement": "placement"; "open": "open"; "customTrigger": "customTrigger"; "offset": "offset"; "wrapperClass": "wrapperClass"; "triggerClass": "triggerClass"; }, { "openChange": "openChange"; }, ["overflowMenuDirective"], ["*"], false>;
}