API Reference

---

API Reference / @dasch-ng/material-right-sheet / MatRightSheetConfig

Class: MatRightSheetConfig<D>

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:22

Configuration used when opening a right sheet.

Type Parameters

D

D = any

Constructors

Constructor

new MatRightSheetConfig<D>(): MatRightSheetConfig<D>

Returns

MatRightSheetConfig<D>

Properties

ariaLabel?

optional ariaLabel: string | null = null

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:45

Aria label to assign to the bottom sheet element.

---

autoFocus?

optional autoFocus: string | boolean = 'dialog'

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:62

Where the bottom sheet should focus on open.

Breaking-change

14.0.0 Remove boolean option from autoFocus. Use string or AutoFocusTarget instead.

---

backdropClass?

optional backdropClass: string

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:39

Custom class for the backdrop.

---

closeOnNavigation?

optional closeOnNavigation: boolean = true

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:52

Whether the bottom sheet should close when the user goes backwards/forwards in history. Note that this usually doesn't include clicking on links (unless the user is using the HashLocationStrategy).

---

data?

optional data: D | null = null

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:33

Data being injected into the child component.

---

direction?

optional direction: Direction

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:30

Text layout direction for the bottom sheet.

---

disableClose?

optional disableClose: boolean = false

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:42

Whether the user can use escape or clicking outside to close the bottom sheet.

---

hasBackdrop?

optional hasBackdrop: boolean = true

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:36

Whether the bottom sheet has a backdrop.

---

panelClass?

optional panelClass: string | string[]

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:27

Extra CSS classes to be added to the bottom sheet container.

---

restoreFocus?

optional restoreFocus: boolean = true

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:68

Whether the bottom sheet should restore focus to the previously-focused element, after it's closed.

---

scrollStrategy?

optional scrollStrategy: ScrollStrategy

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:71

Scroll strategy to be used for the bottom sheet.

---

viewContainerRef?

optional viewContainerRef: ViewContainerRef

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:24

The view container to place the overlay for the bottom sheet into.

---

width?

optional width: string

Defined in: libs/material/right-sheet/src/lib/right-sheet.config.ts:76

width of overlay