Skip to content

Commit 985eb69

Browse files
authored
docs(QRCode): Improve Size and border Width documentation (#3023)
1 parent aec7bf4 commit 985eb69

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

components/barcodes/qrcode/overview.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,16 @@ The generated image from the component is a machine-readable label that contains
1616

1717
## Creating Blazor QRCode
1818

19-
1. Add the `TelerikQRCode` tag to add the component to your razor page.
19+
1. Use the `TelerikQRCode` tag to add the component to your razor page.
20+
1. Set the `Value` parameter, according to the [encoding recommendations](slug:qrcode-encoding).
21+
1. Set the `Size` parameter, depending on the expected scanning distance and the required data capacity.
22+
1. (optional) Define a [QRCode overlay type](slug:qrcode-qr-code-types)).
2023

21-
1. Set the `Value` property.
22-
23-
1. Set its `Size` property.
24-
25-
1. Optionally, choose a `QRCode Type` (one of the [types we support](slug:qrcode-qr-code-types)).
26-
27-
>caption A basic configuration of the Telerik QRCode
24+
>caption Basic Telerik QRCode
2825
2926
````RAZOR
30-
<TelerikQRCode Size="200px"
31-
Value="https://docs.telerik.com/blazor-ui/introduction">
27+
<TelerikQRCode Value="https://www.telerik.com/blazor-ui"
28+
Size="200px">
3229
</TelerikQRCode>
3330
````
3431

@@ -58,7 +55,7 @@ The Blazor Barcode provides various parameters that allow you to configure the c
5855
| `QRCodeEncoding` | `enum` | The encoding mode used to encode the value. |
5956
| `QRCodeErrorCorrection` | `enum` | The error correction level used to encode the value. |
6057
| `Value` | `string` | Defines the initial value of the QRCode. |
61-
| `Size` | `string` | Specifies the size (`Width` and `Height`) of a QR code in pixels (i.e. "200px") as the QRCode is a square. You can read more details for the dimension properties in the [Dimensions article](slug:common-features/dimensions). Setting both `Size` and `Width` and/or `Height` will throw an error. Setting different values to `Width` and `Height` will also cause an issue. |
58+
| `Size` | `string` | Specifies the size (`Width` and `Height`) of a QR code in pixels (i.e. "200px") as the QRCode is a square. You can read more details for the dimension properties in the [Dimensions article](slug:common-features/dimensions). Setting both `Size` and `Width` and/or `Height` will throw an error. Setting different values to `Width` and `Height` will also cause an issue. To set an optimal `Size`, consider the expected scanning distance and data capacity. |
6259
| `Width` | `string` | Sets the width of the QRCode. If `Height` is set and the `Size` property is not set, the same value as `Width` should be set to `Height`. |
6360
| `Height` | `string` | Sets the height of the QRCode. If `Height` is set and the `Size` property is not set, the same value as `Height` should be set to `Width`. |
6461
| `Class` | `string` | The CSS class that will be rendered on the main wrapping element of the QRCode component. |
@@ -84,7 +81,7 @@ The nested `QRCodeBorder` tag exposes parameters that enable you to customize th
8481
| Parameter | Type | Description |
8582
| ----------- | ----------- | ----------- |
8683
| `Color` | `string` | The color of the border. Accepts a valid CSS color string, including HEX and RGB. |
87-
| `Width` | `double` | The width of the border in pixels. By default the border width is set to zero which means that the border will not be visible. |
84+
| `Width` | `double` | The width of the border in pixels. The default value is `0` and the border is not visible. The QR Code border is part of the component `Size`. Thus, a wider border may require a larger `Size`. |
8885

8986
## Next Steps
9087

0 commit comments

Comments
 (0)