client ​

Source: 1.4.0 · bd4b29099af9

Modules ​

ModuleDescription
dayjs-

Interfaces ​

InterfaceDescription
AddonCatalogEntry-
BaseCategory基础分类
CategoryList-
CollectionConfig-
GetHeadersOptions-
Header-
LocalizedAddonText-
LocalizedValaxyAddon-
LocalSearchResult-
PagePublishingProduction publishing rules for files under pages/. draft: true stays routable in development and is omitted from production unless publishing.drafts is set. Underscore paths and README.md are not routes unless the matching flag is set.
PostCollectionInfo-
PublicAuthor-
SanitizeUrlOptions-
ScrollToOptions-
SvgToPngOptions-
ValaxySSGContext-

Type Aliases ​

Type AliasDescription
AddonKind-
AddonLocale-
AppContext-
AppSetup-
Categories-
Category-
MenuItem-
Tags-
TaxonomyNamespace-
UserModule-

Variables ​

VariableDescription
addons-
cdnPrefix-
contentUpdatedCallbacks-
dataSymbol-
emptyAddonName-
EXTERNAL_URL_RE-
LOCALE_PREFIX标识这是一个使用国际化的 key 从 locales/ 目录中获取对应的翻译
name-
officialAddons-
resolvedHeaders-
runContentUpdated-
SENSITIVE_FRONTMATTER_KEYSFrontmatter fields that contain sensitive or internal data and should be stripped before public output (e.g. llms.txt).
useAppStoreGlobal store for users
useRouterStore-
useSiteStorecache site global store - post - tag - category
useWindowScrollYTrack only the vertical offset, without measuring scroll boundaries.
valaxyConfigRef-
valaxyConfigSymbol-
valaxyContextRef-

Functions ​

