[3.7.0] Documentation for the Signature component #1187
Conversation
|
|
||
| | Parameter | Type and Default Value | Description | | ||
| | --- | --- | --- | | ||
| | `AriaDescribedBy` | `string` | Maps to the `area-describedby` attribute. Use this parameter to establish a relationship between widgets or groups and the text that describes them. | |
There was a problem hiding this comment.
Start directly with what the parameter represents. The exception are bool parameters. By the way, what is "groups"?
| | `AriaDescribedBy` | `string` | Maps to the `area-describedby` attribute. Use this parameter to establish a relationship between widgets or groups and the text that describes them. | | |
| | `AriaDescribedBy` | `string` | The `area-describedby` attribute. Use this parameter to establish a relationship between widgets or groups and the text that describes them. | |
There was a problem hiding this comment.
Quite honestly, I have no idea, I did not understand what it does exactly, read that from the https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-describedby#:~:text=The%20aria%2Ddescribedby%20attribute%20lists,not%20limited%20to%20form%20controls.
There was a problem hiding this comment.
In such cases, it may be better to just link the generic external docs and not deal with unclear content on our side. We will assume that whoever wants to use the parameter will know what it does.
components/signature/overview.md
Outdated
| | `PopupScale` | `double` | The `Width` and `Height` of the component will be multiplied by the value of the `PopupScale` when maximizing (`Maximizable="true"`) the Blazor Signature. | | ||
| | `ReadOnly` | `bool` | Maps to the `readonly` attribute. Use this parameter to put the Signature in read-only state. | | ||
| | `Smooth` | `bool` | Use this parameter to smoothen the signature line. | | ||
| | `StrokeWidth` | `double?` | Set the width of the signature line. | |
There was a problem hiding this comment.
What is this signature line?
There was a problem hiding this comment.
when drawing a signature a line is rendered. Ideally, I would like to call it a stroke, but we can't explain a parameter by its name. What if people are not aware of what a stroke is?
I agree it's not optimal, but I could not come up with a better word.
There was a problem hiding this comment.
I see. In this case consider "the drawn lines' thickness in pixels"
dimodi
left a comment
dimodi
left a comment
There was a problem hiding this comment.
- Explain the purpose of the two parts of the component.
- Include SignalR message size change in the basic steps.
- Some suggestions are applicable for other places in the content as well (for example parameter descriptions, usage of floats).
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Related to https://github.com/telerik/blazor/issues/5042