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
{
"logo": {
"light": "/logo-light.png",
"dark": "/logo-dark.png"
},
"search": {
"provider": "local"
},
"nav": [
{
"text": "Examples",
"link": "/examples/markdown-examples",
"activeMatch": "/examples/"
},
{
"text": "Javascript",
"items": [
{
"text": "Basic",
"link": "/javascript/basic/01-comments",
"activeMatch": "/basic/"
},
{
"text": "Intermediate",
"link": "/javascript/intermediate/intermediate",
"activeMatch": "/intermediate/"
},
{
"text": "Advanced",
"link": "/javascript/advanced/01-proxy",
"activeMatch": "/advanced/"
},
{
"text": "FunFacts",
"link": "/javascript/fun-facts/01-smoosh-gate",
"activeMatch": "/fun-facts/"
},
{
"text": "Book",
"link": "/javascript/book/you-dont-know-js/scope&closures/01-what-is-scope",
"activeMatch": "/book/"
}
],
"activeMatch": "/javascript/"
},
{
"text": "Typescript",
"items": [
{
"text": "Basic",
"link": "/typescript/basic/01-dont-know",
"activeMatch": "/basic/"
}
],
"activeMatch": "/typescript/"
},
{
"text": "CSS",
"items": [
{
"text": "Grid layout",
"link": "/css/grid-layout/01-concepts",
"activeMatch": "/grid-layout/"
},
{
"text": "Flex box",
"link": "/css/flex-box/01-concepts",
"activeMatch": "/flex-box/"
}
],
"activeMatch": "/css/"
},
{
"text": "Node.js",
"items": [
{
"text": "Basic",
"link": "/nodejs/basic/01-concepts",
"activeMatch": "/basic/"
},
{
"text": "Express",
"link": "/nodejs/express/01-concepts",
"activeMatch": "/express/"
},
{
"text": "Koa",
"link": "/nodejs/koa/01-concepts",
"activeMatch": "/koa/"
}
],
"activeMatch": "/nodejs/"
},
{
"text": "Vue",
"items": [
{
"text": "vue.js",
"link": "/vue/vue.js/01-get-started",
"activeMatch": "/vue.js/"
},
{
"text": "vue-router",
"link": "/vue/vue-router/01-getting-started",
"activeMatch": "/vue-router/"
},
{
"text": "vitepress",
"link": "/vue/vitepress/deployment/01-start",
"activeMatch": "/vitepress/"
}
],
"activeMatch": "/vue/"
},
{
"text": "React",
"items": [
{
"text": "react.js",
"link": "/react/react.js/01-get-started",
"activeMatch": "/react.js/"
},
{
"text": "zustand",
"link": "/react/zustand/01-get-started",
"activeMatch": "/zustand/"
},
{
"text": "redux",
"link": "/react/redux/01-get-started",
"activeMatch": "/redux/"
}
],
"activeMatch": "/react/"
},
{
"text": "Others",
"items": [
{
"text": "Vim",
"link": "/others/vim/about-vim",
"activeMatch": "/about-vim"
},
{
"text": "Network",
"link": "/others/network/01-get-started",
"activeMatch": "/network"
},
{
"text": "Osteosarcoma",
"link": "/others/osteosarcoma/catalog",
"activeMatch": "/osteosarcoma"
}
],
"activeMatch": "/others/"
}
],
"sidebar": {
"/javascript/": {
"base": "/javascript/",
"items": [
{
"text": "Basic",
"collapsed": true,
"items": [
{
"text": "注释",
"link": "basic/01-comments"
},
{
"text": "逻辑运算符",
"link": "basic/02-logical-operators"
},
{
"text": "空值合并运算符",
"link": "basic/03-nullish-coalescing-operator"
},
{
"text": "new.target",
"link": "basic/04-new.target"
},
{
"text": "稀疏数组",
"link": "basic/05-sparse-arrays"
},
{
"text": "for",
"link": "basic/06-for"
},
{
"text": "hard-symbolic-link",
"link": "basic/07-hard-symbolic-link"
},
{
"text": "arrow-function",
"link": "basic/08-arrow-function"
},
{
"text": "utils",
"link": "basic/09-utils"
},
{
"text": "event loop",
"link": "basic/10-event-loop"
},
{
"text": "Array",
"collapsed": true,
"items": [
{
"text": "#concat",
"link": "basic/01-array/01-concat"
},
{
"text": "#filter",
"link": "basic/01-array/02-filter"
},
{
"text": "#find",
"link": "basic/01-array/03-find"
},
{
"text": "#findIndex",
"link": "basic/01-array/04-findIndex"
},
{
"text": "#forEach",
"link": "basic/01-array/05-forEach"
},
{
"text": "#includes",
"link": "basic/01-array/06-includes"
},
{
"text": "#indexOf",
"link": "basic/01-array/07-indexOf"
},
{
"text": "#join",
"link": "basic/01-array/08-join"
},
{
"text": "#map",
"link": "basic/01-array/09-map"
},
{
"text": "#pop",
"link": "basic/01-array/10-pop"
},
{
"text": "#push",
"link": "basic/01-array/11-push"
},
{
"text": "#reduce",
"link": "basic/01-array/12-reduce"
},
{
"text": "#reduceRight",
"link": "basic/01-array/13-reduceRight"
},
{
"text": "#reverse",
"link": "basic/01-array/14-reverse"
},
{
"text": "#shift",
"link": "basic/01-array/15-shift"
},
{
"text": "#slice",
"link": "basic/01-array/16-slice"
},
{
"text": "#some",
"link": "basic/01-array/17-some"
},
{
"text": "#sort",
"link": "basic/01-array/18-sort"
},
{
"text": "#splice",
"link": "basic/01-array/19-splice"
},
{
"text": "#unshift",
"link": "basic/01-array/20-unshift"
},
{
"text": "#from",
"link": "basic/01-array/21-from"
}
]
},
{
"text": "Function",
"collapsed": true,
"items": [
{
"text": "apply",
"link": "basic/02-function/01-apply"
},
{
"text": "bind",
"link": "basic/02-function/02-call"
},
{
"text": "call",
"link": "basic/02-function/03-bind"
}
]
},
{
"text": "Object",
"collapsed": true,
"items": [
{
"text": "#hasOwnProperty",
"link": "basic/03-object/01-hasOwnProperty"
}
]
},
{
"text": "Promise",
"collapsed": true,
"items": [
{
"text": "all",
"link": "basic/04-promise/01-all"
},
{
"text": "race",
"link": "basic/04-promise/02-race"
},
{
"text": "any",
"link": "basic/04-promise/03-any"
}
]
}
]
},
{
"text": "Intermediate",
"collapsed": true,
"items": [
{
"text": "medium",
"link": "intermediate/intermediate"
},
{
"text": "implement promise",
"link": "intermediate/01-promise"
},
{
"text": "asyncify",
"link": "intermediate/02-asyncify"
},
{
"text": "array2tree",
"link": "intermediate/03-array2tree"
},
{
"text": "webworker",
"link": "intermediate/04-webworker"
},
{
"text": "scroll2top",
"link": "intermediate/05-scroll2top"
},
{
"text": "highlighter",
"link": "intermediate/06-highlighter"
},
{
"text": "staticEl-vs-liveEl",
"link": "intermediate/07-staticEl-vs-liveEl"
},
{
"text": "concurrency-parallelism",
"link": "intermediate/08-concurrency-parallelism"
},
{
"text": "event-loop-model",
"link": "intermediate/09-event-loop-model"
},
{
"text": "apply.bind",
"link": "intermediate/10-apply.bind"
},
{
"text": "prototype-diagram",
"link": "intermediate/11-prototype-diagram"
},
{
"text": "fibonacci",
"link": "intermediate/12-fibonacci"
},
{
"text": "async-await",
"link": "intermediate/13-async-await"
}
]
},
{
"text": "Advanced",
"collapsed": true,
"items": [
{
"text": "proxy",
"link": "advanced/01-proxy"
},
{
"text": "extend-es5",
"link": "advanced/02-extend-es5"
},
{
"text": "copy",
"link": "advanced/03-copy"
},
{
"text": "generator",
"link": "advanced/04-generator"
}
]
},
{
"text": "funFacts",
"collapsed": true,
"items": [
{
"text": "SmooshGate",
"link": "fun-facts/01-smoosh-gate"
}
]
},
{
"text": "Book",
"collapsed": true,
"items": [
{
"text": "You Don't Know JS - 1ed",
"collapsed": true,
"items": [
{
"text": "scope & closures",
"collapsed": true,
"items": [
{
"text": "what is scope",
"link": "book/you-dont-know-js/scope&closures/01-what-is-scope"
},
{
"text": "lexical scope",
"link": "book/you-dont-know-js/scope&closures/02-lexical-scope"
},
{
"text": "function vs. block scope",
"link": "book/you-dont-know-js/scope&closures/03-function-vs-block-scope"
},
{
"text": "hoisting",
"link": "book/you-dont-know-js/scope&closures/04-hoisting"
},
{
"text": "scope closure",
"link": "book/you-dont-know-js/scope&closures/05-scope-closure"
},
{
"text": "dynamic scope",
"link": "book/you-dont-know-js/scope&closures/appendixA"
},
{
"text": "polyfilling block scope",
"link": "book/you-dont-know-js/scope&closures/appendixB"
},
{
"text": "lexical this",
"link": "book/you-dont-know-js/scope&closures/appendixC"
}
]
},
{
"text": "this & object prototype",
"collapsed": true,
"items": [
{
"text": "this or that",
"link": "book/you-dont-know-js/this&object-prototype/01-this"
},
{
"text": "this all makes sense now",
"link": "book/you-dont-know-js/this&object-prototype/02-this"
},
{
"text": "object",
"link": "book/you-dont-know-js/this&object-prototype/03-object"
},
{
"text": "mixing (up) 'class' object",
"link": "book/you-dont-know-js/this&object-prototype/04-mixing-class-objects"
},
{
"text": "prototypes",
"link": "book/you-dont-know-js/this&object-prototype/05-prototypes"
},
{
"text": "behavior delegation",
"link": "book/you-dont-know-js/this&object-prototype/06-behavior-delegation"
},
{
"text": "appendixA ES6 class",
"link": "book/you-dont-know-js/this&object-prototype/appendixA"
}
]
},
{
"text": "types & grammar",
"collapsed": true,
"items": [
{
"text": "types",
"link": "book/you-dont-know-js/types&grammar/01-types"
},
{
"text": "values",
"link": "book/you-dont-know-js/types&grammar/02-values"
},
{
"text": "natives",
"link": "book/you-dont-know-js/types&grammar/03-natives"
},
{
"text": "coercion",
"link": "book/you-dont-know-js/types&grammar/04-coercion"
},
{
"text": "grammar",
"link": "book/you-dont-know-js/types&grammar/05-grammar"
},
{
"text": "mixed environment JS",
"link": "book/you-dont-know-js/types&grammar/appendixA"
}
]
},
{
"text": "async & performance",
"collapsed": true,
"items": [
{
"text": "asynchrony",
"link": "book/you-dont-know-js/async&performance/01-asynchrony"
},
{
"text": "callbacks",
"link": "book/you-dont-know-js/async&performance/02-callbacks"
},
{
"text": "promise",
"link": "book/you-dont-know-js/async&performance/03-promise"
},
{
"text": "generator",
"link": "book/you-dont-know-js/async&performance/04-generator"
},
{
"text": "program performance",
"link": "book/you-dont-know-js/async&performance/05-program-performance"
},
{
"text": "benchmarking & tuning",
"link": "book/you-dont-know-js/async&performance/06-benchmarking-tuning"
},
{
"text": "appendixA",
"link": "book/you-dont-know-js/async&performance/appendixA"
}
]
}
]
},
{
"text": "You Don't Know JS - 2ed",
"collapsed": true,
"items": [
{
"text": "get started",
"collapsed": true,
"items": [
{
"text": "what is JavaScript",
"link": "book/you-dont-know-js-2ed/get-started/01-what-is-js"
}
]
}
]
}
]
}
]
},
"/typescript/": {
"base": "/typescript/",
"items": [
{
"text": "typescript",
"collapsed": false,
"items": [
{
"text": "get started",
"link": "basic/01-dont-know"
}
]
}
]
},
"/examples/": {
"base": "/examples/",
"items": [
{
"text": "Markdown Examples",
"link": "markdown-examples"
},
{
"text": "API Examples",
"link": "api-examples"
}
]
},
"/css/": {
"base": "/css/",
"items": [
{
"text": "Grid layout",
"collapsed": false,
"items": [
{
"text": "网格布局概念",
"link": "grid-layout/01-concepts"
}
]
},
{
"text": "Flex box",
"collapsed": false,
"items": [
{
"text": "弹性盒布局概念",
"link": "flex-box/01-concepts"
}
]
}
]
},
"/nodejs/": {
"base": "/nodejs/",
"items": [
{
"text": "Node.js Basic",
"collapsed": false,
"items": [
{
"text": "开始",
"link": "basic/01-concepts"
}
]
},
{
"text": "Express",
"collapsed": false,
"items": [
{
"text": "开始",
"link": "express/01-concepts"
}
]
},
{
"text": "Koa",
"collapsed": false,
"items": [
{
"text": "开始",
"link": "koa/01-concepts"
}
]
}
]
},
"/vue/": {
"base": "/vue/",
"items": [
{
"text": "Vue.js",
"collapsed": false,
"items": [
{
"text": "get started",
"link": "vue.js/01-get-started"
}
]
},
{
"text": "Vue Router",
"collapsed": false,
"items": [
{
"text": "Getting Started",
"link": "vue-router/01-getting-started"
},
{
"text": "bala bala",
"link": "vue-router/02-navigation-guards"
}
]
},
{
"text": "vitepress",
"collapsed": false,
"items": [
{
"text": "Deployment process",
"collapsed": false,
"items": [
{
"text": "开始",
"link": "vitepress/deployment/01-start"
},
{
"text": "配置",
"link": "vitepress/deployment/02-configure"
},
{
"text": "部署",
"link": "vitepress/deployment/03-deploy"
}
]
}
]
}
]
},
"/react/": {
"base": "/react/",
"items": [
{
"text": "React.js",
"collapsed": false,
"items": [
{
"text": "get started",
"link": "react.js/01-get-started"
},
{
"text": "Hooks",
"link": "react.js/02-hooks"
}
]
},
{
"text": "zustand",
"collapsed": false,
"items": [
{
"text": "Get Started",
"link": "zustand/01-get-started"
}
]
},
{
"text": "redux",
"collapsed": false,
"items": [
{
"text": "Get Started",
"link": "redux/01-get-started"
},
{
"text": "Go on",
"link": "redux/02-go-on"
}
]
}
]
},
"/others/": {
"base": "/others/",
"items": [
{
"text": "Vim",
"collapsed": false,
"items": [
{
"text": "Vim",
"link": "vim/about-vim"
},
{
"text": "Vim commands",
"link": "vim/vim-commands"
}
]
},
{
"text": "Network",
"collapsed": false,
"items": [
{
"text": "Network",
"link": "network/01-get-started"
},
{
"text": "Details",
"link": "network/02-details"
},
{
"text": "WebSocket",
"link": "network/03-websocket"
}
]
},
{
"text": "Osteosarcoma",
"collapsed": false,
"items": [
{
"text": "Osteosarcoma",
"link": "osteosarcoma/catalog"
}
]
},
{
"text": "something others",
"collapsed": false,
"items": [
{
"text": "SMB",
"link": "01-smb"
}
]
}
]
}
},
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/ZXheart/ZXheart.github.io"
}
],
"footer": {
"message": "Released under the <a href=\"https://github.com/ZXheart/ZXheart.github.io?tab=MIT-1-ov-file\"> MIT License.</a>",
"copyright": "Copyright © 2023-present <a href=\"https://github.com/ZXheart/ZXheart.github.io\">julien</a>"
},
"outline": {
"level": "deep"
}
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "examples/api-examples.md",
"filePath": "examples/api-examples.md",
"lastUpdated": 1703758696000
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.