FunctionDescription
addToParent-
asAny-
buildTree-
clearFuseSearchCacheClear module-scoped Fuse search caches (intended for tests or cache invalidation).
clearLocalSearchCacheClear module-scoped local search caches (intended for tests or index invalidation).
computeZoomRectStyleConvert the opened transform into real dimensions while keeping the same viewport rect. This avoids Chrome rendering the zoomed image blurry because of transform scaling.
dayjs-
decodePathDecode a percent-encoded URL path (/posts/%E4%B8%AD → /posts/中).
defineAppSetup-
defineClientComponentDefine a component that only renders on the client side.
defineCollection-
defineMermaidSetup-
escapeHtmlEscape HTML special characters for safe interpolation into HTML text and quoted attributes.
extractMarkdownImageFirst content image, ignoring fenced code and the optional markdown title.
filterAndSortPostsPure function to filter and sort posts from page list Can be used in both composables and stores without inject() issues
formatDateformat the date (dayjs) with default timezone
getAddonDocsPath-
getAddonModuleCast a module namespace import to a plain type, breaking Rollup’s static binding analysis on import * as ns namespace objects.
getHeadersget headers from document directly
getLocaleMessageValueResolve a nested locale message value by dot-separated key.
hasLocaleMessageWhether a locale message exists for the given key.
initContext-
initValaxyConfig-
isCategoryListFor theme development, you can use this function to determine whether the category is a category list.
isEmptyAddon-
isLocaleKeyWhether the value is an explicit locale key like $locale:tag.notes.
isNotFoundPagePathPaths reserved for a site’s not-found document.
isReadmePage-
isSamePagePathCheck whether a page file path (/posts/中文.md, /guide/index.md) is the page shown at a browser pathname (/base/posts/%E4%B8%AD%E6%96%87).
isUnderscorePage-
isUnpublishedPageTrue when this source file must not become a public route.
joinBaseUrlJoin a Vite base URL and a route path while preserving protocol/relative prefixes and / separators.
localizeAddon-
mergeCollapsedCollectionsMerge 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.
mergePageExcludes-
normalizeAddonLocale-
normalizeExcludeGlobs-
normalizePagePath-
normalizeRepositoryUrlRemove git+ prefix from repository URL
omitProductionDraftRoutesDrop draft: true routes from a production route tree. Development keeps them so authors can preview. Mutates child arrays the same way the router setup always has.
onClickHref-
onContentUpdatedRegister callback that is called every time the markdown content is updated in the DOM.
openGraphTypeOpen Graph type for a Valaxy route. Posts are articles; other pages stay websites.
orderByMetasort posts by date
pageExcludeGlobsPicomatch globs for the file router. They are a fast path; route extension also drops these files so a custom exclude list cannot publish them by accident.
parseRangeString1,3-5,8 => [1, 3, 4, 5, 8]
pickPageShareImageKeep explicit legacy image ahead of the cover, as Yun’s article schema did.
pickShareImageFirst usable share image. The site favicon is not a candidate: it is often an SVG and is the same for every page.
plainSeoDescriptionPlain-text summary for meta descriptions and share cards. Fenced code, HTML comments, and images are removed. Headings are skipped so the title is not repeated as the description. Longer text is cut on a space when one is near the end, otherwise on the character limit, then marked with an ellipsis.
publicAuthorAuthor fields safe to publish on a site that did not set them. Empty email and link are omitted. Callers pass the resolved site author, so an address the site set explicitly is kept.
random生成介于 min 与 max 之间的随机数
relativePagePathPage path relative to a pages/ directory. pages/posts/hello.md and /abs/pages/posts/hello.md both become posts/hello.md.
removeItemFromCategoryremove item from category
resolveCanonicalPathKeep URL parameters while using the matched route’s trailing-slash convention.
resolveCollectionItemHrefResolve the href and external status for a collection item. link takes precedence over key. Internal links start with /.
resolveHeaders-
resolveShareImageResolve a share image against the page when it is relative, and against the site deployment path when it is root-absolute. Absolute URLs are unchanged.
resolveSiteUrlResolve an internal path against the configured canonical site URL. Root-absolute paths remain relative to a site URL’s deployment subpath.
resolveSocialSameAsPublic identity links only; this never changes the site’s social navigation.
resolveTaxonomyLocaleKeyResolve the effective locale key for a taxonomy term.
runCbs-
safeDecodeURISafely decode a URI, returning the original string on malformed sequences.
safeDecodeURIComponentSafely decode a URI component, returning the original string on malformed sequences.
safeParseUrlSafely parse a URL relative to an optional base, returning null on invalid syntax.
sanitizeUrlSanitize a URL so dangerous schemes like javascript:, vbscript:, or data:text/html cannot execute.
scrollToFor 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-
serializeInlineJsStringSerialize a string as an inline JavaScript string literal safe inside <script> tags.
setIframeAspectRatiosMake dimensioned iframes responsive without assuming a fixed video ratio. The generated custom property is consumed by the low-specificity markdown styles, so an author’s explicit height or aspect-ratio still takes priority.
sleep等待指定时间 (ms)
sortByDatesort posts by date
sortByUpdated-
stripEncryptedContentRemove private blocks before extracting any public text or image metadata.
stripLocalePrefixStrip $locale: prefix when present.
svgToPngExport a mounted, self-contained SVG’s current frame using the browser canvas.
throttleAndDebounce-
tObjecttranslate object
toZonedDayjsConvert a date using the same timezone rules as formatDate.
urlPathToMarkdownPathMap a route/URL path (e.g. '', '/', '/index', '/posts/hello/') to a collision-free raw Markdown href and relative file path. - '' / '/' (pages/index.md) -> /index.md (index.md) - '/index' (pages/index/index.md) -> /index/index.md (index/index.md) - '/index/index' -> /index/index/index.md (index/index/index.md) - Other routes keep ${normalized}.md.
useActiveAnchor-
useAddonConfigGet addon config from runtime config.
useBackback to previous page or home page
useBackToTopYou can use href="#" to back to top
useCategoriesget 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获取当前集合
useCollectionPostsGet posts belonging to a specific collection Sorted by the order defined in collection.items
useCollectionsComposable for Collections /collections/:collectionId/:slug
useConfigalias for useSite
useCopyCode-
useCopyMarkdownComposable for copying raw Markdown content of the current post. Requires siteConfig.llms.enable: true and siteConfig.llms.files: true to have .md files available at build output.
useDatainject pageData
useDecryptDecrypt ciphertext produced by encryptContent (valaxy/node).
useEncryptedContent获取加密文章数据
useEncryptedPhotosencryptedPhotos 获取加密相册数据
useFrontmatterGet route.meta.frontmatter from your markdown file
useFullUrlget full url
useFuseSearch-
useInvisibleElementtrigger show invisible element
useLayout-
useLocale-
useLocaleTitleget locale title
useLocalSearch-
useMediumZoom-
useMobileis mobile media query
useOutlineexport headers & handleClick to generate outline
usePageListget all page in 'pages' folder
usePageSeoDescription, canonical URL, share image, and Open Graph type for the current page. A page without frontmatter description uses the plain-text excerpt prepared at build time.
usePagination-
usePartiallyEncryptedContents获取部分加密内容
usePostCollectionsFind which collection(s) a given post path belongs to. Checks both key-based items (/collections/{collKey}/{item.key}) and internal link items (item.link).
usePostListget post list in 'pages/posts' folder
usePostListWithCollectionsGet 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-
usePrevNextget prev and next post
useRuntimeConfig-
useScreenSizebreakpoints ref https://tailwindcss.com/docs/screens
useSidebarhelper for sidebar
useSiteConfigget valaxy config
useTagsget tag map [tagName]: count
useValaxyApp-
useValaxyConfigget valaxy config
useValaxyDark-
useValaxyHead-
useValaxyI18n以 $locale: 开头的 key 会被认为是国际化的 key 会从 locales/ 目录中获取对应的翻译
withBaseAppend Vite’s resolved base to an internal root-absolute URL. External and relative URLs are returned unchanged.
wrapwrap node
wrapTable包裹表格,添加 class 以控制 table 样式