Home > @uniformdev/design-system > DrawerItem

DrawerItem interface

Signature:

Properties

Property

Modifiers

Type

Description

id

string

An ID for the drawer. It should be unique in the stack where it's rendered

instanceKey?

string

(Optional) Just like React.Key, changing this value indicates that the drawer has changed and we need to close the current instance and open a new one

onRequestClose?

() => void

(Optional) Called when the close button is clicked, the Escape button is pressed, or when the drawer's overlay is clicked

stackId?

string

(Optional) The ID of the stack where the drawer should be renderer. It should match the stack ID of an existing DrawerRenderer. If not provided, it will fall back to the default renderer of the drawer. If the drawer is rendered inside another one, this value gets inherited.

testId?

string

(Optional) Test ID for test automation *

width?

DrawerRendererProps['width']

(Optional) The desired width of the drawer. This value is ignored if the drawer is part of a DrawerRenderer with withoutFluidWidth. If not set, the drawer will use the width of its renderer.