Skip to content

Commit

Permalink
[online_image] Binary BMP support (#4600)
Browse files Browse the repository at this point in the history
  • Loading branch information
jesserockz authored Jan 23, 2025
1 parent bbde3c6 commit 88d2adb
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion components/online_image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ With this component you can define images that will be downloaded, decoded and d

.. note::

Currently only images in PNG format are supported.
Current supported formats:

- PNG

- BMP images, currently only binary uncompressed images are supported

.. warning::

Expand All @@ -35,6 +39,7 @@ Configuration variables
- **format** (**Required**): The format that the image is encoded with.

- ``PNG``: The image on the server is encoded in PNG format.
- ``BMP``: The image on the server is encoded in BMP 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.
Expand Down

0 comments on commit 88d2adb

Please sign in to comment.