Overlay

@coinbase/cds-web@8.34.1

A semi-transparent layer that covers content.

Import

import { Overlay } from '@coinbase/cds-web/overlays/overlay/Overlay'

SourceView source code

---

Related components

• Modal,
• Tray,
• Tooltip,
• Alert

---

󰏖

View as Markdown

Basic usage

Loading...

󰙡

Live Code

function BasicOverlay() {
  const [isVisible, setIsVisible] = useState(false);

  return (
    <VStack gap={4} height={200} position="relative" width="100%">
      <Button onClick={() => setIsVisible(!isVisible)}>
        {isVisible ? 'Hide' : 'Show'} Overlay
      </Button>
      <Text>Content underneath the overlay</Text>
      {isVisible && <Overlay onClick={() => setIsVisible(false)} />}
    </VStack>
  );
}

With Animation

Loading...

󰙡

Live Code

function AnimatedOverlay() {
  const [isVisible, setIsVisible] = useState(false);

  return (
    <VStack gap={4} height={200} position="relative" width="100%">
      <Button onClick={() => setIsVisible(!isVisible)}>
        {isVisible ? 'Hide' : 'Show'} Animated Overlay
      </Button>
      <Text>Content underneath the overlay</Text>
      {isVisible && <Overlay animated onClick={() => setIsVisible(false)} />}
    </VStack>
  );
}

Custom Background

Loading...

󰙡

Live Code

function CustomOverlay() {
  const [isVisible, setIsVisible] = useState(false);

  return (
    <VStack gap={4} height={200} position="relative" width="100%">
      <Button onClick={() => setIsVisible(!isVisible)}>
        {isVisible ? 'Hide' : 'Show'} Custom Overlay
      </Button>
      <Text>Content underneath the overlay</Text>
      {isVisible && <Overlay animated background="bgLine" onClick={() => setIsVisible(false)} />}
    </VStack>
  );
}