Skip to content

Commit 5f0c942

Browse files
committed
docs: List Group Item to prop
1 parent 3d47ef4 commit 5f0c942

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

docs/components/ListGroup.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ actionable items. see below).
8282
## Actionable list group items
8383

8484
Turn a `<b-list-group-item>` into an actionable _link_ (`<a href="...">`) by specifying either an
85-
`href` prop or ~~[router-link](/docs/reference/router-links) `to`~~ prop.
85+
`href` prop or ~~[router-link](/docs/reference/router-links)~~ `to` prop.
8686

8787
<ClientOnly>
8888
<b-card class="bd-example">
@@ -130,7 +130,7 @@ Or if you prefer `<button>` elements over links, set the `button` prop to `true`
130130

131131
- When the prop `button` is `true`, all [link related props](/docs/components/link) (other than
132132
`active`) and the `tag` prop will have no effect.
133-
- When `href` or ~~`to`~~ are set, the `tag` prop has no effect.
133+
- When `href` or `to` are set, the `tag` prop has no effect.
134134

135135
~~Refer to the [Router support](/docs/reference/router-links) reference page for router-link specific
136136
props.~~
@@ -571,16 +571,17 @@ help of [flexbox utility classes](/docs/reference/utility-classes).
571571

572572
#### Properties
573573

574-
| Property | Type | Default | Description |
575-
| ---------- | --------- | --------- | ------------------------------------------------------------------------------------------------------------------- |
576-
| `action` | `Boolean` | `false` | When set, give the item the appearance of having an action. Not needed when props 'to', 'href' or 'button' are used |
577-
| `active` | `Boolean` | `false` | When set to `true`, places the component in the active state with active styling |
578-
| `button` | `Boolean` | `false` | When true renders the list-group-item as a button element |
579-
| `disabled` | `Boolean` | `false` | When set to `true`, disables the component's functionality and places it in a disabled state |
580-
| `href` | `String` | | Denotes the target URL of the link for standard a links |
581-
| `tag` | `String` | `'div'` | Specify the HTML tag to render instead of the default tag |
582-
| `target` | `String` | `'_self'` | Sets the `target` attribute on the rendered link |
583-
| `variant` | `String` | | Applies one of the Bootstrap theme color variants to the component |
574+
| Property | Type | Default | Description |
575+
| ---------- | -------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
576+
| `action` | `Boolean` | `false` | When set, give the item the appearance of having an action. Not needed when props 'to', 'href' or 'button' are used |
577+
| `active` | `Boolean` | `false` | When set to `true`, places the component in the active state with active styling |
578+
| `button` | `Boolean` | `false` | When true renders the list-group-item as a button element |
579+
| `disabled` | `Boolean` | `false` | When set to `true`, disables the component's functionality and places it in a disabled state |
580+
| `href` | `String` | | Denotes the target URL of the link for standard a links |
581+
| `tag` | `String` | `'div'` | Specify the HTML tag to render instead of the default tag |
582+
| `target` | `String` | `'_self'` | Sets the `target` attribute on the rendered link |
583+
| `to` | `Object` or `String` | `_self` | `<router-link>` prop: Denotes the target route of the link. When clicked, the value of the to prop will be passed to `router.push()` internally, so the value can be either a string or a Location descriptor object |
584+
| `variant` | `String` | | Applies one of the Bootstrap theme color variants to the component |
584585

585586
#### Slots
586587

docs/reference/parityList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1258,7 +1258,7 @@ This is a <Badge type="warning" text="non-standard" /> component.
12581258
| `router-component-name` | ![](https://us-central1-progress-markdown.cloudfunctions.net/progress/0) Completed | |
12591259
| `tag` | ![](https://us-central1-progress-markdown.cloudfunctions.net/progress/100) Completed | |
12601260
| `target` | ![](https://us-central1-progress-markdown.cloudfunctions.net/progress/100) Completed | |
1261-
| `to` | ![](https://us-central1-progress-markdown.cloudfunctions.net/progress/0) Completed | |
1261+
| `to` | ![](https://us-central1-progress-markdown.cloudfunctions.net/progress/100) Completed | |
12621262
| `variant` | ![](https://us-central1-progress-markdown.cloudfunctions.net/progress/100) Completed | |
12631263

12641264
### Slots

0 commit comments

Comments
 (0)