docs(components): ignore props in ComponentProps

This commit is contained in:
Benjamin Canac
2024-10-17 21:46:53 +02:00
parent c63920d05b
commit dc8cd1e664
11 changed files with 34 additions and 265 deletions

View File

@@ -3,9 +3,29 @@ import { upperFirst, camelCase } from 'scule'
import type { ComponentMeta } from 'vue-component-meta'
import * as theme from '#build/ui'
const props = defineProps<{
const props = withDefaults(defineProps<{
ignore?: string[]
}>()
}>(), {
ignore: () => [
'activeClass',
'inactiveClass',
'exactActiveClass',
'ariaCurrentValue',
'href',
'rel',
'noRel',
'prefetch',
'prefetchOn',
'noPrefetch',
'prefetchedClass',
'replace',
'exact',
'exactQuery',
'exactHash',
'external',
'onClick'
]
})
const route = useRoute()

View File

@@ -255,32 +255,7 @@ props:
### Props
::component-props
---
ignore:
- as
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
### Slots

View File

@@ -100,32 +100,7 @@ You can also use the `#item`, `#item-leading`, `#item-label` and `#item-trailing
### Props
::component-props
---
ignore:
- as
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
### Slots

View File

@@ -260,31 +260,7 @@ slots:
### Props
::component-props
---
ignore:
- to
- target
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- active
- onClick
---
::
:component-props
::callout{icon="i-simple-icons-github" to="https://github.com/nuxt/ui/blob/v3/src/runtime/components/Link.vue#L13"}
The `Button` component extends the `Link` component. Check out the source code on GitHub.

View File

@@ -224,32 +224,7 @@ class: 'p-8 px-16'
### Props
::component-props
---
ignore:
- as
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
### Slots

View File

@@ -593,32 +593,7 @@ You can also use the `#item`, `#item-leading`, `#item-label` and `#item-trailing
### Props
::component-props
---
ignore:
- as
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
### Slots

View File

@@ -286,32 +286,7 @@ In this example, :kbd{value="meta"} :kbd{value="S"}, :kbd{value="shift"} :kbd{va
### Props
::component-props
---
ignore:
- as
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
### Slots

View File

@@ -355,32 +355,7 @@ In this example, :kbd{value="meta"} :kbd{value="E"}, :kbd{value="meta"} :kbd{val
### Props
::component-props
---
ignore:
- as
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
### Slots

View File

@@ -358,32 +358,7 @@ name: 'modal-command-palette-example'
### Props
::component-props
---
ignore:
- as
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
### Slots

View File

@@ -346,32 +346,7 @@ name: 'slideover-footer-slot-example'
### Props
::component-props
---
ignore:
- as
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
### Slots

View File

@@ -214,42 +214,15 @@ In this example, we use the `AppConfig` to configure the `expand` prop of the `T
### Props
::component-props
---
ignore:
- as
- open
- defaultOpen
- to
- target
- active
- activeClass
- inactiveClass
- exactActiveClass
- ariaCurrentValue
- href
- rel
- noRel
- prefetch
- prefetchOn
- noPrefetch
- prefetchedClass
- replace
- exact
- exactQuery
- exactHash
- external
- onClick
---
::
:component-props
<!-- ### Slots
### Slots
:component-slots
### Emits
:component-emits -->
:component-emits
## Theme