breadcrumb — u_pbt_breadcrumb #

← Referencia de componentes · Índice de la guía

Ruta de navegación: el camino clicable que dice al usuario dónde está, y que lo devuelve con un clic a cualquier nivel superior.

▶ Verlo en vivo — Aplicación de demostración, mosaico Breadcrumb: la vista previa, el código que lo produce y esta página, uno al lado del otro.

En resumen #

Inicio rápido #

// Cada vez que el usuario baja un nivel
uo_crumbs.of_add_item(/*keys*/ "home",                /*text*/ "H")
uo_crumbs.of_add_item(/*keys*/ "home/clients",        /*text*/ "C")
uo_crumbs.of_add_item(/*keys*/ "home/clients/dupont", /*text*/ "D")
// El ultimo anadido pasa a ser el lugar actual, y tambien es pulsable

Un segmento se nombra por su dirección: las claves desde la raíz, unidas por / — "home/clients/dupont". Una clave suelta ya no basta en cuanto se repite en dos niveles de la misma ruta: el componente prefiere entonces negarse a adivinar antes que llevarle a otro sitio.

Es exactamente lo que ue_item_clicked le devuelve, y exactamente lo que of_truncate, of_item o of_add_child vuelven a tomar: lo que recibe se reinyecta tal cual.

Un clic informa, no corta #

Hacer clic en un segmento no acorta la ruta. Subir significa salir de una pantalla, y salir de una pantalla suele significar guardar antes — algo que ningún clic puede decidir. El componente le dice qué se ha pulsado; quien corta es usted, con of_truncate, una vez pasadas sus comprobaciones.

Es el mismo reparto de papeles que en la stepbar, y por la misma razón. Un componente que se mueve solo obliga a la aplicación a deshacer un movimiento ya hecho, en vez de elegir simplemente si ocurre.

Dos segmentos no informan nunca de nada: uno deshabilitado, uno oculto. El último — donde se está — responde como los demás, hasta que ib_last_clickable diga que no.

// event ue_item_clicked : (string as_keys)
// Primero sus comprobaciones - salir de la pantalla lo decide usted, no un clic
if not of_peut_quitter() then return
uo_crumbs.of_truncate(/*keys*/ as_keys)
of_ouvrir_ecran(as_keys)

Cuando el camino es demasiado largo #

Un camino es tan largo como los datos lo hagan, y el ancho es el que es. is_overflow_mode dice qué cede.

Ni el primer segmento ni el último se pliegan jamás. Perder la raíz es perder el ancla a la que todos vuelven; perder el final es perder el sitio en el que se está.

Un segmento plegado informa exactamente como los demás: elegirlo en el … lanza el mismo ue_item_clicked. Estar oculto por el ancho no cambia lo que un segmento significa.

ii_max_visible impone un techo firme, sea cual sea el sitio. Déjelo en 0 — el valor predeterminado — para que decida el ancho, que es lo que una ruta de navegación debería seguir normalmente.

El menú de hermanos #

of_add_child da a un segmento su propio desplegable: las otras ramas de ese nivel. Es lo que evita subir a la raíz para volver a bajar a la carpeta de al lado.

El chevron que sigue al segmento pasa entonces a ser el botón que las abre — es el mismo que el separador, como en el explorador de Windows: un solo chevron, un solo significado que aprender. Elegir una rama lanza ue_child_clicked, y también aquí la ruta no se mueve sola. Con el teclado, Flecha abajo en un segmento abre sus ramas, y en el … lo que oculta.

uo_crumbs.of_add_child(/*keys*/ "home/clients/durand", /*text*/ "D")
uo_crumbs.of_add_child(/*keys*/ "home/clients/martin", /*text*/ "M")

Las ramas bajo demanda #

Poner todas las ramas por adelantado no aguanta en un árbol profundo, ni en una base de datos. El explorador de Windows solo lee una carpeta cuando se abre su chevron; la ruta hace lo mismo: marque un segmento con ib_has_children, su chevron aparece de inmediato, y abrirlo lanza ue_children_needed. Usted pone las ramas en ese evento, y el menú se abre a su vuelta con lo que el segmento tenga en ese momento.

