---
title: "Component overrides"
description: "Replace one Docs component or add a small extension without copying a layout."
canonical_url: "https://indocio.igrislabs.com/getting-started/overrides"
---

> Index of every page on this site: [llms.txt](https://indocio.igrislabs.com/llms.txt)

## Component families

<table>
<thead>
  <tr>
    <th>
      Directory
    </th>
    
    <th>
      Purpose
    </th>
    
    <th>
      Examples
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        components/ui/
      </code>
    </td>
    
    <td>
      IPEX interface primitives, prefixed with <code>
        Ui
      </code>
    </td>
    
    <td>
      <code>
        UiButton
      </code>
      
      , <code>
        UiTabs
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        components/docs/
      </code>
    </td>
    
    <td>
      Documentation shell
    </td>
    
    <td>
      <code>
        DocsLayout
      </code>
      
      , <code>
        DocsHeader
      </code>
      
      , <code>
        DocsSidebar
      </code>
      
      , <code>
        DocsPage
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        components/content/
      </code>
    </td>
    
    <td>
      Globally available Markdown components
    </td>
    
    <td>
      <code>
        Tabs
      </code>
      
      , <code>
        Steps
      </code>
      
      , <code>
        CodeTabs
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        components/prose/
      </code>
    </td>
    
    <td>
      Standard Markdown renderers
    </td>
    
    <td>
      <code>
        ProseH2
      </code>
      
      , <code>
        ProseA
      </code>
      
      , <code>
        ProsePre
      </code>
    </td>
  </tr>
</tbody>
</table>

Start with configuration. Use an extension component for extra content. Replace a shell component when its rendering needs to change.

## Override from your app

Create an identically named component in your app. Nuxt gives the consuming app priority over the layer. Docs components resolve automatically rather than importing the layer's implementation directly.

```vue [app/components/docs/DocsFooter.vue]
<script setup lang="ts">
import type { DocsConfig } from '@igrislabs/indocio/types'

defineProps<{ settings: DocsConfig; page?: unknown }>()
</script>

<template>
  <footer class="mt-12 border-t border-border pt-6 text-sm">
    Your team's documentation. <a href="https://example.com/support">Get help</a>.
  </footer>
</template>
```

## Extension components

These components are deliberately small. Override one to add content in a supported location.

<table>
<thead>
  <tr>
    <th>
      Component
    </th>
    
    <th>
      Location
    </th>
    
    <th>
      Props
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        DocsHeaderActions
      </code>
    </td>
    
    <td>
      Right of the docs header
    </td>
    
    <td>
      <code>
        settings
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsSidebarTop
      </code>
    </td>
    
    <td>
      Above sidebar navigation; contains the space switcher by default
    </td>
    
    <td>
      <code>
        settings
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsSidebarBottom
      </code>
    </td>
    
    <td>
      Before the sidebar's home link
    </td>
    
    <td>
      <code>
        settings
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsPageBefore
      </code>
    </td>
    
    <td>
      Before the page header
    </td>
    
    <td>
      <code>
        page
      </code>
      
      , <code>
        space
      </code>
      
      , <code>
        settings
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsPageAfter
      </code>
    </td>
    
    <td>
      After rendered Markdown
    </td>
    
    <td>
      <code>
        page
      </code>
      
      , <code>
        space
      </code>
      
      , <code>
        settings
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsTocBottom
      </code>
    </td>
    
    <td>
      Below the desktop TOC
    </td>
    
    <td>
      <code>
        page
      </code>
      
      , <code>
        space
      </code>
      
      , <code>
        settings
      </code>
    </td>
  </tr>
</tbody>
</table>

Use `await useDocsContext()` inside any override to access the active locale's navigation, spaces, active space, sidebar tree, and ordered pages. `useIndocio()` provides branding, locale scope, home URL, and `localPath()`.

```vue [app/components/docs/DocsPageAfter.vue]
<script setup lang="ts">
import type { DocsConfig } from '@igrislabs/indocio/types'

defineProps<{ page?: unknown; space?: unknown; settings: DocsConfig }>()
</script>

<template>
  <aside class="mt-10 rounded-lg border border-border p-4 text-sm">
    Something unclear? Open an issue with a link to this page.
  </aside>
</template>
```

When replacing `DocsHeaderActions`, include `SiteNavigation`, `LocaleSwitch`, `ColorModeButton`, and `DocsCustomizerTrigger` if you want those controls. When replacing `DocsSidebarTop`, include `DocsSpaceSwitcher` to keep the product selector.

The core `DocsSidebarBottom` includes a **Customize this layout** button when the [live customizer](https://indocio.igrislabs.com/getting-started/customizer) is enabled. The documentation app keeps this trigger in its own override.

## Shell component contracts

<table>
<thead>
  <tr>
    <th>
      Component
    </th>
    
    <th>
      Props
    </th>
    
    <th>
      Slots / behavior
    </th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>
      <code>
        DocsLayout
      </code>
    </td>
    
    <td>
      None
    </td>
    
    <td>
      Default page content, <code>
        header
      </code>
      
      , <code>
        sidebar
      </code>
      
      ; provides layout dimensions and search
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsHeader
      </code>
    </td>
    
    <td>
      <code>
        settings
      </code>
      
      , <code>
        currentCategory
      </code>
      
      , <code>
        currentTitle
      </code>
    </td>
    
    <td>
      <code>
        actions
      </code>
      
      ; emits <code>
        navigation
      </code>
      
       and <code>
        search
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsSidebar
      </code>
    </td>
    
    <td>
      <code>
        tree
      </code>
      
      , <code>
        settings
      </code>
      
      ; <code>
        v-model:collapsed
      </code>
    </td>
    
    <td>
      <code>
        top
      </code>
      
      , <code>
        bottom
      </code>
      
      ; exposes <code>
        toggle()
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsPage
      </code>
    </td>
    
    <td>
      <code>
        page
      </code>
    </td>
    
    <td>
      Default rendered content, <code>
        before
      </code>
      
      , <code>
        header
      </code>
      
      , <code>
        after
      </code>
      
      , <code>
        toc
      </code>
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsPageHeader
      </code>
    </td>
    
    <td>
      <code>
        page
      </code>
      
      , <code>
        settings
      </code>
    </td>
    
    <td>
      Title, description, copy link, edit link
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsPageNavigation
      </code>
    </td>
    
    <td>
      Optional <code>
        previous
      </code>
      
      , <code>
        next
      </code>
      
       navigation items
    </td>
    
    <td>
      Space-scoped adjacent links
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsFooter
      </code>
    </td>
    
    <td>
      <code>
        settings
      </code>
      
      , optional <code>
        page
      </code>
    </td>
    
    <td>
      Default footer content
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsToc
      </code>
    </td>
    
    <td>
      <code>
        links
      </code>
    </td>
    
    <td>
      Existing heading tracking and accent indicator
    </td>
  </tr>
  
  <tr>
    <td>
      <code>
        DocsSearch
      </code>
    </td>
    
    <td>
      <code>
        v-model:open
      </code>
    </td>
    
    <td>
      Locale-aware search with optional all-space scope
    </td>
  </tr>
</tbody>
</table>

`DocsPage`'s default slot receives `page`; its `before` and `after` slots receive `page`, `space`, and `settings`.

The default `layouts/default.vue` composes `DocsLayout`. You can replace the app layout to use its slots, while keeping the shell's existing behavior.

## Styling

Keep accent and other branding overrides in your app's CSS. Core accent falls back to primary. Use documented layout variables instead of selectors that depend on private DOM nesting.

## Sitemap

See the full [sitemap](https://indocio.igrislabs.com/sitemap.md) for all pages.
