Paw Docs
Paw 文档

A hybrid docs index: start with a guided page, then jump into focused API reference pages.

这是一个混合式文档索引:先用引导页完成入门,再跳转到聚焦的 API 参考页。

Every page follows the same shape: purpose, covered APIs, a minimal example, an advanced example or gotcha, and source links.

每个页面都采用相同结构:用途说明、涵盖 API、最小示例、进阶示例或注意事项,以及源码链接。
Onboarding
入门

Getting Started

快速开始

Boot a Paw page with asset serving, a standard shell, and a first render path.

从静态资源、标准页面壳和首个渲染流程开始搭起一个 Paw 页面。
paw.PathAssetspaw.NewAssetsHttpHandler()paw.RenderHeader()paw.Containerpaw.RenderDefaultFooter()

Open page

Page Shell and Assets

页面壳与静态资源

Serve bundled assets and wrap each page with the default Paw header and footer.

为 Paw 内置资源提供服务,并用默认页头页脚包裹每个页面。
paw.PathAssetspaw.NewAssetsHttpHandler()paw.HeaderConfigpaw.RenderHeader()paw.RenderDefaultFooter()

Open page

Rendering
渲染

Core Primitives

核心原语

The low-level building blocks for composing escaped text, raw HTML, inline code, and headings.

用于组合转义文本、原始 HTML、内联代码和标题的底层构件。
paw.Listpaw.Stringpaw.Htmlpaw.Tagpaw.Boldpaw.PreCode

Open page

Layout and Navigation

布局与导航

Compose responsive layouts, links, navigation, and progressive disclosure patterns.

组合响应式布局、链接、导航以及渐进展示类交互。
paw.Containerpaw.Rowpaw.Panelpaw.Linkpaw.Navbarpaw.Dialog

Open page

Forms
表单

Forms Basic

基础表单

Use manual form controls when model-driven generation is not the right fit.

当模型驱动生成不适合时,直接使用手写表单控件。
paw.Formpaw.Inputpaw.Checkboxpaw.Selectpaw.MultiSelectpaw.BitMask

Open page

Forms Generated

生成式表单

Generate forms from structs, override field options, and convert submitted values back into models.

从结构体生成表单、覆盖字段选项,并把提交值转换回模型。
paw.Gen()paw.KvConvert()paw.List.SelectOptions()paw.List.BitMaskOptions()paw.List.Readonly()

Open page

Rich Text Editor

富文本编辑器

Configure HugeRTE-backed rich text fields and wire image/video uploads into a normal Paw form.

配置基于 HugeRTE 的富文本字段,并把图片和视频上传接入普通 Paw 表单。
paw.RichTextEditorpaw.RichTextEditorConfigpaw.Formpaw.Gen()paw.List.RichTextEditorConfig()

Open page

Display
展示

Tables

表格

Render compact or rich tables and override individual cells when needed.

渲染紧凑或富信息表格,并在需要时覆盖单元格行为。
paw.Tablepaw.Tdpaw.StringNoWrappaw.Small

Open page

Status and Media

状态与媒体

Show alerts, badges, icons, images, and the shared color tokens used across Paw.

展示提示框、徽章、图标、图片,以及 Paw 里通用的颜色常量。
paw.Alertpaw.Badgepaw.Iconpaw.Img

Open page

Charts

图表

Build time-series and categorical charts with shared data formatting helpers.

借助通用数据格式化能力构建时序图和分类图表。
paw.ChartLineTimepaw.ChartBarpaw.ChartDataTypeBytepaw.ChartDataTypeBitRate

Open page

Math

数学

Render TeX formulae with the built-in KaTeX integration.

通过内置的 KaTeX 集成渲染 TeX 数学公式。
paw.KaTeX

Open page