API Reference / @dasch-ng/material-right-sheet / MatRightSheetRef
Class: MatRightSheetRef<T, R>
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:19
Reference to a bottom sheet dispatched from the bottom sheet service.
Type Parameters
T
T = any
R
R = any
Constructors
Constructor
new MatRightSheetRef<
T,R>(_ref,config,containerInstance):MatRightSheetRef<T,R>
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:43
Parameters
_ref
DialogRef<R, T>
config
containerInstance
Returns
MatRightSheetRef<T, R>
Properties
containerInstance
containerInstance:
MatRightSheetContainer
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:29
Instance of the component into which the bottom sheet content is projected.
Docs-private
disableClose
disableClose:
boolean|undefined
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:32
Whether the user is allowed to close the bottom sheet.
Accessors
instance
Get Signature
get instance():
T
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:21
Instance of the component making up the content of the bottom sheet.
Returns
T
Methods
afterDismissed()
afterDismissed():
Observable<R|undefined>
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:119
Gets an observable that is notified when the bottom sheet is finished closing.
Returns
Observable<R | undefined>
afterOpened()
afterOpened():
Observable<void>
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:124
Gets an observable that is notified when the bottom sheet has opened and appeared.
Returns
Observable<void>
backdropClick()
backdropClick():
Observable<MouseEvent>
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:131
Gets an observable that emits when the overlay's backdrop has been clicked.
Returns
Observable<MouseEvent>
dismiss()
dismiss(
result?):void
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:89
Dismisses the bottom sheet.
Parameters
result?
R
Data to be passed back to the bottom sheet opener.
Returns
void
keydownEvents()
keydownEvents():
Observable<KeyboardEvent>
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:138
Gets an observable that emits when keydown events are targeted on the overlay.
Returns
Observable<KeyboardEvent>
updateWidth()
updateWidth(
width):void
Defined in: libs/material/right-sheet/src/lib/right-sheet.ref.ts:146
Updates the right sheet width.
Parameters
width
string
Returns
void