Config
componentsDir
- Type:
string
- Default:
null
The folder in which all the example .vue
components are stored.
Either an absolute path or a relative path to the .vuepress
directory can be used.
It may contain sub-folders for better organization.
Props
Prop | Description | Type | Default | Required |
---|---|---|---|---|
component | The component name of the example component without the .vue extension | String | Empty | false |
title | Custom title for the example | String | Example | false |
stripComments | Controls whether comments should be removed from the example's code | Boolean | true | false |
showLabels | Controls whether to show labels on the sections' tabs | Boolean | true | false |
showIcons | Controls whether to show icons on the sections' tabs | Boolean | true | false |
showLoader | Controls whether to show a loader spinner while the example component is loading | Boolean | false | false |
startExpanded | Controls whether the main section should be expanded upon initialization | Boolean | true | false |
Slots
default
The default slot to use for adding content inside the live example section.
template
The slot to use for adding content inside the template section.
script
The slot to use for adding content inside the script section.
style
The slot to use for adding content inside the style section.