Skip to content

Commit 10dac65

Browse files
committed
docs: add background option
1 parent 5a14740 commit 10dac65

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,17 @@ http://localhost:8000/image-transform/width=250,quality=80,format=webp/foo/bar/e
6262
> [!NOTE]
6363
> The options are separated by commas and their values are appended with equal signs. The order of options does not matter.
6464
65-
| Option | Description | Type | Description / Possible Values |
66-
| ---------- | ------------------------------------ | ------- | ------------------------------------------------------------------------------- |
67-
| `width` | Set the width of the image. | integer | Values greater than the original width will be ignored. |
68-
| `height` | Set the height of the image. | integer | Values greater than the original height will be ignored. |
69-
| `quality` | Set the quality of the image. | integer | `0` to `100` |
70-
| `format` | Set the format of the image. | string | Supported formats: `jpg`, `jpeg`, `png`, `gif`, `webp`. |
71-
| `blur` | Set the blur level of the image. | integer | `0` to `100` |
72-
| `contrast` | Set the contrast level of the image. | integer | `-100` to `100` |
73-
| `flip` | Flip the image. | string | `h`(horizontal), `v`(vertical), `hv`(horizontal and vertical) |
74-
| `version` | Version number of the image. | integer | Any positive integer. More info in the [Image Caching](#image-caching) section. |
65+
| Option | Description | Type | Description / Possible Values |
66+
| ------------ | ------------------------------------- | ------- | --------------------------------------------------------------------------------------- |
67+
| `width` | Set the width of the image. | integer | Values greater than the original width will be ignored. |
68+
| `height` | Set the height of the image. | integer | Values greater than the original height will be ignored. |
69+
| `quality` | Set the quality of the image. | integer | `0` to `100` |
70+
| `format` | Set the format of the image. | string | Supported formats: `jpg`, `jpeg`, `png`, `gif`, `webp`. |
71+
| `blur` | Set the blur level of the image. | integer | `0` to `100` |
72+
| `contrast` | Set the contrast level of the image. | integer | `-100` to `100` |
73+
| `background` | Set the background color of the image | string | Any valid HEX color value (without a leading `#`). Only supported for the `png` format. |
74+
| `flip` | Flip the image. | string | `h`(horizontal), `v`(vertical), `hv`(horizontal and vertical) |
75+
| `version` | Version number of the image. | integer | Any positive integer. More info in the [Image Caching](#image-caching) section. |
7576

7677
> [!CAUTION]
7778
> The `blur` option is a resource-intensive operation and may cause memory issues if the image is too large. It is recommended to use this option with caution, or disable it in the config.

0 commit comments

Comments
 (0)