[online_image] Add placeholder documentation (#4102)

This commit is contained in:
guillempages 2024-08-13 09:44:46 +02:00 committed by GitHub
parent bbc3912902
commit 3c1f1871cf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -37,6 +37,8 @@ Configuration variables
- ``PNG``: The image on the server is encoded in PNG format.
- **resize** (*Optional*, string): If set, this will resize the image to fit inside the given dimensions ``WIDTHxHEIGHT``
and preserve the aspect ratio.
- **placeholder** (**Optional**, :ref:`config-id`): ID of an :doc:`Image </components/image>` to display while the downloaded image is not yet ready.
This placeholder image will **not** be resized; regardless of the ``resize`` option value for the ``online_image``.
- **type** (*Optional*): Specifies how to encode image internally. Defaults to ``BINARY``.
- ``BINARY``: Two colors, suitable for 1 color displays or 2 color image in color displays. Uses 1 bit