8000 chore(docs): add missing documentation for slots · bootstrap-vue/bootstrap-vue@13c25df · GitHub
[go: up one dir, main page]
Skip to content

Commit 13c25df

Browse files
jacobmllr95jacobmllr95
committed
chore(docs): add missing documentation for slots
1 parent 7b9da13 commit 13c25df

File tree

32 files changed

+544
-129
lines changed

32 files changed

+544
-129
lines changed

‎src/components/alert/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@
6060
{
6161
"name": "dismiss",
6262
"description": "Content for the dismiss button"
63+
},
64+
{
65+
"name": "default",
66+
"description": "Content to place in the alert"
6367
}
6468
]
6569
}

‎src/components/aspect/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@
1313
"prop": "aspect",
1414
"description": "Aspect as a width to height numeric ratio (such as `1.5`) or `width:height` string (such as '16:9')"
1515
}
16+
],
17+
"slots": [
18+
{
19+
"name": "default",
20+
"description": "Content to place in the aspect"
21+
}
1622
]
1723
}
1824
]

‎src/components/avatar/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,12 @@
136136
"prop": "variant",
137137
"description": "Applies one of the Bootstrap theme color variants to all child avatars"
138138
}
139+
],
140+
"slots": [
141+
{
142+
"name": "default",
143+
"description": "Content (avatars) to place in the avatar group"
144+
}
139145
]
140146
}
141147
]

‎src/components/badge/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616
"prop": "variant",
1717
"description": "Applies one of the Bootstrap theme color variants to the component"
1818
}
19+
],
20+
"slots": [
21+
{
22+
"name": "default",
23+
"description": "Content to place in the badge"
24+
}
1925
]
2026
}
2127
]

‎src/components/breadcrumb/package.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
"prop": "items",
1313
"description": "Array of breadcrumb items to render"
1414
}
15+
],
16+
"slots": [
17+
{
18+
"name": "default",
19+
"description": "Content (breadcrumb items) to place in the breadcrumb"
20+
}
1521
]
1622
},
1723
{
@@ -42,6 +48,12 @@
4248
}
4349
]
4450
}
51+
],
52+
"slots": [
53+
{
54+
"name": "default",
55+
"description": "Content to place in the breadcrumb item"
56+
}
4557
]
4658
}
4759
]

‎src/components/button-group/package.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,20 @@
88
{
99
"component": "BButtonGroup",
1010
"description": "Group a series of buttons together on a single line",
11+
"aliases": [
12+
"BBtnGroup"
13+
],
1114
"props": [
1215
{
1316
"prop": "vertical",
1417
"description": "When set, rendered the button group in vertical mode"
1518
}
1619
],
17-
"aliases": [
18-
"BBtnGroup"
20+
"slots": [
21+
{
22+
"name": "default",
23+
"description": "Content (buttons) to place in the button group"
24+
}
1925
]
2026
}
2127
]

‎src/components/button-toolbar/package.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
"components": [
88
{
99
"component": "BButtonToolbar",
10-
"description": "Group a series of <b-button-group> and/or <b-input-group> together on a single line, with optional keyboard navigation.",
10+
"aliases": [
11+
"BBtnToolbar"
12+
],
1113
"props": [
1214
{
1315
"prop": "justify",
@@ -18,8 +20,11 @@
1820
"description": "When set, enabled keyboard navigation mode for the toolbar. Do not set this prop when the toolbar has inputs"
1921
}
2022
],
21-
"aliases": [
22-
"BBtnToolbar"
23+
"slots": [
24+
{
25+
"name": "default",
26+
"description": "Content to place in the button toolbar"
27+
}
2328
]
2429
}
2530
]

‎src/components/button/package.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@
5252
}
5353
]
5454
}
55+
],
56+
"slots": [
57+
{
58+
"name": "default",
59+
"description": "Content to place in the button"
60+
}
5561
]
5662
},
5763
{
@@ -86,6 +92,12 @@
8692
}
8793
]
8894
}
95+
],
96+
"slots": [
97+
{
98+
"name": "default",
99+
"description": "Content to place in the button. Overrides the `content` prop"
100+
}
89101
]
90102
}
91103
]

‎src/components/card/package.json

