Components

Valaxy has several simple components built in.

You can use them directly when writing articles or themes.

TIP

Based on Vue components

Basic Components

INFO

Built for theme developers (common users usually do not need to use them directly)

Layout and Rendering

Others

md
<ValaxyLogo />
Valaxy Logo

Helper Components

内置组件

For users, can be used directly.

You can also extend public components by valaxy-addon-components.

Internationalization Component <VT />

locales/zh-CN.yml
yaml
menu:
  posts: 博客文章
locales/en.yml
yaml
menu:
  posts: Posts
md
<!-- auto follow locale -->
<VT content="menu.posts" />
Posts

扩展公共组件

pnpm
bash
pnpm add valaxy-addon-components

如:

  • CodePen: CodePen code snippets
  • VCLiveTime: The establishment time of the site
pages/posts/your-post.md
md
My Blog Content

<CodePen class="h-300px" name="Margin Collapse" id="WqXGpo" user="YunYouJun" tab="html,result" />

My Blog Content

See the Pen Margin Collapse by YunYouJun (@YunYouJun) on CodePen.

Debug Component

<ValaxyDebug />

Valaxy has a built-in <ValaxyDebug /> debug panel component that is only available in development mode (completely removed in production builds, zero overhead).

This component displays a collapsible floating panel in the bottom-left corner of the page, providing the following debug information:

  • Breakpoints: Currently active responsive breakpoints (xs / sm / md / lg / xl / 2xl)
  • Route: Current route information (path, name, layout, query, params)
  • Frontmatter: Current page frontmatter data (JSON format)
  • Config: Site configuration summary and theme configuration

Usage

Use it directly in your theme or layout (no import needed, it’s globally registered):

vue
<template>
  <div>
    <!-- your page content -->
    <ValaxyDebug />
  </div>
</template>

TIP

<ValaxyDebug /> is loaded asynchronously via defineAsyncComponent and guarded by import.meta.env.DEV, so it has zero impact on production bundle size.

Custom

For more usage, please refer to Custom Components.


To Be Continued.

Contributors