Skip to content

# Runtime API Examples ​

This page demonstrates usage of some of the runtime APIs provided by VitePress.

The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:

md

    <script setup>
    import { useData } from 'vitepress'

    const { theme, page, frontmatter } = useData()
    </script>

    ## Results

    ### Theme Data
    <pre>{{ theme }}</pre>

    ### Page Data
    <pre>{{ page }}</pre>

    ### Page Frontmatter
    <pre>{{ frontmatter }}</pre>

## Results ​

### Theme Data ​

    {
      "search": {
        "provider": "local",
        "options": {
          "translations": {
            "button": {
              "buttonText": "Pesquisar",
              "buttonAriaLabel": "Pesquisar"
            },
            "modal": {
              "noResultsText": "Nenhum resultado encontrado",
              "resetButtonTitle": "Limpar pesquisa",
              "displayDetails": "Mostrar lista detalhada",
              "footer": {
                "selectText": "para selecionar",
                "navigateText": "para navegar",
                "closeText": "para fechar"
              }
            }
          }
        }
      },
      "nav": [
        {
          "text": "Home",
          "link": "/"
        },
        {
          "text": "Manual",
          "link": "/manual/index"
        },
        {
          "text": "Roadmap",
          "link": "/roadmap/index.md"
        }
      ],
      "docFooter": {
        "prev": "Página Anterior",
        "next": "Próxima Página"
      },
      "outline": {
        "label": "Nesta Página"
      },
      "sidebar": {
        "/manual/": [
          {
            "text": "Módulos",
            "items": [
              {
                "text": "Acesso/Login",
                "link": "/manual/login"
              },
              {
                "text": "Correspondências",
                "link": "/manual/correspondencias"
              },
              {
                "text": "Obrigações",
                "link": "/manual/obrigacoes"
              },
              {
                "text": "Notificações",
                "link": "/manual/notificacoes"
              },
              {
                "text": "Pleitos/Reequilíbrios",
                "link": "/manual/reequilibrios"
              },
              {
                "text": "Demandas Sociedade",
                "link": "/manual/demandas"
              },
              {
                "text": "Relações Institucionais",
                "link": "/manual/relacoes"
              },
              {
                "text": "Meio Ambiente",
                "link": "/manual/meioAmbiente"
              },
              {
                "text": "GED",
                "link": "/manual/ged"
              }
            ]
          },
          {
            "text": "Geral",
            "items": [
              {
                "text": "Cadastros",
                "link": "/manual/cadastro"
              },
              {
                "text": "Segurança",
                "link": "/manual/seguranca"
              }
            ]
          },
          {
            "text": "Ferramentas",
            "items": [
              {
                "text": "Assinatura Digital",
                "link": "/manual/assinador"
              }
            ]
          }
        ],
        "/roadmap/": [
          {
            "text": "Roadmap plataforma",
            "items": [
              {
                "text": "Versão 1.27",
                "link": "/roadmap/versao-1.27"
              }
            ]
          }
        ]
      },
      "socialLinks": [
        {
          "icon": "facebook",
          "link": "https://www.facebook.com/otiswpoa"
        },
        {
          "icon": "instagram",
          "link": "https://www.instagram.com/otisoftware"
        },
        {
          "icon": "linkedin",
          "link": "https://www.linkedin.com/company/otisoftware"
        },
        {
          "icon": {
            "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"32\" height=\"32\" viewBox=\"0 0 32 32\"><path d=\"M25.873,6.069c-2.619-2.623-6.103-4.067-9.814-4.069C8.411,2,2.186,8.224,2.184,15.874c-.001,2.446,.638,4.833,1.852,6.936l-1.969,7.19,7.355-1.929c2.026,1.106,4.308,1.688,6.63,1.689h.006c7.647,0,13.872-6.224,13.874-13.874,.001-3.708-1.44-7.193-4.06-9.815h0Zm-9.814,21.347h-.005c-2.069,0-4.099-.557-5.87-1.607l-.421-.25-4.365,1.145,1.165-4.256-.274-.436c-1.154-1.836-1.764-3.958-1.763-6.137,.003-6.358,5.176-11.531,11.537-11.531,3.08,.001,5.975,1.202,8.153,3.382,2.177,2.179,3.376,5.077,3.374,8.158-.003,6.359-5.176,11.532-11.532,11.532h0Zm6.325-8.636c-.347-.174-2.051-1.012-2.369-1.128-.318-.116-.549-.174-.78,.174-.231,.347-.895,1.128-1.098,1.359-.202,.232-.405,.26-.751,.086-.347-.174-1.464-.54-2.788-1.72-1.03-.919-1.726-2.054-1.929-2.402-.202-.347-.021-.535,.152-.707,.156-.156,.347-.405,.52-.607,.174-.202,.231-.347,.347-.578,.116-.232,.058-.434-.029-.607-.087-.174-.78-1.88-1.069-2.574-.281-.676-.567-.584-.78-.595-.202-.01-.433-.012-.665-.012s-.607,.086-.925,.434c-.318,.347-1.213,1.186-1.213,2.892s1.242,3.355,1.416,3.587c.174,.232,2.445,3.733,5.922,5.235,.827,.357,1.473,.571,1.977,.73,.83,.264,1.586,.227,2.183,.138,.666-.1,2.051-.839,2.34-1.649,.289-.81,.289-1.504,.202-1.649s-.318-.232-.665-.405h0Z\" fill-rule=\"evenodd\"></path></svg>"
          },
          "link": "https://api.whatsapp.com/send?phone=555130280036&text=Ol%C3%A1,%20gostaria%20de%20falar%20com%20um%20especialista..."
        }
      ],
      "footer": {
        "message": "Cópia controlada. Documentação aqui presente não pode ser copiada nem distribuída sem autorização da OTI Software.",
        "copyright": "Copyright © 2012-2024 OTISoftware. Todos os direitos reservados"
      },
      "logo": "/img/logo.png"
    }

### Page Data ​

    {
      "title": "Runtime API Examples",
      "description": "",
      "frontmatter": {
        "outline": "deep"
      },
      "headers": [],
      "relativePath": "api-examples.md",
      "filePath": "api-examples.md"
    }

### Page Frontmatter ​

    {
      "outline": "deep"
    }

## More ​

Check out the documentation for the full list of runtime APIs.