igniteui-angular/types/igniteui-angular-action-strip.d.ts

Ignite UI for Angular is a dependency-free Angular toolkit for building modern web apps

import * as i0 from '@angular/core';
import { AfterViewInit, AfterContentInit, ElementRef, ChangeDetectorRef, QueryList, TemplateRef } from '@angular/core';
import { IgxActionStripToken, IgxActionStripActionsToken, IActionStripResourceStrings, OverlaySettings, trackByIdentity } from 'igniteui-angular/core';
import { IgxDropDownComponent } from 'igniteui-angular/drop-down';

declare class IgxActionStripMenuItemDirective {
    templateRef: TemplateRef<any>;
    static ɵfac: i0.ɵɵFactoryDeclaration<IgxActionStripMenuItemDirective, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<IgxActionStripMenuItemDirective, "[igxActionStripMenuItem]", never, {}, {}, never, never, true, never>;
}
/**
 * Action Strip provides templatable area for one or more actions.
 *
 * @igxModule IgxActionStripModule
 *
 * @igxTheme igx-action-strip-theme
 *
 * @igxKeywords action, strip, actionStrip, pinning, editing
 *
 * @igxGroup Data Entry & Display
 *
 * @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxRowIslandComponent, *
 *
 * @remarks
 * The Ignite UI Action Strip is a container, overlaying its parent container,
 * and displaying action buttons with action applicable to the parent component the strip is instantiated or shown for.
 *
 * @example
 * ```html
 * <igx-action-strip #actionStrip>
 *     <igx-icon (click)="doSomeAction()"></igx-icon>
 * </igx-action-strip>
 */
declare class IgxActionStripComponent implements IgxActionStripToken, AfterViewInit, AfterContentInit {
    private _viewContainer;
    private renderer;
    protected el: ElementRef<any>;
    cdr: ChangeDetectorRef;
    /**
     * Sets the context of an action strip.
     * The context should be an instance of a @Component, that has element property.
     * This element will be the placeholder of the action strip.
     *
     * @example
     * ```html
     * <igx-action-strip [context]="cell"></igx-action-strip>
     * ```
     */
    context: any;
    /**
     * Menu Items ContentChildren inside the Action Strip
     *
     * @hidden
     * @internal
     */
    _menuItems: QueryList<IgxActionStripMenuItemDirective>;
    /**
     * ActionButton as ContentChildren inside the Action Strip
     *
     * @hidden
     * @internal
     */
    actionButtons: QueryList<IgxActionStripActionsToken>;
    /**
     * Gets/Sets the visibility of the Action Strip.
     * Could be used to set if the Action Strip will be initially hidden.
     *
     * @example
     * ```html
     *  <igx-action-strip [hidden]="false">
     * ```
     */
    hidden: boolean;
    /**
     * Gets/Sets the resource strings.
     *
     * @remarks
     * By default it uses EN resources.
     */
    set resourceStrings(value: IActionStripResourceStrings);
    get resourceStrings(): IActionStripResourceStrings;
    /**
     * Hide or not the Action Strip based on if it is a menu.
     *
     * @hidden
     * @internal
     */
    get hideOnRowLeave(): boolean;
    /**
     * Reference to the menu
     *
     * @hidden
     * @internal
     */
    menu: IgxDropDownComponent;
    /**
     * Getter for menu overlay settings
     *
     * @hidden
     * @internal
     */
    menuOverlaySettings: OverlaySettings;
    private _resourceStrings;
    private _originalParent;
    /**
     * Menu Items list.
     *
     * @hidden
     * @internal
     */
    get menuItems(): any[];
    /**
     * Getter for the 'display' property of the current `IgxActionStrip`
     */
    private get display();
    /**
     * Host `attr.class` binding.
     */
    protected hostClass: string;
    /**
     * @hidden
     * @internal
     */
    ngAfterContentInit(): void;
    /**
     * @hidden
     * @internal
     */
    ngAfterViewInit(): void;
    /**
     * Showing the Action Strip and appending it the specified context element.
     *
     * @param context
     * @example
     * ```typescript
     * this.actionStrip.show(row);
     * ```
     */
    show(context?: any): void;
    /**
     * Hiding the Action Strip and removing it from its current context element.
     *
     * @example
     * ```typescript
     * this.actionStrip.hide();
     * ```
     */
    hide(): void;
    /** pin swapping w/ unpin resets the menuItems collection */
    protected trackMenuItem: typeof trackByIdentity;
    /**
     * Close the menu if opened
     *
     * @hidden
     * @internal
     */
    private closeMenu;
    static ɵfac: i0.ɵɵFactoryDeclaration<IgxActionStripComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<IgxActionStripComponent, "igx-action-strip", never, { "context": { "alias": "context"; "required": false; }; "hidden": { "alias": "hidden"; "required": false; }; "resourceStrings": { "alias": "resourceStrings"; "required": false; }; }, {}, ["_menuItems", "actionButtons"], ["*"], true, never>;
    static ngAcceptInputType_hidden: unknown;
}

declare const IGX_ACTION_STRIP_DIRECTIVES: readonly [typeof IgxActionStripComponent, typeof IgxActionStripMenuItemDirective];

/**
 * @hidden
 * IMPORTANT: The following is NgModule exported for backwards-compatibility before standalone components
 */
declare class IgxActionStripModule {
    static ɵfac: i0.ɵɵFactoryDeclaration<IgxActionStripModule, never>;
    static ɵmod: i0.ɵɵNgModuleDeclaration<IgxActionStripModule, never, [typeof IgxActionStripComponent, typeof IgxActionStripMenuItemDirective], [typeof IgxActionStripComponent, typeof IgxActionStripMenuItemDirective]>;
    static ɵinj: i0.ɵɵInjectorDeclaration<IgxActionStripModule>;
}

export { IGX_ACTION_STRIP_DIRECTIVES, IgxActionStripComponent, IgxActionStripMenuItemDirective, IgxActionStripModule };