Skip to content

Commit 2ff51d9

Browse files
Youssef1313Youssef1313
committed
docs: Improve docs
1 parent 7ad1199 commit 2ff51d9

File tree

2 files changed

+97
-97
lines changed

2 files changed

+97
-97
lines changed

‎doc/uno-resizetizer-properties.md

+34-34
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,56 @@ uid: Overview.Uno.Resizetizer.Properties
44

55
# Resizetizer Properties
66

7-
Resizetizer has support for three items they are:
7+
Resizetizer has support for the following three items:
88

9-
* UnoIcon
10-
* UnoImage
11-
* UnoSplashScreen
9+
* `UnoIcon`
10+
* `UnoImage`
11+
* `UnoSplashScreen`
1212

13-
Each of these items have properties that allow you to influence the behavior of the generated asset, at this page you can find all available properties for each item their meaning.
13+
Each of these items has properties that allow you to influence the behavior of the generated asset. In this page, you can find all available properties for each item and their meanings.
1414

1515
## Global Properties
1616

1717
Properties that can be used across all items
1818

1919
| Property Name | Description |
20-
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
21-
| BaseSize | Used to specify the size that will be used as a basement for the resize operations. e.g.: `BaseSize="48,48"` |
22-
| Link | Used to specify a custom path for your image, this path should be used inside your application when you want to reference the image |
23-
| Resize | Boolean value to say if the asset should Resized or not. By default just vectors asset are resized by default |
24-
| TintColor | Color that will be used to tint the image during the resize phase. You can use a Hex value or a named value like `Fuchsia` |
25-
| Color | Color that will be used as a background color |
20+
|---------------|-------------------------------------------------------------------------------------------------------------------------------------|
21+
| `BaseSize` | Used to specify the size that will be used as a basement for the resize operations. e.g.: `BaseSize="48,48"` |
22+
| `Link` | Used to specify a custom path for your image, this path should be used inside your application when you want to reference the image |
23+
| `Resize` | Boolean value to say if the asset should Resized or not. By default just vectors asset are resized by default |
24+
| `TintColor` | Color that will be used to tint the image during the resize phase. You can use a Hex value or a named value like `Fuchsia` |
25+
| `Color` | Color that will be used as a background color |
2626

2727
## UnoIcon
2828

29-
| Property Name | Description |
30-
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
31-
| Include | Used to insert the path of the Background image. |
32-
| ForegroundFile | Used to insert the path of the Foreground image |
33-
| ForegroundScale | Used to rescale the Foreground image, in order to fit on the app icon, it's a percentage value so `0.33` will be translatated as 33%. |
34-
| AndroidForegroundScale | The same as ForegroundScale, but the value will be applied just for Android. |
35-
| WasmForegroundScale | The same as ForegroundScale, but the value will be applied just for Wasm |
36-
| WindowsForegroundScale | The same as ForegroundScale, but the value will be applied just for Windows |
37-
| IOSForegroundScale | The same as ForegroundScale, but the value will be applied just for iOS |
38-
| SkiaForegroundScale | The same as ForegroundScale, but the value will be applied just for Skia targets |
29+
| Property Name | Description |
30+
|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
31+
| `Include` | Used to insert the path of the Background image. |
32+
| `ForegroundFile` | Used to insert the path of the Foreground image |
33+
| `ForegroundScale` | Used to rescale the Foreground image, in order to fit on the app icon, it's a percentage value so `0.33` will be translated as 33%. |
34+
| `AndroidForegroundScale` | The same as ForegroundScale, but the value will be applied just for Android. |
35+
| `WasmForegroundScale` | The same as ForegroundScale, but the value will be applied just for Wasm |
36+
| `WindowsForegroundScale` | The same as ForegroundScale, but the value will be applied just for Windows |
37+
| `IOSForegroundScale` | The same as ForegroundScale, but the value will be applied just for iOS |
38+
| `SkiaForegroundScale` | The same as ForegroundScale, but the value will be applied just for Skia targets |
3939

4040
> [!NOTE]
41-
> The PlatformsForegroundScale (AndroidForegroundScale, WasmForegroundScale, etc) will override the global ForegroundScale value.
41+
> The `<PLATFORM>ForegroundScale` (`AndroidForegroundScale`, `WasmForegroundScale`, etc) will override the global `ForegroundScale` value.
4242
4343
## UnoImage
4444

45-
| Property Name | Description |
46-
| ------------- | ----------- |
47-
| Include | Used to insert the path of the image asset, could be a `png` or `svg`. |
45+
| Property Name | Description |
46+
|---------------|------------------------------------------------------------------------|
47+
| `Include` | Used to insert the path of the image asset, could be a `png` or `svg`. |
4848

4949
## UnoSplashScreen
5050

51-
| Property Name | Description |
52-
| ------------- | ----------- |
53-
| Include | Used to insert the path of the image asset, could be a `png` or `svg`. |
54-
| Scale | Used to scale the image that will be used as SplashScreen. This property will be override by any platform specific scale. |
55-
| AndroidScale | Used to scale the image that will be used as SplashScreen on Android platform. |
56-
| IOSScale | Used to scale the image that will be used as SplashScreen on iOS platform. |
57-
| WindowsScale | Used to scale the image that will be used as SplashScreen on Windows platform. |
58-
| WasmScale | Used to scale the image that will be used as SplashScreen on Wasm. |
59-
| SkiaScale | Used to scale the image that will be used as SplashScreen on Skia targets (GTK and WPF). |
51+
| Property Name | Description |
52+
|----------------|---------------------------------------------------------------------------------------------------------------------------|
53+
| `Include` | Used to insert the path of the image asset, could be a `png` or `svg`. |
54+
| `Scale` | Used to scale the image that will be used as SplashScreen. This property will be overridden by any platform specific scale. |
55+
| `AndroidScale` | Used to scale the image that will be used as SplashScreen on Android platform. |
56+
| `IOSScale` | Used to scale the image that will be used as SplashScreen on iOS platform. |
57+
| `WindowsScale` | Used to scale the image that will be used as SplashScreen on Windows platform. |
58+
| `WasmScale` | Used to scale the image that will be used as SplashScreen on Wasm. |
59+
| `SkiaScale` | Used to scale the image that will be used as SplashScreen on Skia targets (GTK and WPF). |

0 commit comments

Comments
 (0)