Restricciones y orden de los modificadores

En Compose, puedes encadenar varios modificadores para cambiar el aspecto de un elemento componible. Estas cadenas de modificadores pueden afectar las restricciones que se pasan a los elementos componibles, que definen los límites de ancho y alto.

En esta página, se describe cómo los modificadores en cadena afectan las restricciones y, a su vez, la medición y la posición de los elementos componibles.

Modificadores en el árbol de IU

Para comprender cómo los modificadores influyen entre sí, es útil visualizar cómo aparecen en el árbol de IU, que se genera durante la fase de composición. Para obtener más información, consulta la sección Composición.

En el árbol de IU, puedes visualizar los modificadores como nodos wrappers para los nodos de diseño:

Si agregas más de un modificador a un elemento componible, se crea una cadena de modificadores. Cuando encadenas varios modificadores, cada nodo modificador envuelve el resto de la cadena y el nodo de diseño. Por ejemplo, cuando encadenas un clip y un modificador size, el nodo modificador clip une el nodo modificador size, que luego une el nodo de diseño Image.

En la fase de diseño, el algoritmo que recorre el árbol se mantiene igual, pero también se visita cada nodo modificador. De esta manera, un modificador puede cambiar los requisitos de tamaño y la posición del modificador o nodo de diseño que une.

Como se muestra en la Figura 2, la implementación de los elementos Image y Text componibles consiste en una cadena de modificadores que unen un solo nodo de diseño. Las implementaciones de Row y Column son simplemente nodos de diseño que describen cómo diseñar sus elementos secundarios.

En resumen:

• Los modificadores unen un solo modificador o nodo de diseño.
• Los nodos de diseño pueden distribuir varios nodos secundarios.

En las siguientes secciones, se describe cómo usar este modelo mental para razonar sobre el encadenamiento de modificador y cómo influye en el tamaño de los elementos componibles.

Restricciones en la fase de diseño

La fase de diseño sigue un algoritmo de tres pasos para encontrar el ancho, la altura y la coordenada x, y de cada nodo de diseño:

1. Medir elementos secundarios: Un nodo mide sus elementos secundarios, si los hay.
2. Decide tu propio tamaño: En función de esas mediciones, un nodo decide su propio tamaño.
3. Colocar los elementos secundarios: Cada nodo secundario se coloca en relación con la posición propia de un nodo.

Constraints ayuda a encontrar los tamaños correctos para los nodos durante los primeros dos pasos del algoritmo. Las restricciones definen los límites mínimos y máximos para el ancho y la altura de un nodo. Cuando el nodo decide su tamaño, su tamaño medido debe estar dentro de este rango de tamaño.

Tipos de restricciones

Una restricción puede ser una de las siguientes:

• Delimitado: El nodo tiene un ancho y una altura máximos y mínimos.

• No delimitado: El nodo no está restringido a ningún tamaño. Los límites máximos de ancho y alto están establecidos en infinito.

• Exacta: Se le pide al nodo que cumpla con un requisito de tamaño exacto. Los límites mínimo y máximo se establecen en el mismo valor.

• Combinación: el nodo sigue una combinación de los tipos de restricciones anteriores. Por ejemplo, una restricción podría limitar el ancho y permitir una altura máxima no delimitada, o bien establecer un ancho exacto, pero proporcionar una altura limitada.

En la siguiente sección, se describe cómo se pasan estas restricciones de un elemento superior a uno secundario.

Cómo se pasan las restricciones de elementos superiores a secundarios

Durante el primer paso del algoritmo descrito en Restricciones en la fase de diseño, las restricciones se pasan del elemento superior al elemento secundario en el árbol de IU.

Cuando un nodo superior mide sus elementos secundarios, proporciona estas restricciones a cada elemento secundario para informarles qué tan grandes o pequeños pueden ser. Luego, cuando decide su propio tamaño, también cumple con las restricciones que pasaron sus propios elementos superiores.

En términos generales, el algoritmo funciona de la siguiente manera:

1. Para decidir el tamaño que quiere ocupar, el nodo raíz del árbol de IU mide sus elementos secundarios y reenvía las mismas restricciones a su primer elemento secundario.
2. Si el elemento secundario es un modificador que no afecta la medición, reenvía las restricciones al siguiente modificador. Las restricciones se pasan por la cadena de modificadores sin modificaciones, a menos que se alcance un modificador que afecte la medición. Luego, se cambia el tamaño de las restricciones según corresponda.
3. Una vez que se alcanza un nodo que no tiene ningún elemento secundario (denominado "nodo de hoja"), decide su tamaño en función de las restricciones que se pasaron y muestra este tamaño resuelto a su elemento superior.
4. El elemento superior adapta sus restricciones en función de las mediciones de este elemento secundario y llama a su próximo elemento secundario con estas restricciones ajustadas.
5. Una vez que se miden todos los elementos secundarios de un elemento superior, el nodo superior decide su propio tamaño y se lo comunica a su propio superior.
6. De esta manera, todo el árbol se recorre primero en profundidad. Con el tiempo, todos los nodos deciden sus tamaños y se completa el paso de medición.

Para ver un ejemplo detallado, consulta el video Restricciones y orden de los modificadores.

