From 3c1f1871cf4145bfae47cd793635d44148368227 Mon Sep 17 00:00:00 2001 From: guillempages Date: Tue, 13 Aug 2024 09:44:46 +0200 Subject: [PATCH] [online_image] Add placeholder documentation (#4102) --- components/online_image.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/components/online_image.rst b/components/online_image.rst index 7ac693fd5..a69fcb68d 100644 --- a/components/online_image.rst +++ b/components/online_image.rst @@ -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 ` 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