docs(b-navbar): specify support of sidebar + array (#5885)

Hiws · jacobmllr95 · web-flow · commit 21e098001e74 · 2020-10-12T14:30:31.000+02:00
* specify support of sidebar + array

* update package.json

* Update navbar-toggle.js

* Update README.md

Co-authored-by: Jacob Müller &lt;jacob.mueller.elz@gmail.com&gt;
diff --git a/src/components/navbar/README.md b/src/components/navbar/README.md
@@ -292,8 +292,10 @@ Internally, `<b-navbar-toggle>` uses the [`v-b-toggle` directive](/docs/directiv
 `<b-navbar-toggle>` renders the default Bootstrap v4 _hamburger_ (which is a background SVG image).
 You can supply your own content (such as an icon) via the optionally scoped `default` slot. The
 default slot scope contains the property `expanded`, which will be `true` when the collapse is
-expanded, or `false` when the collapse is collapsed. You can use this to swap the toggle content
-based on the collapse state:
+expanded, or `false` when the collapse is collapsed.
+
+Note that the `expanded` scope property only works when supplying the `target` prop as a `string`,
+and not an `array`.
 
 ```html
 <template>
diff --git a/src/components/navbar/navbar-toggle.js b/src/components/navbar/navbar-toggle.js
@@ -22,7 +22,7 @@ export const BNavbarToggle = /*#__PURE__*/ Vue.extend({
       default: () => getComponentConfig(NAME_NAVBAR_TOGGLE, 'label')
     },
     target: {
-      type: String,
+      type: [Array, String],
       required: true
     },
     disabled: {
diff --git a/src/components/navbar/package.json b/src/components/navbar/package.json
@@ -71,7 +71,7 @@
         "props": [
           {
             "prop": "target",
-            "description": "ID of the collapse the toggle controls"
+            "description": "ID (or array of IDs) of the collapse/sidebar components that should be toggled"
           },
           {
             "prop": "label",

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@`
`71`	`71`	`"props": [`
`72`	`72`	`{`
`73`	`73`	`"prop": "target",`
`74`		`- "description": "ID of the collapse the toggle controls"`
	`74`	`+ "description": "ID (or array of IDs) of the collapse/sidebar components that should be toggled"`
`75`	`75`	`},`
`76`	`76`	`{`
`77`	`77`	`"prop": "label",`