Modificadores que afectan las restricciones

En la sección anterior, aprendiste que algunos modificadores pueden afectar el tamaño de la restricción. En las siguientes secciones, se describen los modificadores específicos que afectan las restricciones.

Modificador size

El modificador size declara el tamaño preferido del contenido.

Por ejemplo, el siguiente árbol de IU debe renderizarse en un contenedor de 300dp de 200dp. Las restricciones están delimitadas, lo que permite anchos entre 100dp y 300dp, y alturas entre 100dp y 200dp:

El modificador size adapta las restricciones entrantes para que coincidan con el valor que se le pasa. En este ejemplo, el valor es 150dp:

Si el ancho y la altura son menores que el límite de restricción más pequeño o mayores que el límite más grande, el modificador coincide con las restricciones pasadas tan cerca como sea posible y cumple con las restricciones pasadas:

Ten en cuenta que encadenar varios modificadores size no funciona. El primer modificador size establece las restricciones mínima y máxima en un valor fijo. Incluso si el segundo modificador de tamaño solicita un tamaño más pequeño o más grande, debe cumplir con los límites exactos que se pasaron, por lo que no anulará esos valores:

Modificador requiredSize

Usa el modificador requiredSize en lugar de size si necesitas que tu nodo anule las restricciones entrantes. El modificador requiredSize reemplaza las restricciones entrantes y pasa el tamaño que especifiques como límites exactos.

Cuando el tamaño se pasa de nuevo al árbol, el nodo secundario se centra en el espacio disponible:

Modificadores width y height

El modificador size adapta el ancho y la altura de las restricciones. Con el modificador width, puedes establecer un ancho fijo, pero no definir la altura. De manera similar, con el modificador height, puedes establecer una altura fija, pero no definir el ancho:

Modificador sizeIn

El modificador sizeIn te permite establecer restricciones mínimas y máximas exactas para el ancho y la altura. Usa el modificador sizeIn si necesitas un control detallado sobre las restricciones.

Ejemplos

En esta sección, se muestra y explica el resultado de varios fragmentos de código con modificadores encadenados.

Image(
    painterResource(R.drawable.hero),
    contentDescription = null,
    Modifier
        .fillMaxSize()
        .size(50.dp)
)
ConstraintsModifiersSnippets.kt

Este fragmento produce el siguiente resultado:

• El modificador fillMaxSize cambia las restricciones para establecer el ancho y la altura mínimos en el valor máximo: 300dp de ancho y 200dp de alto.
• Aunque el modificador size quiere usar un tamaño de 50dp, debe cumplir con las restricciones mínimas entrantes. Por lo tanto, el modificador size también generará los límites de restricción exactos de 300 por 200 e ignorará efectivamente el valor proporcionado en el modificador size.
• Image sigue estos límites e informa un tamaño de 300 por 200, que se pasa por todo el árbol.

Image(
    painterResource(R.drawable.hero),
    contentDescription = null,
    Modifier
        .fillMaxSize()
        .wrapContentSize()
        .size(50.dp)
)
ConstraintsModifiersSnippets.kt

Este fragmento produce el siguiente resultado:

• El modificador fillMaxSize adapta las restricciones para establecer el ancho y la altura mínimos al valor máximo: 300dp de ancho y 200dp de alto.
• El modificador wrapContentSize restablece las restricciones mínimas. Por lo tanto, mientras fillMaxSize dio como resultado restricciones fijas, wrapContentSize lo restablece a las restricciones delimitadas. El siguiente nodo ahora puede volver a ocupar todo el espacio o ser más pequeño que todo el espacio.
• El modificador size establece las restricciones en los límites mínimo y máximo de 50.
• Image se resuelve en un tamaño de 50 por 50, y el modificador size lo reenvía.
• El modificador wrapContentSize tiene una propiedad especial. Toma a su elemento secundario y lo coloca en el centro de los límites mínimos disponibles que se le pasaron. El tamaño que comunica a sus elementos superiores es así igual a los límites mínimos que se pasaron.

Si combinas solo tres modificadores, puedes definir un tamaño para el elemento componible y centrarlo en su elemento superior.

Image(
    painterResource(R.drawable.hero),
    contentDescription = null,
    Modifier
        .clip(CircleShape)
        .padding(10.dp)
        .size(100.dp)
)
ConstraintsModifiersSnippets.kt

Este fragmento produce el siguiente resultado:

• El modificador clip no cambia las restricciones.
  • El modificador padding reduce las restricciones máximas.
  • El modificador size establece todas las restricciones en 100dp.
  • Image cumple con esas restricciones e informa un tamaño de 100 por 100dp.
  • El modificador padding agrega 10dp en todos los tamaños, por lo que aumenta el ancho y la altura informados en 20dp.
  • Ahora, en la fase de dibujo, el modificador clip actúa sobre un lienzo de 120 de 120dp. Por lo tanto, crea una máscara circular de ese tamaño.
  • Luego, el modificador padding inserta su contenido en 10dp en todos los tamaños, por lo que reduce el tamaño del lienzo a 100 en 100dp.
  • El Image se dibuja en ese lienzo. La imagen se recorta en función del círculo original de 120dp, por lo que el resultado no es redondo.