Alterna superposiciones contextuales para mostrar listas de enlaces y más con el complemento desplegable de Bootstrap.
Descripción general del componente Desplegable
Los menús desplegables son superposiciones contextuales alternables para mostrar listas de enlaces y más. Se vuelven interactivos con el complemento JavaScript desplegable Bootstrap incluido. Se alternan haciendo clic, no al pasar el cursor; esta es una decisión de diseño intencional.
Los menús desplegables se basan en una biblioteca de terceros, Popper, que proporciona posicionamiento dinámico y detección de viewport. Asegúrate de incluir popper.min.js antes del JavaScript de Bootstrap o usa bootstrap.bundle.min.js / bootstrap.bundle.js que contiene Popper. Sin embargo, Popper no se utiliza para posicionar menús desplegables en las barras de navegación, ya que no se requiere posicionamiento dinámico.
Accesibilidad del componente Desplegable
Es estándar WAI ARIA define un role="menu" widget, pero esto es específico de menús similares a aplicaciones que activan acciones o funciones. Los menús ARIA solo pueden contener elementos de menú, elementos de menú de casilla de verificación, elementos de menú de botones de opción, grupos de botones de opción y submenús.
Los menús desplegables de Bootstrap, por otro lado, están diseñados para ser genéricos y aplicables a una variedad de situaciones y estructuras de marcado. Por ejemplo, es posible crear menús desplegables que contengan entradas y controles de formulario adicionales, como campos de búsqueda o formularios de inicio de sesión. Por este motivo, Bootstrap no espera (ni agrega automáticamente) ninguno de los atributos role y aria- necesarios para menús verdaderamente ARIA. Los autores deberán incluir ellos mismos estos atributos más específicos.
Sin embargo, Bootstrap agrega soporte integrado para la mayoría de las interacciones estándar del menú del teclado, como la capacidad de moverse a través de elementos .dropdown-item individuales usando el teclas del cursor y cierre el menú con la tecla Esc.
Ejemplos del componente Desplegable
Envuelve el menú desplegable (tu botón o enlace) y el menú desplegable dentro de .dropdown, u otro elemento que declare position: relative;. Lo ideal sería utilizar un elemento <button> como activador del menú desplegable, pero el complemento también funcionará con elementos <a>. Los ejemplos que se muestran aquí utilizan elementos semánticos <ul> cuando corresponde, pero se admite el marcado personalizado.
Botón único
Cualquier .btn se puede convertir en un menú desplegable con algunos cambios de marcado. Así es como puedes ponerlos a trabajar con elementos <button>:
Si bien <button> es el control recomendado para un menú desplegable, puede haber situaciones en las que tengas que usar un <a>. Si lo haces, te recomendamos agregar un atributo role="button" para transmitir adecuadamente el propósito del control a tecnologías de asistencia como lectores de pantalla.
La mejor parte es que también puedes hacer esto con cualquier variante de botón:
Botones divididos
De manera similar, crea menús desplegables de botones divididos con prácticamente el mismo marcado que los menús desplegables de un solo botón, pero con la adición de .dropdown-toggle-split para lograr un espaciado adecuado alrededor del cursor (caret) desplegable.
Usamos esta clase adicional para reducir el padding horizontal a cada lado del cursor en un 25% y eliminar el margin-left eso se agrega para los menús desplegables de botones regulares. Esos cambios adicionales mantienen el cursor centrado en el botón de división y proporcionan un área de impacto de tamaño más apropiado al lado del botón principal.
Tamaños del componente Desplegable
Los menús desplegables de botones funcionan con botones de todos los tamaños, incluidos los botones desplegables predeterminados y divididos.
Menús desplegables oscuros
Obsoleto en v5.3.0
Opta por menús desplegables más oscuros para que coincidan con una barra de navegación oscura o un estilo personalizado agregando .dropdown-menu-dark a un .dropdown-menu. No se requieren cambios en los elementos desplegables.
Y ponerlo en uso en una barra de navegación:
Direcciones del componente Desplegable
Centrado
Haz que el menú desplegable esté centrado debajo del interruptor con .dropdown-center en el elemento padre.
Dropup
Activa menús desplegables encima de los elementos agregando .dropup al elemento padre.
Dropup centrado
Haz que el menú desplegable esté centrado encima del interruptor con .dropup-center en el elemento principal.
Dropend
Activa menús desplegables a la derecha de los elementos agregando .dropend al elemento principal.
Dropstart
Activa menús desplegables a la izquierda de los elementos agregando .dropstart al elemento principal.
Elementos del menú desplegable
Puedes usar elementos <a> o <button> como elementos desplegables.
También puedes crear elementos desplegables no interactivos con .dropdown-item-text. Siéntete libre de diseñar aún más con CSS personalizado o utilidades de texto.
Activo
Agrega .active a los elementos en el menú desplegable para diseñarlos como activos. Para transmitir el estado activo a las tecnologías de asistencia, utiliza el atributo aria-current, utilizando el valor page para la página actual o true para la elemento actual en un conjunto.
Deshabilitado
Agrega .disabled a los elementos en el menú desplegable para mostrarlos como deshabilitados.
Alineación del menú desplegable
De forma predeterminada, un menú desplegable se coloca automáticamente al 100% desde la parte superior y a lo largo del lado izquierdo de su padre. Puedes cambiar esto con las clases direccionales .drop*, pero también puedes controlarlas con clases modificadoras adicionales.
Agrega .dropdown-menu-end a un .dropdown-menu para alinear a la derecha el menú desplegable. Las instrucciones se reflejan cuando se usa Bootstrap en RTL, lo que significa que .dropdown-menu-end aparecerá en el lado izquierdo.
Alineación responsive
Si quieres usar alineación responsive, deshabilita el posicionamiento dinámico agregando el atributo data-bs-display="static" y usa las clases de variación responsive.
Para alinear a la derecha el menú desplegable con el punto de interrupción dado o mayor, agrega .dropdown-menu{-sm|-md|-lg|-xl|-xxl}-end.
Para alinear a la izquierda el menú desplegable con el punto de interrupción dado o más grande, agrega .dropdown-menu-end y .dropdown-menu{-sm|-md|-lg|-xl|-xxl}-start.
Ten en cuenta que no necesitas agregar un atributo data-bs-display="static" a los botones desplegables en las barras de navegación, ya que Popper no es utilizado en barras de navegación.
Opciones de alineación
Tomando la mayoría de las opciones que se muestran arriba, aquí tienes una pequeña demostración de fregadero de cocina con varias opciones de alineación desplegable en un solo lugar.
Contenido del menú desplegable
Encabezados
Agrega un encabezado para etiquetar secciones de acciones en cualquier menú desplegable.
Divisores
Separa grupos de elementos de menú relacionados con un divisor.
Texto
Coloca cualquier texto de formato libre dentro de un menú desplegable con texto y usa utilidades de espaciado. Ten en cuenta que probablemente necesitarás estilos de tamaño adicionales para limitar el ancho del menú.
Formularios
Coloca un formulario dentro de un menú desplegable, o conviértelo en un menú desplegable, y usa utilidades de margen o relleno. para darle el espacio negativo que necesitas.
Opciones del componente Desplegable
Usa data-bs-offset o data-bs-reference para cambiar la ubicación del menú desplegable.
Comportamiento de cierre automático
De forma predeterminada, el menú desplegable se cierra al hacer clic dentro o fuera del menú desplegable. Puedes utilizar la opción autoClose para cambiar este comportamiento del menú desplegable.
Personalización del CSS del componente
Variables Sass del componente
Agregado en v5.2.0
Como parte del enfoque de variables CSS en evolución de Bootstrap, los menús desplegables ahora usan variables CSS locales en .dropdown-menu para una personalización mejorada en tiempo real. Los valores de las variables CSS se establecen a través de Sass, por lo que la personalización de Sass también es compatible.
La personalización a través de variables CSS se puede ver en la clase .dropdown-menu-dark donde sobrescribimos valores específicos sin agregar selectores CSS duplicados.
A través de atributos de datos o JavaScript, el complemento desplegable alterna el contenido oculto (menús desplegables) alternando la clase .show en el .dropdown-menu. El atributo data-bs-toggle="dropdown" se utiliza para cerrar menús desplegables a nivel de aplicación, por lo que es una buena idea usarlo siempre.
Vía atributos de datos
Agrega data-bs-toggle="dropdown" a un enlace o botón para alternar un menú desplegable.
Vía JavaScript
Llama a los menús desplegables a través de JavaScript:
Opciones
Como las opciones se pueden pasar a través de atributos de datos o JavaScript, puedes agregar un nombre de opción a data-bs-, como en data-bs-animation="{value}". Asegúrate de cambiar el tipo de caso del nombre de la opción de “camelCase” a “kebab-case” al pasar las opciones a través de atributos de datos. Por ejemplo, utiliza data-bs-custom-class="beautifier" en lugar de data-bs-customClass="beautifier".
A partir de Bootstrap 5.2.0, todos los componentes admiten un atributo de datos experimental reservado data-bs-config que puede albergar datos simples de configuración del componente como una cadena JSON. Cuando un elemento tiene los atributos data-bs-config='{"delay":0, "title":123}' y data-bs-title="456", el valor final de title será 456 y los atributos de datos separados sobrescribirán los valores proporcionados en data-bs-config. Además, los atributos de datos existentes pueden albergar valores JSON como data-bs-delay='{"show":0,"hide":150}'.
El objeto de configuración final es el resultado combinado de data-bs-config, data-bs- y js object donde el último valor-clave dado sobrescribe los demás.
Nombre
Tipo
Predeterminado
Descripción
autoClose
boolean, string
true
Configura el comportamiento de cierre automático del menú desplegable:
* true - el menú desplegable se cerrará al hacer clic fuera o dentro del menú desplegable. * false - el menú desplegable se cerrará haciendo clic en el botón de alternancia y llamando manualmente al método hide o toggle. (Tampoco se cerrará presionando la tecla Esc) * 'inside' - el menú desplegable se cerrará (solo) al hacer clic dentro del menú desplegable. * 'outside' - el menú desplegable se cerrará (solo) al hacer clic fuera del menú desplegable.
Nota: el menú desplegable siempre se puede cerrar con la tecla Esc.
boundary
string, element
'clippingParents'
Límite de restricción de desbordamiento del menú desplegable (se aplica solo al modificador preventOverflow de Popper). Por defecto es clippingParents y puede aceptar una referencia HTMLElement (solo a través de JavaScript). Para obtener más información, consulta la documentación de detectOverflow de Popper.
display
string
'dynamic'
De forma predeterminada, usamos Popper para el posicionamiento dinámico. Desactiva esto con static.
offset
array, string, function
[0, 2]
Desplazamiento del menú desplegable con respecto a su objetivo. Puedes pasar una cadena en atributos de datos con valores separados por comas como: data-bs-offset="10,20". Cuando se usa una función para determinar el desplazamiento, se llama con un objeto que contiene la ubicación del popper, la referencia y los rectificadores del popper como primer argumento. El nodo DOM del elemento desencadenante se pasa como segundo argumento. La función debe devolver una matriz con dos números: skidding, distance. Para obtener más información, consulta la documentación de offsetde Popper.
popperConfig
null, object, function
null
Para cambiar la configuración predeterminada de Popper de Bootstrap, consulta Configuración de Popper. Cuando se usa una función para crear la configuración de Popper, se llama con un objeto que contiene la configuración de Popper predeterminada de Bootstrap. Te ayuda a utilizar y fusionar el valor predeterminado con tu propia configuración. La función debe devolver un objeto de configuración para Popper.
reference
string, element, object
'toggle'
Elemento de referencia del menú desplegable. Acepta los valores de 'toggle', 'parent', una referencia HTMLElement o un objeto que proporciona getBoundingClientRect. Para obtener más información, consulta la documentación del constructor y documentación de elementos virtuales.
Usar la función con popperConfig
Métodos
Método
Descripción
dispose
Destruye el menú desplegable de un elemento. (Elimina los datos almacenados en el elemento DOM)
getInstance
Método estático que te permite obtener la instancia desplegable asociada a un elemento DOM, puedes usarlo así: bootstrap.Dropdown.getInstance(element).
getOrCreateInstance
Método estático que devuelve una instancia desplegable asociada a un elemento DOM o crea una nueva en caso de que no haya sido inicializada. Puedes usarlo así: bootstrap.Dropdown.getOrCreateInstance(element).
hide
Oculta el menú desplegable de una barra de navegación o navegación con pestañas determinada.
show
Muestra el menú desplegable de una barra de navegación o navegación con pestañas determinada.
toggle
Alterna el menú desplegable de una barra de navegación determinada o de navegación con pestañas.
update
Actualiza la posición del menú desplegable de un elemento.
Eventos
Todos los eventos desplegables se activan en el elemento de alternancia y luego aparecen. Por lo tanto, también puedes agregar detectores de eventos en el elemento padre del .dropdown-menu. Los eventos hide.bs.dropdown y hidden.bs.dropdown tienen una propiedad clickEvent (solo cuando el tipo de evento original es click) que contiene un objeto de evento para el evento de clic.
Tipo de evento
Descripción
hide.bs.dropdown
Se activa inmediatamente cuando se llama al método de instancia hide.
hidden.bs.dropdown
Se activa cuando el menú desplegable termina de ocultarse al usuario y se completan las transiciones CSS.
show.bs.dropdown
Se activa inmediatamente cuando se llama al método de instancia show.
shown.bs.dropdown
Se activa cuando el menú desplegable se hace visible para el usuario y se completan las transiciones CSS.