shadcnui

Shadcn Warning: Missing `Description` or `aria-describedby={undefined}` for {DialogContent}


I'm getting the following warning in my JavaScript console every time I open my Sheet component.

Warning: Missing Description or aria-describedby={undefined} for {DialogContent}.

I'm confused because I don't use any Dialog components in my sheet, so why is this happening and how do I get rid of this warning? Here's my relevant code for the Sheet component:

<Sheet open={openMenu} onOpenChange={setOpenMenu}>
  <SheetTrigger asChild>
    <Button variant="ghost">
      <MenuIcon color={location.pathname === "/" ? "white" : "black"} size="2em" />
    </Button>
  </SheetTrigger>
  <SheetContent side="right" className="fixed z-50">
    <div >
      <p>Sheet Content</p>
    </div>
  </SheetContent>
</Sheet>

Solution

  • The Shadcn Sheet component is an extension of the Dialog component, and so <SheetContent> requires a <SheetDescription> just like a regular Dialog component requires. Just add a sheet description underneath your sheet content and the error will go away.

    <SheetContent side="right">
      <SheetHeader>
        <SheetDescription>Description goes here</SheetDescription>
      </SheetHeader>
    </SheetContent>
    

    If you don't want the description to show up in your application, use radixUI's VisuallyHidden component like so:

    <VisuallyHidden.Root>
      <SheetDescription>
        Description goes here
      </SheetDescription>
    </VisuallyHidden.Root>