// El segmento promete : el chevron aparece, nada se lee
uo_crumbs.of_item(/*keys*/ "home/clients").ib_has_children = true

// En ue_children_needed(as_keys) : leido ahora, luego se abre el menu
uo_crumbs.of_clear_children(/*keys*/ as_keys)
uo_crumbs.of_add_child(/*keys*/ as_keys + "/durand", /*text*/ "Durand SARL")

Escribir la ruta #

Con ib_editable, la parte vacía de la barra se comporta como la barra de direcciones del explorador de Windows: un clic (o F2, o of_edit) convierte la ruta en un campo de texto con la dirección mostrada — las claves unidas por /, lo que of_path devuelve. Intro lanza ue_path_entered con el texto tal como se escribió; Esc cancela. La ruta no se mueve sola, por la misma razón por la que un clic no la acorta: solo su aplicación sabe qué significan las palabras. ii_edit_skip deja los primeros segmentos fuera del campo — la raíz que nombra la máquina — y los vuelve a poner delante de lo escrito al informar.

Propiedades #

Métodos #

Eventos #

La ruta no navega. Dice dónde se está e informa de lo que se le pide; es su aplicación la que abre la pantalla — la misma acción, lanzada desde un menú o desde la ruta, pasa por el mismo código.

Propiedades de elemento #

Propiedades de un hijo #

Obtenida con of_child(dirección). El menú es un popup nativo: una propiedad cambiada mientras está abierto se ve en la siguiente apertura.

Ejemplos #

Seguirlo al navegar #

uo_crumbs.of_set_redraw(/*on*/ false)
uo_crumbs.of_clear()
uo_crumbs.of_add_item(/*keys*/ "home", /*text*/ "H", /*image*/ "mono:img\packimages.dll:svg/samples/folder-open")
uo_crumbs.of_insert_item(/*keys*/ "home/region", /*text*/ "R", /*index*/ 2)
uo_crumbs.of_set_redraw(/*on*/ true)

Subir con un clic #

uo_crumbs.of_truncate(/*keys*/ "home/clients")
ls_chemin = uo_crumbs.of_path()

Un nivel prohibido, uno oculto #

// El nivel existe, pero no se puede volver a el
uo_crumbs.of_item(/*keys*/ "home/clients/orders").ib_enabled = false
// Y este no le incumbe al usuario : fuera de la ruta, separador incluido
uo_crumbs.of_item(/*keys*/ "home").ib_visible = false

uo_crumbs.is_separator = uo_crumbs.SEPARATOR_SLASH
uo_crumbs.is_overflow_mode = uo_crumbs.OVERFLOW_SCROLL
uo_crumbs.ii_max_visible = 4
uo_crumbs.ib_last_clickable = false
uo_crumbs.of_remove_item(/*keys*/ "home/region")
uo_crumbs.of_clear_children(/*keys*/ "home/clients")

Buenas prácticas #

• Dé a cada segmento la clave de la pantalla que abre: su ue_item_clicked se convierte en un choose case que se lee, y el mismo código sirve al menú.
• Llame a of_truncate dentro de su manejador de clic, no antes: es lo que garantiza que nunca se sale de una pantalla sin sus comprobaciones.
• Deje ii_max_visible en 0 salvo que un diseño lo imponga. Una ruta que sigue el ancho muestra siempre todo lo que cabe.
• Nombre los segmentos con palabras que el usuario reconozca — el nombre del cliente, no su identificador. Una ruta se lee, no se descifra.
• Ponga en ella solo niveles a los que se pueda volver de verdad. Un segmento que falla una vez de cada dos hace perder la confianza en toda la ruta; si un nivel está prohibido temporalmente, ib_enabled lo dice sin mentir.
• Una ruta de navegación dice un lugar, no una progresión: para « paso 2 de 5 » lo que hace falta es la stepbar.

Heredado de la base común #

Estos miembros existen en todos los componentes visuales — no son propios de este. Se detallan una sola vez, en los capítulos transversales; esta tabla solo dice dónde leerlos.

Dos ayudas no se heredan: of_icon y of_escape_markup viven en n_pbt_utils. Declare uno — n_pbt_utils lnv_utils, nada que crear — y llámelas sobre él.

← Referencia de componentes · Índice de la guía