ModalSlideshow

ModalSlideshow is a special Modal using Slideshow illustrations (images or videos). We recommend making sure that the content on the left side is not too long, especially when translated. Please prefer using multiple slides in that case.

View source code
  • isOpen
    boolean

    Whether the ModalSlideshow should be open.

  • onCancel
    MouseEventHandler<HTMLElement>

    Handler that is called to cancel the slideshow.

  • onClose
    ({ event, index, }: { event: MouseEvent<HTMLElement, MouseEvent>; index: number; }) => void

    Handler that is called when the ModalSlideshow is closed.

  • onDone
    MouseEventHandler<HTMLElement>

    Handler that is called after the last slide has been displayed.

  • slides
    ModalSlideshowSlide[]

    The slides to display in the ModalSlideshow.

  • translations
    { cancel: string; previous: string; next: string; done: string; }

    The translations for the buttons.

  • noAnimation
    boolean

    Whether the ModalSlideshow should have opening and closing animation.

  • portalContainer
    Element

    The element where to mount the Modal. It needs to be outside the GrapesProvider tree for the focus trap to work properly.

    Default: document.body