Skip to content

Feature : Add Slots to Component Reference #642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VividLemon merged 3 commits into from
Sep 13, 2022
Merged

Feature : Add Slots to Component Reference #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e9026b
feat: adds slots to component reference docs
Rotair Sep 9, 2022
db1b0b9
Merge remote-tracking branch 'origin/main' into HEAD
Rotair Sep 9, 2022
96babb3
Merge remote-tracking branch 'origin/main' into HEAD
Rotair Sep 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions apps/docs/docs/.vuepress/PluginComponentReference/client/components/component-doc.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,66 @@
</template>
</b-table>
</div>
<div v-if="slots && slots.length > 0" class="bd-content">
<anchored-heading :id="`comp-ref-${componentName}-slots`" level="4" class="mb-3">
Slots
</anchored-heading>
<b-table
:items="slotsItems"
:fields="slotsFields"
primary-key="name"
table-class="bv-docs-table"
responsive="sm"
sort-icon-left
bordered
striped
>
<template #cell(name)="{ value, item }">
<code class="text-nowrap notranslate" translate="no">{{ value }}</code>
<b-badge v-if="item.version" variant="secondary">v{{ item.version }}+</b-badge>
</template>
<template #cell(scope)="{ value, detailsShowing, toggleDetails, item }">
<b-button
v-if="value"
variant="outline-info"
size="sm"
class="py-0"
@click="toggleDetails()"
>
{{item}}
</b-button>
</template>
<template #row-details="{ item }">
<b-table
:items="item.scope"
:fields="[{ key: 'prop', label: 'Property' }, 'type', 'description']"
primary-key="prop"
class="m-0"
dark
caption-top
small
>
<template #thead-top>
<b-tr>
<b-th colspan="3" class="text-center">
<code class="text-nowrap notranslate" translate="no">{{ item.name }}</code>
Slot scoped properties
</b-th>
</b-tr>
</template>
<template #cell(prop)="{ value, item: cellItem }">
<code class="text-nowrap notranslate" translate="no">{{ value }}</code>
<b-badge v-if="cellItem.version" variant="secondary">v{{ cellItem.version }}+</b-badge>
</template>
<template #cell(type)="{ value }">
<code class="text-nowrap notranslate" translate="no">{{ value || 'Any' }}</code>
</template>
</b-table>
</template>

</b-table>

</div>
</template>
<script lang="ts">
import {resolveComponent, defineComponent, computed, ComputedRef, ConcreteComponent} from 'vue'
Expand Down Expand Up @@ -245,6 +305,20 @@ export default defineComponent({
]
})

const slotsFields: ComputedRef<any> = computed(() => {
const sortable = props.slots.length >= SORT_THRESHOLD
const hasScopedSlots = props.slots.some(s => s.scope)
return [
{ key: 'name', label: 'Name', sortable },
...(hasScopedSlots ? [{ key: 'scope', label: 'Scoped' }] : []),
{ key: 'description', label: 'Description' }
]
})

const slotsItems: ComputedRef<any> = computed(() => {
return props.slots ? props.slots.map(slot => ({ ...slot as any})) : []
})

const vmodelItems: ComputedRef<any> = computed(() => {
//TODO loop through props and emits to determine v-model
// let match = VMODEL_REGEX.exec(myString);
Expand All @@ -258,6 +332,8 @@ export default defineComponent({
return {
componentName,
emitsFields,
slotsItems,
slotsFields,
propsItems,
propFields,
githubURL,
Expand Down
Loading