import { KbqActionsPanelModule } from '@koobiq/components/actions-panel';Service for opening actions panel.
Reference to actions panel opened by `KbqActionsPanel` service.
| Name | Description |
|---|---|
| afterClosed: Observable |
Gets an observable that is notified when the actions panel is finished closing. |
| afterOpened: Observable |
Gets an observable that is notified when the actions panel has opened and appeared. |
| keydownEvents: Observable |
Gets an observable that emits when keydown events are targeted on the overlay. |
Configuration for opened actions panel. Based on cdk `DialogConfig`.
| Name | Description |
|---|---|
| closeOnNavigation: boolean | Whether the actions panel should be closed of when the user goes backwards/forwards in history. NOTE! This does not apply to router navigation. |
| containerClass: string | string[] | Extra CSS classes to be added to the actions panel container. |
| data: D | Data being injected into the child component. |
| direction: Direction | Direction of the text in the actions panel. |
| disableClose: boolean | Whether the user can use ESC or click on close button to close the actions panel. |
| injector: Injector | Injector used for the instantiation of the component to be attached. |
| maxWidth: string | number | Max-width of the actions panel. If a number is provided, assumes pixel units. NOTE: this property is ignored if the `overlayContainer` property is provided, and will be calculated based on the width of the `overlayContainer`. |
| minWidth: string | number | Min-width of the actions panel. If a number is provided, assumes pixel units. |
| overlayContainer: ElementRef |
Element in which the actions panel overlay will be connected to. |
| overlayPanelClass: string | string[] | Extra CSS classes to be added to the overlay panel. |
| scrollStrategy: (overlay: Overlay) => ScrollStrategy | Scroll strategy to be used for the actions panel. |
| width: string | Width of the actions panel. |
Context for actions panel template.
type KbqActionsPanelTemplateContext = {
/**
* Data passed to actions panel.
*
* Example:
*
* ```html
* <ng-template #actionsPanel let-data>{{ data.KEY }}</ng-template>
* ````
*/
$implicit?: D | null;
/**
* Data passed to actions panel.
*
* Example:
*
* ```html
* <ng-template #actionsPanel let-data="data">{{ data.KEY }}</ng-template>
* ````
*/
data?: D | null;
/**
* Opened actions panel reference.
*
* Example:
*
* ```html
* <ng-template #actionsPanel let-actionsPanelRef="actionsPanelRef">
* <button (click)="actionsPanelRef.close()">close</button>
* </ng-template>
* ````
*/
actionsPanelRef: KbqActionsPanelRef<T, R>;
};
Injection token that can be used to specify default actions panel config.
const KBQ_ACTIONS_PANEL_DEFAULT_CONFIG: InjectionToken<KbqActionsPanelConfig<unknown>>;
Utility for providing default actions panel config.
const kbqActionsPanelDefaultConfigProvider: <D>(config: KbqActionsPanelConfig<D>) => Provider;
Injection token that can be used to access the data that was passed in to actions panel.
const KBQ_ACTIONS_PANEL_DATA: InjectionToken<unknown>;
Localization configuration provider.
const KBQ_ACTIONS_PANEL_LOCALE_CONFIGURATION: InjectionToken<KbqActionsPanelLocaleConfiguration>;
Utility provider for `KBQ_ACTIONS_PANEL_LOCALE_CONFIGURATION`.
const kbqActionsPanelLocaleConfigurationProvider: (configuration: KbqActionsPanelLocaleConfiguration) => Provider;