Common interface for Components with show and collapse functionality
Constructors
Section titled "Constructors"IgxToggleDirective
new IgxToggleDirective(): IgxToggleDirective Returns IgxToggleDirective
Properties
Section titled "Properties"appended
Section titled "appended"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
closed
Section titled "closed"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"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
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"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"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
Accessors
Section titled "Accessors"overlayId
Section titled "overlayId"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"Closes the toggle.
this.myToggle.close();close(event: Event): void Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:262
Parameters
- event:
Event
Returns void
Opens the toggle.
this.myToggle.open();open(overlaySettings: OverlaySettings): void Defined in projects/igniteui-angular/directives/src/directives/toggle/toggle.directive.ts:213
Parameters
- overlaySettings:
OverlaySettings
Returns void
reposition
Section titled "reposition"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"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"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
- overlaySettings:
OverlaySettings