shadcn-vue/api/_content/query/YpcIrKDI2v.1687787745646.json

{"_path":"/api/composables","_dir":"api","_draft":false,"_partial":false,"_locale":"","_empty":false,"title":"Composables","description":"Discover the Docus composables to use in your custom Vue components and pages.","body":{"type":"root","children":[{"type":"element","tag":"h1","props":{"id":"composables"},"children":[{"type":"text","value":"Composables"}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Discover the Docus composables to use in your custom Vue components and pages."}]},{"type":"element","tag":"h2","props":{"id":"usedocus"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useDocus()"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{"lang":"ts","class":"colored"},"children":[{"type":"element","tag":"span","props":{"class":"ct-923966"},"children":[{"type":"text","value":"useDocus"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"()"}]}]},{"type":"text","value":" gives access to docus runtime config, all default values and your custom config from "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"app.config.ts"}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"config"}]},{"type":"text","value":" refers to the merged config of the current page."}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"main"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"header"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"aside"}]},{"type":"text","value":", "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"footer"}]},{"type":"text","value":" and "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"titleTemplate"}]},{"type":"text","value":" can be set from "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"_dir.yml"}]},{"type":"text","value":" and any "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"page.md"}]},{"type":"text","value":" file."}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"The configs in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"app.config"}]},{"type":"text","value":" file will be used as defaults."}]},{"type":"element","tag":"code","props":{"className":["language-vue"],"code":"<script setup>\nconst { config } = useDocus()\n</script>\n\n<template>\n  <div>\n    <h1>{{ config.title }}</h1>\n    <p>{{ config.description }}</p>\n  </div>\n</template>\n","language":"vue","meta":""},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-942366"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"config"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-942366"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-923966"},"children":[{"type":"text","value":"useDocus"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"()\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  <"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"div"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"    <"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"h1"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">{{ config.title }}</"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"h1"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"    <"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"p"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">{{ config.description }}</"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"p"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  </"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"div"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">"}]}]}]}]}]},{"type":"element","tag":"ul","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"tree"}]},{"type":"text","value":" refers to the current navigation tree that is displayed in the "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"aside"}]},{"type":"text","value":" component."}]}]},{"type":"element","tag":"code","props":{"className":["language-vue"],"code":"<script setup>\nconst { tree } = useDocus()\n</script>\n\n<template>\n  <DocsAsideTree :links=\"tree\" />\n</template>\n","language":"vue","meta":""},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-942366"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"tree"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-942366"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-923966"},"children":[{"type":"text","value":"useDocus"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"()\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  <"}]},{"type":"element","tag":"span","props":{"class":"ct-081784"},"children":[{"type":"text","value":"DocsAsideTree"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":":links"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-667011"},"children":[{"type":"text","value":"\"tree\""}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" />\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-238295"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":">"}]}]}]}]}]},{"type":"element","tag":"source-link","props":{"source":"composables/useDocus.ts"},"children":[]},{"type":"element","tag":"h2","props":{"id":"usemenu"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useMenu()"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useMenu()"}]},{"type":"text","value":" gives access to "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"$menu"}]},{"type":"text","value":" plugin controlling mobile navigation globally."}]},{"type":"element","tag":"code","props":{"className":["language-ts"],"code":"const {\n  // Is menu visible\n  visible,\n  // Close menu function\n  close,\n  // Open menu function\n  open,\n  // Toggle menu function\n  toggle\n} = useMenu()\n","language":"ts","meta":""},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-942366"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-128513"},"children":[{"type":"text","value":"// Is menu visible\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"visible"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-128513"},"children":[{"type":"text","value":"// Close menu function\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"close"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-128513"},"children":[{"type":"text","value":"// Open menu function\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"open"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-128513"},"children":[{"type":"text","value":"// Toggle menu function\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":9},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"toggle\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":10},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"} "}]},{"type":"element","tag":"span","props":{"class":"ct-942366"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-923966"},"children":[{"type":"text","value":"useMenu"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"()"}]}]}]}]}]},{"type":"element","tag":"source-link","props":{"source":"composables/useMenu.ts"},"children":[]},{"type":"element","tag":"h2","props":{"id":"usescrollspy"},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useScrollspy()"}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"useScrollspy()"}]},{"type":"text","value":" is used in "},{"type":"element","tag":"code-inline","props":{},"children":[{"type":"text","value":"docs"}]},{"type":"text","value":" layout to make the ToC display the currently visible headings."}]},{"type":"element","tag":"code","props":{"className":["language-ts"],"code":"const {\n  // Headings on the page\n  visibleHeadings,\n  // Active headings (for the current page)\n  activeHeadings,\n  // Update headings (an array of DOM nodes)\n  updateHeadings\n} = useScrollspy()\n","language":"ts","meta":""},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line","line":1},"children":[{"type":"element","tag":"span","props":{"class":"ct-942366"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" {\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":2},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-128513"},"children":[{"type":"text","value":"// Headings on the page\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":3},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"visibleHeadings"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":4},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-128513"},"children":[{"type":"text","value":"// Active headings (for the current page)\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":5},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"activeHeadings"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":",\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":6},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-128513"},"children":[{"type":"text","value":"// Update headings (an array of DOM nodes)\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":7},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-998471"},"children":[{"type":"text","value":"updateHeadings\n"}]}]},{"type":"element","tag":"span","props":{"class":"line","line":8},"children":[{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"} "}]},{"type":"element","tag":"span","props":{"class":"ct-942366"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-923966"},"children":[{"type":"text","value":"useScrollspy"}]},{"type":"element","tag":"span","props":{"class":"ct-935781"},"children":[{"type":"text","value":"()"}]}]}]}]}]},{"type":"element","tag":"source-link","props":{"source":"composables/useScrollspy.ts"},"children":[]},{"type":"element","tag":"style","children":[{"type":"text","value":".dark .ct-935781{color:#C9D1D9;}\n.ct-935781{color:#24292F;}\n.dark .ct-238295{color:#7EE787;}\n.ct-238295{color:#116329;}\n.dark .ct-998471{color:#79C0FF;}\n.ct-998471{color:#0550AE;}\n.dark .ct-942366{color:#FF7B72;}\n.ct-942366{color:#CF222E;}\n.dark .ct-923966{color:#D2A8FF;}\n.ct-923966{color:#8250DF;}\n.dark .ct-081784{color:#FFA198;font-style:italic;}\n.ct-081784{color:#82071E;font-style:italic;}\n.dark .ct-667011{color:#A5D6FF;}\n.ct-667011{color:#0A3069;}\n.dark .ct-128513{color:#8B949E;}\n.ct-128513{color:#6E7781;}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"usedocus","depth":2,"text":"useDocus()"},{"id":"usemenu","depth":2,"text":"useMenu()"},{"id":"usescrollspy","depth":2,"text":"useScrollspy()"}]}},"_type":"markdown","_id":"content:2.api:2.composables.md","_source":"content","_file":"2.api/2.composables.md","_extension":"md"}