Skip to content

Commit 1b03e70

Browse files
committed
CheckboxInput and PasswordInput docs update
1 parent 6cf82ce commit 1b03e70

File tree

3 files changed

+17
-11
lines changed

3 files changed

+17
-11
lines changed

blazorbootstrap/Components/Form/CheckboxInput/CheckboxInput.razor.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ protected override void OnInitialized()
2020
}
2121

2222
/// <summary>
23-
/// Disables number input.
23+
/// Disables checkbox input.
2424
/// </summary>
2525
public void Disable() => Disabled = true;
2626

2727
/// <summary>
28-
/// Enables number input.
28+
/// Enables checkbox input.
2929
/// </summary>
3030
public void Enable() => Disabled = false;
3131

@@ -78,7 +78,7 @@ private async Task OnChange(ChangeEventArgs e)
7878
public bool Value { get; set; }
7979

8080
/// <summary>
81-
/// This event fired on every user keystroke that changes the NumberInput value.
81+
/// This event fires when the <see cref="CheckboxInput" /> value changes.
8282
/// </summary>
8383
[Parameter]
8484
public EventCallback<bool> ValueChanged { get; set; }

docs/docs/04-forms/checkbox-input.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,28 @@ The Blazor Bootstrap `CheckboxInput` component is constructed using an HTML inpu
2020
## Parameters
2121
| Name | Type | Default | Required | Description | Added Version |
2222
|:--|:--|:--|:--|:--|:--|
23+
| Disabled | bool | false | | Gets or sets the disabled state. | 3.3.0 |
24+
| Label | string | null | | Gets or sets the label. | 3.3.0 |
25+
| Value | bool | false | ✔️ | Gets or sets the value. | 3.3.0 |
2326

2427
## Methods
2528

2629
| Name | Returns | Description | Added Version |
2730
|:--|:--|:--|:--|
28-
| Disable() | void | Disables autocomplete. | 3.3.0 |
29-
| Enable() | void | Enables autocomplete. | 3.3.0 |
31+
| Disable() | void | Disables checkbox input. | 3.3.0 |
32+
| Enable() | void | Enables checkbox input. | 3.3.0 |
3033

3134
## Events
3235

3336
| Name | Description | Added Version |
3437
|:--|:--|:--|
35-
| ValueChanged | This event fires on every user keystroke that changes the textbox value. | 3.3.0 |
38+
| ValueChanged | This event fires when the `CheckboxInput` value changes. | 3.3.0 |
3639

3740
## Examples
3841

3942
### Basic Usage
4043

41-
<img src="" alt="Blazor Bootstrap Checkbox Input Component - Basic Usage" />
44+
<img src="https://i.imgur.com/kqSggFK.png" alt="Blazor Bootstrap Checkbox Input Component - Basic Usage" />
4245

4346
```cshtml {} showLineNumbers
4447
<CheckboxInput Label="Default checkbox" @bind-Value="isChecked" />
@@ -131,7 +134,7 @@ Do not use both the `Disabled` parameter and `Enable()` & `Disable()` methods.
131134

132135
### Events: ValueChanged
133136

134-
This event fires when the `CheckboxInput` value changes, but not on every keystroke.
137+
This event fires when the `CheckboxInput` value change.
135138

136139
<img src="https://i.imgur.com/Vrztsvo.png" alt="Blazor Bootstrap Checkbox Input Component - Events: ValueChanged" />
137140

docs/docs/04-forms/password-input.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,22 @@ The Blazor Bootstrap `PasswordInput` component is constructed using an HTML inpu
2020
## Parameters
2121
| Name | Type | Default | Required | Description | Added Version |
2222
|:--|:--|:--|:--|:--|:--|
23+
| Disabled | bool | false | | Gets or sets the disabled state. | 3.3.0 |
24+
| ShowHidePasswordButtonCssClass | string | `btn border-top border-end border-bottom border border-start-0` | | Gets or sets the show/hide password button CSS class. | 3.3.0 |
25+
| Value | string | null | ✔️ | Gets or sets the value. | 3.3.0 |
2326

2427
## Methods
2528

2629
| Name | Returns | Description | Added Version |
2730
|:--|:--|:--|:--|
28-
| Disable() | void | Disables autocomplete. | 3.3.0 |
29-
| Enable() | void | Enables autocomplete. | 3.3.0 |
31+
| Disable() | void | Disables checkbox input. | 3.3.0 |
32+
| Enable() | void | Enables checkbox input. | 3.3.0 |
3033

3134
## Events
3235

3336
| Name | Description | Added Version |
3437
|:--|:--|:--|
35-
| ValueChanged | This event fires on every user keystroke that changes the textbox value. | 3.3.0 |
38+
| ValueChanged | This event is fired when the `PasswordInput` value changes. | 3.3.0 |
3639

3740
## Examples
3841

0 commit comments

Comments
 (0)