diff --git a/docs/src/.vuepress/theme/index.ts b/docs/src/.vuepress/theme/index.ts index e07def34..1ea97daf 100644 --- a/docs/src/.vuepress/theme/index.ts +++ b/docs/src/.vuepress/theme/index.ts @@ -11,18 +11,15 @@ function capitalize(str: string) { } const typedocSidebarEntries = (): SidebarConfigArray => { - const filePath = resolve( - __dirname, - '../../typedocs' - ) + const filePath = resolve(__dirname, '../../typedocs') - const docsModules = readdirSync(filePath).filter(name => statSync(`${filePath}/${name}`).isDirectory()) + const docsModules = readdirSync(filePath).filter((name) => statSync(`${filePath}/${name}`).isDirectory()) - const sidebarItems = docsModules.map(module => { + const sidebarItems = docsModules.map((module) => { let children = readdirSync(`${filePath}/${module}/`).map(entry => `/typedocs/${module}/${entry}`) if (module === 'variables') { - children = children.filter(child => { + children = children.filter((child) => { return child.includes('default') }) } @@ -30,15 +27,7 @@ const typedocSidebarEntries = (): SidebarConfigArray => { return { text: capitalize(module), children } }) - return [ - { - text: 'TypeDocs', - link: '/typedocs/', - children: [ - ...sidebarItems, - ], - } - ] + return [...sidebarItems] } export default { @@ -100,7 +89,7 @@ export default { '/typedocs/': typedocSidebarEntries(), }, navbar: [ - { text: `v${vueFlowVersion.value}`, link: '' }, + { text: `v${vueFlowVersion.value}`, link: '/' }, { text: 'Guide', link: '/guide/', activeMatch: '^/guide/' }, { text: 'Examples', diff --git a/docs/src/guide/components/controls.md b/docs/src/guide/components/controls.md index 3aa2247f..3b0aa9d7 100644 --- a/docs/src/guide/components/controls.md +++ b/docs/src/guide/components/controls.md @@ -32,3 +32,28 @@ To use the controls simply pass the `Controls` component as a child to the `VueF | zoom-out | Zoom-out btn clicked | | fit-view | Fit-view btn clicked | | interaction-change | Interaction locked/unlocked | + +## Slots + +### Control Buttons + +| Name | Definition | +|---------------------|-------------------------| +| top | slot above default btns | +| control-zoom-in | Zoom-in btn | +| control-zoom-out | Zoom-out btn | +| control-fit-view | Fit-view btn | +| control-interaction | Interaction btn | +| default | slot below default btns | + +### Icons + +| Name | Definition | +|---------------|---------------------------| +| icon-zoom-in | Zoom-in icon | +| icon-zoom-out | Zoom-out icon | +| icon-fit-view | Fit-view icon | +| icon-lock | Interaction locked icon | +| icon-unlock | Interaction unlocked icon | + +