API Reference / @dasch-ng/material-right-sheet / MatRightSheet
Class: MatRightSheet
Defined in: libs/material/right-sheet/src/lib/right-sheet.ts:24
Service to trigger Material Design right sheets.
Implements
OnDestroy
Constructors
Constructor
new MatRightSheet():
MatRightSheet
Defined in: libs/material/right-sheet/src/lib/right-sheet.ts:46
Returns
MatRightSheet
Accessors
_openedRightSheetRef
Get Signature
get _openedRightSheetRef():
MatRightSheetRef<any,any> |null
Defined in: libs/material/right-sheet/src/lib/right-sheet.ts:33
Reference to the currently opened right sheet.
Returns
MatRightSheetRef<any, any> | null
Set Signature
set _openedRightSheetRef(
value):void
Defined in: libs/material/right-sheet/src/lib/right-sheet.ts:38
Parameters
value
MatRightSheetRef<any, any> | null
Returns
void
Methods
dismiss()
dismiss<
R>(result?):void
Defined in: libs/material/right-sheet/src/lib/right-sheet.ts:120
Dismisses the currently-visible right sheet.
Type Parameters
R
R = any
Parameters
result?
R
Data to pass to the right sheet instance.
Returns
void
ngOnDestroy()
ngOnDestroy():
void
Defined in: libs/material/right-sheet/src/lib/right-sheet.ts:126
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.
Returns
void
Implementation of
OnDestroy.ngOnDestroy
open()
Call Signature
open<
T,D,R>(component,config?):MatRightSheetRef<T,R>
Defined in: libs/material/right-sheet/src/lib/right-sheet.ts:58
Opens a right sheet containing the given component.
Type Parameters
T
T
D
D = any
R
R = any
Parameters
component
ComponentType<T>
Type of the component to load into the right sheet.
config?
Extra configuration options.
Returns
MatRightSheetRef<T, R>
Reference to the newly-opened right sheet.
Call Signature
open<
T,D,R>(template,config?):MatRightSheetRef<T,R>
Defined in: libs/material/right-sheet/src/lib/right-sheet.ts:66
Opens a right sheet containing the given template.
Type Parameters
T
T
D
D = any
R
R = any
Parameters
template
TemplateRef<T>
TemplateRef to instantiate as the right sheet content.
config?
Extra configuration options.
Returns
MatRightSheetRef<T, R>
Reference to the newly-opened right sheet.