PageAside

Um aside fixo para exibir a navegação da sua página.

Uso

O componente PageAside é um elemento <aside> fixo que só é exibido a partir do breakpoint lg.

O componente PageAside usa a variável CSS --ui-header-height para se posicionar corretamente abaixo do Header.

Use-o dentro do slot left ou right do componente Page:

<template>
  <NPage>
    <template #left>
      <NPageAside />
    </template>
  </NPage>
</template>

Exemplos

Embora estes exemplos usem o Nuxt Content, os componentes podem ser integrados a qualquer sistema de gerenciamento de conteúdo.

Dentro de um layout

Use o componente PageAside em um layout para exibir a navegação:

layouts/docs.vue

<script setup lang="ts">
import type { ContentNavigationItem } from '@nuxt/content'

const navigation = inject<Ref<ContentNavigationItem[]>>('navigation')
</script>

<template>
  <NPage>
    <template #left>
      <NPageAside>
        <NContentNavigation :navigation="navigation" />
      </NPageAside>
    </template>

    <slot />
  </NPage>
</template>

Neste exemplo, usamos o componente ContentNavigation para exibir a navegação injetada em app.vue.

API

Props

Prop	Default	Type
`as`	`'aside'`	`any` The element or component this component should render as.
`ui`		`{ root?: SlotClass; container?: SlotClass; top?: SlotClass; topHeader?: SlotClass; topBody?: SlotClass; topFooter?: SlotClass; }`

Slots

Slot	Type
`top`	`{}`
`default`	`{}`
`bottom`	`{}`

Tema

app.config.ts

export default defineAppConfig({
  ui: {
    pageAside: {
      slots: {
        root: 'hidden overflow-y-auto lg:block lg:max-h-[calc(100vh-var(--ui-header-height))] lg:sticky lg:top-(--ui-header-height) py-8 lg:ps-4 lg:-ms-4 lg:pe-6.5',
        container: 'relative',
        top: 'sticky -top-8 -mt-8 pointer-events-none z-[1]',
        topHeader: 'h-8 bg-default -mx-4 px-4',
        topBody: 'bg-default relative pointer-events-auto flex flex-col -mx-4 px-4',
        topFooter: 'h-8 bg-gradient-to-b from-default -mx-4 px-4'
      }
    }
  }
})

vite.config.ts

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import ui from '@nitro/ui/vite'

export default defineConfig({
  plugins: [
    vue(),
    ui({
      ui: {
        pageAside: {
          slots: {
            root: 'hidden overflow-y-auto lg:block lg:max-h-[calc(100vh-var(--ui-header-height))] lg:sticky lg:top-(--ui-header-height) py-8 lg:ps-4 lg:-ms-4 lg:pe-6.5',
            container: 'relative',
            top: 'sticky -top-8 -mt-8 pointer-events-none z-[1]',
            topHeader: 'h-8 bg-default -mx-4 px-4',
            topBody: 'bg-default relative pointer-events-auto flex flex-col -mx-4 px-4',
            topFooter: 'h-8 bg-gradient-to-b from-default -mx-4 px-4'
          }
        }
      }
    })
  ]
})

Changelog

No recent changes

PageAnchors

Uma lista de âncoras para ser exibida na página.

PageBody

O conteúdo principal da sua página.