@clr/angular
Version:
Angular components for Clarity
58 lines (57 loc) • 2.9 kB
TypeScript
import { ElementRef, Injector, OnDestroy } from '@angular/core';
import { ClrCommonStringsService } from '../../utils/i18n/common-strings.service';
import { AbstractPopover } from '../common/abstract-popover';
import { SignpostFocusManager } from './providers/signpost-focus-manager.service';
import { SignpostIdService } from './providers/signpost-id.service';
import * as i0 from "@angular/core";
export declare class ClrSignpostContent extends AbstractPopover implements OnDestroy {
commonStrings: ClrCommonStringsService;
private signpostFocusManager;
private platformId;
signpostCloseAriaLabel: string;
signpostContentId: string;
private document;
private _position;
constructor(injector: Injector, parentHost: ElementRef<HTMLElement>, commonStrings: ClrCommonStringsService, signpostIdService: SignpostIdService, signpostFocusManager: SignpostFocusManager, platformId: any, document: any);
/*********
*
* @description
* A setter for the position of the ClrSignpostContent popover. This is a combination of the following:
* - anchorPoint - where on the trigger to anchor the ClrSignpostContent
* - popoverPoint - where on the ClrSignpostContent container to align with the anchorPoint
* - offsetY - where on the Y axis to align the ClrSignpostContent so it meets specs
* - offsetX - where on the X axis to align the ClrSignpostContent so it meets specs
* There are 12 possible positions to place a ClrSignpostContent container:
* - top-left
* - top-middle
* - top-right
* - right-top
* - right-middle
* - right-bottom
* - bottom-right
* - bottom-middle
* - bottom-left
* - left-bottom
* - left-middle
* - left-top
*
* I think of it as follows for 'top-left' -> CONTAINER_SIDE-SIDE_POSITION. In this case CONTAINER_SIDE is 'top'
* meaning the top of the trigger icon (above the icon that hides/shows) the ClrSignpostContent. And, SIDE_POSITION
* is 'left' meaning two things: 1) the ClrSignpostContent container extends to the left and 2) the 'arrow/pointer'
* linking the SingpostContent to the trigger points down at the horizontal center of the trigger icon.
*
* @param newPosition
*/
get position(): string;
set position(position: string);
/**********
*
* @description
* Close function that uses the signpost instance to toggle the state of the content popover.
*
*/
close(): void;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<ClrSignpostContent, [null, { optional: true; }, null, null, null, null, null]>;
static ɵcmp: i0.ɵɵComponentDeclaration<ClrSignpostContent, "clr-signpost-content", never, { "signpostCloseAriaLabel": "clrSignpostCloseAriaLabel"; "position": "clrPosition"; }, {}, never, ["clr-signpost-title", "*"], false, never>;
}