mirror of
https://github.com/ArthurDanjou/ui.git
synced 2026-01-26 18:00:43 +01:00
docs(components): ignore props in ComponentProps
This commit is contained in:
@@ -3,9 +3,29 @@ import { upperFirst, camelCase } from 'scule'
|
|||||||
import type { ComponentMeta } from 'vue-component-meta'
|
import type { ComponentMeta } from 'vue-component-meta'
|
||||||
import * as theme from '#build/ui'
|
import * as theme from '#build/ui'
|
||||||
|
|
||||||
const props = defineProps<{
|
const props = withDefaults(defineProps<{
|
||||||
ignore?: string[]
|
ignore?: string[]
|
||||||
}>()
|
}>(), {
|
||||||
|
ignore: () => [
|
||||||
|
'activeClass',
|
||||||
|
'inactiveClass',
|
||||||
|
'exactActiveClass',
|
||||||
|
'ariaCurrentValue',
|
||||||
|
'href',
|
||||||
|
'rel',
|
||||||
|
'noRel',
|
||||||
|
'prefetch',
|
||||||
|
'prefetchOn',
|
||||||
|
'noPrefetch',
|
||||||
|
'prefetchedClass',
|
||||||
|
'replace',
|
||||||
|
'exact',
|
||||||
|
'exactQuery',
|
||||||
|
'exactHash',
|
||||||
|
'external',
|
||||||
|
'onClick'
|
||||||
|
]
|
||||||
|
})
|
||||||
|
|
||||||
const route = useRoute()
|
const route = useRoute()
|
||||||
|
|
||||||
|
|||||||
@@ -255,32 +255,7 @@ props:
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|||||||
@@ -100,32 +100,7 @@ You can also use the `#item`, `#item-leading`, `#item-label` and `#item-trailing
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|||||||
@@ -260,31 +260,7 @@ slots:
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-props
|
:component-props
|
||||||
---
|
|
||||||
ignore:
|
|
||||||
- to
|
|
||||||
- target
|
|
||||||
- activeClass
|
|
||||||
- inactiveClass
|
|
||||||
- exactActiveClass
|
|
||||||
- ariaCurrentValue
|
|
||||||
- href
|
|
||||||
- rel
|
|
||||||
- noRel
|
|
||||||
- prefetch
|
|
||||||
- prefetchOn
|
|
||||||
- noPrefetch
|
|
||||||
- prefetchedClass
|
|
||||||
- replace
|
|
||||||
- exact
|
|
||||||
- exactQuery
|
|
||||||
- exactHash
|
|
||||||
- external
|
|
||||||
- active
|
|
||||||
- onClick
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
::callout{icon="i-simple-icons-github" to="https://github.com/nuxt/ui/blob/v3/src/runtime/components/Link.vue#L13"}
|
::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.
|
The `Button` component extends the `Link` component. Check out the source code on GitHub.
|
||||||
|
|||||||
@@ -224,32 +224,7 @@ class: 'p-8 px-16'
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|||||||
@@ -593,32 +593,7 @@ You can also use the `#item`, `#item-leading`, `#item-label` and `#item-trailing
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|||||||
@@ -286,32 +286,7 @@ In this example, :kbd{value="meta"} :kbd{value="S"}, :kbd{value="shift"} :kbd{va
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|||||||
@@ -355,32 +355,7 @@ In this example, :kbd{value="meta"} :kbd{value="E"}, :kbd{value="meta"} :kbd{val
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|||||||
@@ -358,32 +358,7 @@ name: 'modal-command-palette-example'
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|||||||
@@ -346,32 +346,7 @@ name: 'slideover-footer-slot-example'
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
### Slots
|
### Slots
|
||||||
|
|
||||||
|
|||||||
@@ -214,42 +214,15 @@ In this example, we use the `AppConfig` to configure the `expand` prop of the `T
|
|||||||
|
|
||||||
### Props
|
### Props
|
||||||
|
|
||||||
::component-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
|
|
||||||
---
|
|
||||||
::
|
|
||||||
|
|
||||||
<!-- ### Slots
|
### Slots
|
||||||
|
|
||||||
:component-slots
|
:component-slots
|
||||||
|
|
||||||
### Emits
|
### Emits
|
||||||
|
|
||||||
:component-emits -->
|
:component-emits
|
||||||
|
|
||||||
## Theme
|
## Theme
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user