Common interface for Components with show and collapse functionality

Constructors

Section titled "Constructors"

IgxNotificationsDirective

new IgxNotificationsDirective(): IgxNotificationsDirective

Returns IgxNotificationsDirective

Properties

Section titled "Properties"

appended

Section titled "appended"

Inherited from: IgxToggleDirective

Emits an event after the toggle element is appended to the overlay container.

onAppended() {
 alert("Content appended!");
}
<div
  igxToggle
  (appended)='onToggleAppended()'>
</div>
appended: EventEmitter<ToggleViewEventArgs>

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:143

ariaLive

Section titled "ariaLive"

Sets/gets the aria-live attribute. If not set, aria-live will have value "polite".

 
ariaLive: string = 'polite'

Defined in projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts:15

autoHide

Section titled "autoHide"

Sets/gets whether the element will be hidden after the displayTime is over. Default value is true.

 
autoHide: boolean = true

Defined in projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts:22

closed

Section titled "closed"

Inherited from: IgxToggleDirective

Emits an event after the toggle container is closed.

onToggleClosed(event) {
 alert("Toggle closed!");
}
<div
  igxToggle
  (closed)='onToggleClosed($event)'>
</div>
closed: EventEmitter<ToggleViewEventArgs>

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:105

closing

Section titled "closing"

Inherited from: IgxToggleDirective

Emits an event before the toggle container is closed.

onToggleClosing(event) {
 alert("Toggle closing!");
}
<div
 igxToggle
 (closing)='onToggleClosing($event)'>
</div>
closing: EventEmitter<ToggleViewCancelableEventArgs>

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:124

displayTime

Section titled "displayTime"

Sets/gets the duration of time span (in milliseconds) which the element will be visible after it is being shown. Default value is 4000.

 
displayTime: number = 4000

Defined in projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts:30

id

Section titled "id"

Inherited from: IgxToggleDirective

Identifier which is registered into IgxNavigationService

let myToggleId = this.toggle.id;
id: string

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:160

opened

Section titled "opened"

Inherited from: IgxToggleDirective

Emits an event after the toggle container is opened.

onToggleOpened(event) {
   alert("Toggle opened!");
}
<div
  igxToggle
  (opened)='onToggleOpened($event)'>
</div>
opened: EventEmitter<ToggleViewEventArgs>

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:67

opening

Section titled "opening"

Inherited from: IgxToggleDirective

Emits an event before the toggle container is opened.

onToggleOpening(event) {
 alert("Toggle opening!");
}
<div
  igxToggle
  (opening)='onToggleOpening($event)'>
</div>
opening: EventEmitter<ToggleViewCancelableEventArgs>

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:86

outlet

Section titled "outlet"

Gets/Sets the container used for the element.

 
outlet: IgxOverlayOutletDirective | ElementRef<HTMLElement>

Defined in projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts:43

Remarks

outlet is an instance of IgxOverlayOutletDirective or an ElementRef.

positioning

Section titled "positioning"

Controls whether positioning is relative to the viewport or to the nearest positioned container.

 
positioning: "container" | "viewport" = 'viewport'

Defined in projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts:49

isVisible

Section titled "isVisible" 
isVisible: boolean

Defined in projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts:56, projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts:60

Accessors

Section titled "Accessors"

overlayId

Section titled "overlayId"

Inherited from: IgxToggleDirective

Returns the id of the overlay the content is rendered in.

this.myToggle.overlayId;
get overlayId(): string

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:303

Returns string

Methods

Section titled "Methods"

close

Section titled "close"

Hides the element.

close(): void

Defined in projects/igniteui-angular/directives/src/directives/notification/notifications.directive.ts:114

Returns void

reposition

Section titled "reposition"

Inherited from: IgxToggleDirective

Repositions the toggle.

this.myToggle.reposition();
reposition(): void

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:313

Returns void

setOffset

Section titled "setOffset"

Inherited from: IgxToggleDirective

Offsets the content along the corresponding axis by the provided amount with optional offsetMode that determines whether to add (by default) or set the offset values with OffsetMode.Add and OffsetMode.Set

setOffset(deltaX: number, deltaY: number, offsetMode: OffsetMode): void

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:321

Parameters

  • deltaX: number
  • deltaY: number
  • offsetMode: OffsetMode

Returns void

toggle

Section titled "toggle"

Inherited from: IgxToggleDirective

Opens or closes the toggle, depending on its current state.

this.myToggle.toggle();
toggle(overlaySettings: OverlaySettings): void

Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:281

Parameters

Returns void