8000 docs: Use Not Yet Implemented Component consistently by dwgray · Pull Request #2183 · bootstrap-vue-next/bootstrap-vue-next · GitHub
[go: up one dir, main page]

Skip to content

docs: Use Not Yet Implemented Component consistently #2183

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.

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
merged 2 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions apps/docs/src/components/ComponentReference.vue
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@
{{ normalizeDefault(d.item.default) }}
</code>
</template>
<template #cell(description)="d">
<NotYetImplemented v-if="d.item.notYetImplemented" />
{{ d.item.description }}
</template>
</BTable>
<template v-if="component.props.some((el) => el.name.trim() !== '')">
<span
Expand Down Expand Up @@ -171,6 +175,7 @@
v-for="scope in d.item.scope as SlotScopeReference[]"
:key="scope.prop"
>
<span v-if="scope.notYetImplemented"><NotYetImplemented />: </span>
<code>{{ kebabCase(scope.prop) }}</code>
<code>: {{ scope.type }}</code>
<span v-if="!!scope.description"> - {{ scope.description }}</span>
Expand Down
10 changes: 8 additions & 2 deletions apps/docs/src/components/NotYetImplemented.vue
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
<template>
<a
href="https://github.com/bootstrap-vue-next/bootstrap-vue-next/blob/main/CONTRIBUTING.md#developing"
style="color: red"
>Not yet implemented <span v-if="$slots.default">: </span><slot
><span style="color: red">Not yet implemented</span><span v-if="$slots.default">: </span><slot
/></a>
</template>

<script setup lang="ts">
defineSlots<{
// eslint-disable-next-line @typescript-eslint/no-explicit-any
default?: (props: Record<string, never>) => any
}>()
</script>
3 changes: 2 additions & 1 deletion apps/docs/src/data/components/formTags.data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,8 @@ export default {
{
prop: 'remove',
type: '() => void',
description: 'Method to fully reset the tags input [Not yet implemented]',
description: 'Method to fully reset the tags input',
notYetImplemented: true,
},
{
prop: 'removeTag',
Expand Down
4 changes: 3 additions & 1 deletion apps/docs/src/docs/components/card.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,9 @@ For more information on using `BNav` in card headers, refer to the
## Card groups

In addition to styling the content within cards, BootstrapVueNext includes a `BCardGroup` component
for laying out series of cards. For the time being, these layout options are not yet responsive.
for laying out series of cards.

<NotYetImplemented>For the time being, these layout options are not responsive.</NotYetImplemented>

### Default card group

Expand Down
6 changes: 3 additions & 3 deletions apps/docs/src/docs/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ not implemented.

The `sliding-start` and `sliding-end` events have been renamed to `slide` and `slid`.
The `label-indicators` prop has been renamed to `indicators-button-label`.
The `label-goto-slide`and `no-animation` props are not yet implemented.
<NotYetImplemented>The `label-goto-slide`and `no-animation` props.</NotYetImplemented>

## BForm

Expand Down Expand Up @@ -214,7 +214,7 @@ Use `label-visually-hidden` instead of `label-sronly` per
Access to the native `input` element is implemented differently due to changes in how Vue 3
handles references. See the [BFormInput documentation](/docs/components/form-input#exposed-input-element) for more details.

Datalist and disabling mousewheel events are not yet implemented.
<NotYetImplemented>Disabling mousewheel events.</NotYetImplemented>

`trim`, `lazy`, or `number` properties have been deprecated. We support the native modifiers
[`trim`, `lazy`, and `number`](https://vuejs.org/guide/essentials/forms.html#modifiers).
Expand Down Expand Up @@ -422,7 +422,7 @@ Keyboard Navigation and Small Screen Support.

## BPaginationNav

This component is not yet implemented
<NotYetImplemented/>

<script setup lang="ts">
import {computed, ref} from 'vue'
Expand Down
8 changes: 7 additions & 1 deletion apps/docs/src/types/index.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
export type ComponentItem = Exclude<keyof ComponentReference, 'component' | 'sections'>
export type ComponentSection = 'Properties' | 'Events' | 'Slots'
export type EmitArgReference = {arg: string; type: string; description?: string}
export type SlotScopeReference = {prop: string; type: string | string[]; description?: string}
export type SlotScopeReference = {
prop: string
type: string | string[]
description?: string
notYetImplemented?: boolean
}

export interface PropertyReference {
type?: string
description?: string
default?: unknown
notYetImplemented?: boolean
}

/**
Expand Down
3 changes: 1 addition & 2 deletions apps/docs/src/utils/common-props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,7 @@ export const commonProps = () =>
list: {
type: 'string',
default: 'undefined',
description:
'The ID of the associated datalist element or component (Datalist is Not Yet Implemented)',
description: 'The ID of the associated datalist element or component',
},
name: {
type: 'string',
Expand Down
6 changes: 4 additions & 2 deletions apps/docs/src/utils/link-props.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ export const linkProps = {
type: 'boolean',
default: false,
description:
'Not Yet Implemented: To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting `no-prefetch` will disabled this feature for the specific link',
'To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting `no-prefetch` will disabled this feature for the specific link',
notYetImplemented: true,
},
opacity: {
type: "10 | 25 | 50 | 75 | 100 | '10' | '25' | '50' | '75' | '100'",
Expand All @@ -55,7 +56,8 @@ export const linkProps = {
type: 'boolean',
default: undefined,
description:
'Not Yet Implemented: To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`',
'To improve the responsiveness of your Nuxt.js applications, when the link will be displayed within the viewport, Nuxt.js will automatically prefetch the code splitted page. Setting `prefetch` to `true` or `false` will overwrite the default value of `router.prefetchLinks`',
notYetImplemented: true,
},
prefetchedClass: {
type: 'string',
Expand Down
Loading
0