Lines changed: 63 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,28 +63,70 @@
6363
],
6464
"slots": [
6565
{
66-
"name": "header",
67-
"description": "For custom rendering of header content"
66+
"name": "default",
67+
"description": "Content to place in the card"
6868
},
6969
{
7070
"name": "footer",
7171
"description": "For custom rendering of footer content"
72+
},
73+
{
74+
"name": "header",
75+
"description": "For custom rendering of header content"
76+
}
77+
]
78+
},
79+
{
80+
"component": "BCardHeader",
81+
"slots": [
82+
{
83+
"name": "default",
84+
"description": "Content to place in the card header"
85+
}
86+
]
87+
},
88+
{
89+
"component": "BCardFooter",
90+
"slots": [
91+
{
92+
"name": "default",
93+
"description": "Content to place in the card footer"
7294
}
7395
]
7496
},
75-
"BCardHeader",
76-
"BCardFooter",
7797
{
7898
"component": "BCardBody",
7999
"props": [
80100
{
81101
"prop": "overlay",
82102
"description": "When set, will overlay the card body on top of the image (if the card has an image)"
83103
}
104+
],
105+
"slots": [
106+
{
107+
"name": "default",
108+
"description": "Content to place in the card body"
109+
}
110+
]
111+
},
112+
{
113+
"component": "BCardTitle",
114+
"slots": [
115+
{
116+
"name": "default",
117+
"description": "Content to place in the card title"
118+
}
119+
]
120+
},
121+
{
122+
"component": "BCardSubTitle",
123+
"slots": [
124+
{
125+
"name": "default",
126+
"description": "Content to place in the card sub-title"
127+
}
84128
]
85129
},
86-
"BCardTitle",
87-
"BCardSubTitle",
88130
{
89131
"component": "BCardImg",
90132
"props": [
@@ -187,7 +229,15 @@
187229
}
188230
]
189231
},
190-
"BCardText",
232+
{
233+
"component": "BCardText",
234+
"slots": [
235+
{
236+
"name": "default",
237+
"description": "Content to place in the card text"
238+
}
239+
]
240+
},
191241
{
192242
"component": "BCardGroup",
193243
"props": [
@@ -199,6 +249,12 @@
199249
"prop": "columns",
200250
"description": "When set, renders the card group in a masonry-like columnar style"
201251
}
252+
],
253+
"slots": [
254+
{
255+
"name": "default",
256+
"description": "Content (cards) to place in the card group"
257+
}
202258
]
203259
}
204260
]

‎src/components/carousel/package.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@
9898
}
9999
]
100100
}
101+
],
102+
"slots": [
103+
{
104+
"name": "default",
105+
"description": "Content (slides) to place in the carousel"
106+
}
101107
]
102108
},
103109
{
@@ -162,6 +168,10 @@
162168
}
163169
],
164170
"slots": [
171+
{
172+
"name": "default",
173+
"description": "Content to place in the carousel slide"
174+
},
165175
{
166176
"name": "img",
167177
"description": "Slot for img element or image component"

‎src/components/collapse/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
{
4343
"prop": "visible",
4444
"type": "Boolean",
45-
"description": "Visible state of the collapse: true if the collapse is visible"
45+
"description": "Visible state of the collapse. `true` if the collapse is visible"
4646
}
4747
]
4848
}

‎src/components/dropdown/package.json

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,12 @@
225225
}
226226
]
227227
}
228+
],
229+
"slots": [
230+
{
231+
"name": "default",
232+
"description": "Content to place in the dropdown item"
233+
}
228234
]
229235
},
230236
{
@@ -253,6 +259,12 @@
253259
}
254260
]
255261
}
262+
],
263+
"slots": [
264+
{
265+
"name": "default",
266+
"description": "Content to place in the dropdown item-button"
267+
}
256268
]
257269
},
258270
{
@@ -284,18 +296,30 @@
284296
"prop": "validated",
285297
"description": "When set, adds the Bootstrap class 'was-validated' on the form, triggering the native browser validation states"
286298
}
299+
],
300+
"slots": [
301+
{
302+
"name": "default",
303+
"description": "Content to place in the dropdown form"
304+
}
287305
]
288306
},
289307
{
290308
"component": "BDropdownText",
309+
"aliases": [
310+
"BDdText"
311+
],
291312
"props": [
292313
{
293314
"prop": "textClass",
294315
"description": "Class or classes to apply to the inner element"
295316
}
296317
],
297-
"aliases": [
298-
"BDdText"
318+
"slots": [
319+
{
320+
"name": "default",
321+
"description": "Content to place in the dropdown text"
322+
}
299323
]
300324
},
301325
{
@@ -310,6 +334,10 @@
310334
}
311335
],
312336
"slots": [
337+
{
338+
"name": "default",
339+
"description": "Content (items) to place in the dropdown group"
340+
},
313341
{
314342
"name": "header",
315343
"description": "Optional header content for the dropdown group"
@@ -320,6 +348,12 @@
320348
"component": "BDropdownHeader",
321349
"aliases": [
322350
"BDdHeader"
351+
],
352+
"slots": [
353+
{
354+
"name": "default",
355+
"description": "Content to place in the dropdown header"
356+
}
323357
]
324358
}
325359
]

‎src/components/embed/package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616
"prop": "type",
1717
"description": "Type of embed. Possible values are 'iframe', 'video', 'embed' and 'object'"
1818
}
19+
],
20+
"slots": [
21+
{
22+
"name": "default",
23+
"description": "Content to place in the embed"
24+
}
1925
]
2026
}
2127
]

0 commit comments

Comments
 (0)
0