Pular para o conteúdo

🎉 Material UI v5 is out! Head to the migration guide to get started.

Popper

Um Popper pode ser usado para exibir algum conteúdo em cima do outro. É uma alternativa para react-popper.

Algumas características importantes do componente Popper:

  • 🕷 Popper é baseado na biblioteca de terceiros (Popper.js) para um posicionamento perfeito.
  • 💄 É uma API alternativa para react-popper. Visa a simplicidade.
  • 📦 10 kB gzipped (7 kB do Popper.js).
  • O elemento filho Portal no corpo do documento, evita problemas de renderização. Você pode desativar esse comportamento com disablePortal.
  • O scroll não e bloqueado como ocorre com o componente Popover. O posicionamento do popper é atualizado com a área disponível no visor.
  • Clicar fora não oculta o componente Popper. Se você precisar desse comportamento, você pode usar o componente ClickAwayListener - veja o exemplo na seção da documentação do menu.
  • O anchorEl é passado como o objeto de referência para criar uma nova instância Popper.js.

Popper Simples

<button aria-describedby={id} type="button" onClick={handleClick}>
  Toggle Popper
</button>
<Popper id={id} open={open} anchorEl={anchorEl}>
  <div className={classes.paper}>The content of the Popper.</div>
</Popper>

Transições

O estado de aberto/fechado do popper pode ser animado com uma propriedade de renderização do elemento filho e um componente de transição. Este componente deve respeitar as seguintes condições:

  • Ser um elemento filho descendente direto de popper.
  • Chamar a propriedade de callback onEnter quando a transição de entrada iniciar.
  • Chamar a propriedade de callback onExited quando a transição de saída for concluída. Esses dois callbacks permitem que o popper desmonte o conteúdo filho quando fechado e seja totalmente transitado.

Popper possui suporte interno para react-transition-group.

<button aria-describedby={id} type="button" onClick={handleClick}>
  Toggle Popper
</button>
<Popper id={id} open={open} anchorEl={anchorEl} transition>
  {({ TransitionProps }) => (
    <Fade {...TransitionProps} timeout={350}>
      <div className={classes.paper}>The content of the Popper.</div>
    </Fade>
  )}
</Popper>

Como alternativa, você pode usar react-spring.

<button aria-describedby={id} type="button" onClick={handleClick}>
  Toggle Popper
</button>
<Popper id={id} open={open} anchorEl={anchorEl} transition>
  {({ TransitionProps }) => (
    <Fade {...TransitionProps}>
      <div className={classes.paper}>The content of the Popper.</div>
    </Fade>
  )}
</Popper>

Posicionado Popper



Rolagem - Exemplo interativo

Scroll around this container to experiment with flip and preventOverflow modifiers.

Appearance
Modifiers (options from Popper.js)
<Popper
    placement="bottom"
    disablePortal={false}
    modifiers={{
      flip: {
        enabled: true,
      },
      preventOverflow: {
        enabled: true,
        boundariesElement: 'scrollParent',
      },
      arrow: {
        enabled: false,
        element: arrowRef,
      },
    }}
  >

Objeto de referência falsificado

A propriedade anchorEl pode ser uma referência a um elemento DOM falso. Você só precisa criar um objeto com o formato ReferenceObject.

Selecione parte do texto para ver o popper:

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam ipsum purus, bibendum sit amet vulputate eget, porta semper ligula. Donec bibendum vulputate erat, ac fringilla mi finibus nec. Donec ac dolor sed dolor porttitor blandit vel vel purus. Fusce vel malesuada ligula. Nam quis vehicula ante, eu finibus est. Proin ullamcorper fermentum orci, quis finibus massa. Nunc lobortis, massa ut rutrum ultrices, metus metus finibus ex, sit amet facilisis neque enim sed neque. Quisque accumsan metus vel maximus consequat. Suspendisse lacinia tellus a libero volutpat maximus.

Projetos Complementares

Para situações de uso mais avançadas, você pode tirar proveito com:

PopupState helper

Existe um pacote de terceiros material-ui-popup-state que cuida do estado popover para você na maioria das situações.