client
Modules
| Module | Description |
|---|---|
| dayjs | - |
Interfaces
| Interface | Description |
|---|---|
| BaseCategory | 基础分类 |
| CategoryList | - |
| CollectionConfig | - |
| GetHeadersOptions | - |
| Header | - |
| PostCollectionInfo | - |
| ScrollToOptions | - |
| ValaxySSGContext | - |
Type Aliases
| Type Alias | Description |
|---|---|
| AppContext | - |
| AppSetup | - |
| Categories | - |
| Category | - |
| MenuItem | - |
| MermaidOptions | - |
| MermaidSetup | - |
| Tags | - |
| TaxonomyNamespace | - |
| UserModule | - |
Variables
| Variable | Description |
|---|---|
| cdnPrefix | - |
| contentUpdatedCallbacks | - |
| dataSymbol | - |
| emptyAddonName | - |
| EXTERNAL_URL_RE | - |
| LOCALE_PREFIX | 标识这是一个使用国际化的 key 从 locales/ 目录中获取对应的翻译 |
| name | - |
| resolvedHeaders | - |
| runContentUpdated | - |
| SENSITIVE_FRONTMATTER_KEYS | Frontmatter fields that contain sensitive or internal data and should be stripped before public output (e.g. llms.txt). |
| useAppStore | Global store for users |
| - | |
| useRouterStore | - |
| useSiteStore | cache site global store - post - tag - category |
| - | |
| valaxyConfigRef | - |
| valaxyConfigSymbol | - |
| valaxyContextRef | - |
Functions
| Function | Description |
|---|---|
| addToParent | - |
| asAny | - |
| buildTree | - |
| dayjs | - |
| defineAppSetup | - |
| defineClientComponent | Define a component that only renders on the client side. |
| defineCollection | - |
| defineMermaidSetup | - |
| filterAndSortPosts | Pure function to filter and sort posts from page list Can be used in both composables and stores without inject() issues |
| formatDate | format the date (dayjs) with default timezone |
| getAddonModule | Cast a module namespace import to a plain type, breaking Rollup's static binding analysis on import * as ns namespace objects. |
| getHeaders | get headers from document directly |
| getLocaleMessageValue | Resolve a nested locale message value by dot-separated key. |
| hasLocaleMessage | Whether a locale message exists for the given key. |
| initContext | - |
| initValaxyConfig | - |
| isCategoryList | For theme development, you can use this function to determine whether the category is a category list. |
| isEmptyAddon | - |
| isLocaleKey | Whether the value is an explicit locale key like $locale:tag.notes. |
| mergeCollapsedCollections | Merge collapsed collections into the post list. For collapsed collections, add a single synthetic entry representing the collection, using the latest article's date for sorting. |
| normalizeRepositoryUrl | Remove git+ prefix from repository URL |
| onClickHref | - |
| onContentUpdated | Register callback that is called every time the markdown content is updated in the DOM. |
| orderByMeta | sort posts by date |
| parseRangeString | 1,3-5,8 => [1, 3, 4, 5, 8] |
| random | 生成介于 min 与 max 之间的随机数 |
| removeItemFromCategory | remove item from category |
| resolveCollectionItemHref | Resolve the href and external status for a collection item. link takes precedence over key. Internal links start with /. |
| resolveHeaders | - |
| resolveTaxonomyLocaleKey | Resolve the effective locale key for a taxonomy term. |
| runCbs | - |
| scrollTo | For theme developers, you can use this function to scroll to the target element. For example, when you click the anchor link in the markdown file, it will scroll to the target element. |
| serializeHeader | - |
| sleep | 等待指定时间 (ms) |
| sortByDate | sort posts by date |
| sortByUpdated | - |
| stripLocalePrefix | Strip $locale: prefix when present. |
| throttleAndDebounce | - |
| tObject | translate object |
| useActiveAnchor | - |
| use MetingJS and Aplayer | |
| useBack | back to previous page or home page |
| useBackToTop | You can use href="#" to back to top |
| useCategories | get categories from posts category: A/B/C { name: 'A', total: 1, children: [ { name: 'B' total: 1, children: [{ name: 'C', total: 1, children: [{ title: '' }] }] } ] } |
| - | |
| useCollapseCode | 折叠代码块（允许设置最大高度） |
| useCollection | 获取当前集合 |
| useCollectionPosts | Get posts belonging to a specific collection Sorted by the order defined in collection.items |
| useCollections | Composable for Collections /collections/:collectionId/:slug |
| useConfig | alias for useSite |
| useCopyCode | - |
| useCopyMarkdown | Composable for copying raw Markdown content of the current post. Requires siteConfig.llms.files: true to have .md files available at build output. |
| useData | inject pageData |
| useDecrypt | - |
| useEncryptedContent | 获取加密文章数据 |
| useEncryptedPhotos | encryptedPhotos 获取加密相册数据 |
| useFrontmatter | Get route.meta.frontmatter from your markdown file |
| useFullUrl | get full url |
| useFuseSearch | - |
| useInvisibleElement | trigger show invisible element |
| useLayout | - |
| useLocale | - |
| useLocaleTitle | get locale title |
| useMediumZoom | - |
| useMobile | is mobile media query |
| useOutline | export headers & handleClick to generate outline |
| usePageList | get all page in 'pages' folder |
| usePagination | - |
| usePartiallyEncryptedContents | 获取部分加密内容 |
| usePostCollections | Find which collection(s) a given post path belongs to. Checks both key-based items (/collections/{collKey}/{item.key}) and internal link items (item.link). |
| usePostList | get post list in 'pages/posts' folder todo: use vue provide/inject to global |
| usePostListWithCollections | Get post list merged with collapsed collection entries. Collapsed collections are represented by a single synthetic entry (card) that is appended and re-sorted with the existing posts. |
| usePostTitle | - |
| usePrevNext | get prev and next post |
| useRuntimeConfig | - |
| useScreenSize | breakpoints ref https://tailwindcss.com/docs/screens |
| useSidebar | helper for sidebar |
| useSiteConfig | get valaxy config |
| useTags | get tag map [tagName]: count |
| useValaxyApp | - |
| useValaxyConfig | get valaxy config |
| useValaxyDark | - |
| useValaxyHead | - |
| useValaxyI18n | 以 $locale: 开头的 key 会被认为是国际化的 key 会从 locales/ 目录中获取对应的翻译 |
| wrap | wrap node |
| wrapTable | 包裹表格，添加 class 以控制 table 样式 |