Documentation
¶
Overview ¶
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
templ: version: v0.3.1020
Index ¶
- func BookSwitchButtonClass(disabled bool) string
- func BookSwitchClick(bookID string) string
- func BookSwitchLabel() string
- func BookSwitchLeftIcon() templ.Component
- func BookSwitchNextLabel(disabled bool) string
- func BookSwitchPrevLabel(disabled bool) string
- func BookSwitchRightIcon() templ.Component
- func BookSwitchXData(forceReadMode string) string
- func DownloadButton(c echo.Context, book *model.Book) templ.Component
- func Drawer(c echo.Context, book *model.Book, beforeHistorySlot templ.Component, ...) templ.Component
- func Footer(version string) templ.Component
- func FullScreenOfflineButton() templ.Component
- func FullScreenOnlineButton() templ.Component
- func GetBookTitle(bookID string) string
- func GetFileBase64Text(bookID string, fileName string) string
- func GetPageTitle(bookID string, nowBookNum int, storeBookInfos []model.StoreBookInfo, ...) string
- func GetReturnUrl(BookID string) string
- func Header(left templ.Component, center templ.Component, right templ.Component) templ.Component
- func HeaderBackLeft(returnUrl string) templ.Component
- func HeaderBackSortLeft(returnUrl string) templ.Component
- func HeaderDefaultRight() templ.Component
- func HeaderEmptyTitle() templ.Component
- func HeaderPlaceholder() templ.Component
- func HeaderQuickJumpTitle(title string, currentBookID string, books *model.BookInfos) templ.Component
- func HeaderQuickJumpTitleView(title string, view BookSwitchView) templ.Component
- func HeaderSettingsLeft(returnUrl string) templ.Component
- func HeaderTextTitle(title string) templ.Component
- func HeaderTitle(title string, downloadLink string) templ.Component
- func Html(c echo.Context, bodyContent templ.Component, insertScripts []string) templ.Component
- func MessageModal() templ.Component
- func QRCode() templ.Component
- func QRCodeButton() templ.Component
- func QuickJumpBarBooks(b *model.Book) (list *model.BookInfos)
- func RawBookInfoURL(book model.BookInfo) string
- func RawBookURL(book *model.Book) string
- func ReSortIcon() templ.Component
- func ReadModeSelect() templ.Component
- func ReadModeSwitchButton() templ.Component
- func ReaderButton() templ.Component
- func ReadingHistory() templ.Component
- func ReadingHistoryWithLimit(limit int) templ.Component
- func RenderHTML(c echo.Context, component templ.Component) error
- func ReturnButton(returnUrl string) templ.Component
- func ServerSettingsButton() templ.Component
- func SettingDrawerButton() templ.Component
- func Toast() templ.Component
- func UploadButton() templ.Component
- type BookSwitchItem
- type BookSwitchView
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BookSwitchButtonClass ¶ added in v1.2.33
func BookSwitchClick ¶ added in v1.2.33
func BookSwitchLabel ¶ added in v1.2.33
func BookSwitchLabel() string
func BookSwitchLeftIcon ¶ added in v1.2.33
func BookSwitchNextLabel ¶ added in v1.2.33
func BookSwitchPrevLabel ¶ added in v1.2.33
func BookSwitchRightIcon ¶ added in v1.2.33
func BookSwitchXData ¶ added in v1.2.33
BookSwitchXData 生成切换脚本。forceReadMode 为空时沿用当前阅读模式;传入 scroll/flip 时先锁定目标阅读模式。
func DownloadButton ¶ added in v1.2.0
DownloadButton 下载按钮组件
func FullScreenOfflineButton ¶ added in v1.2.26
全屏按钮 offlineBook
func FullScreenOnlineButton ¶ added in v1.2.26
全屏按钮 onlineBook
func GetFileBase64Text ¶ added in v1.1.0
func GetPageTitle ¶
func GetPageTitle(bookID string, nowBookNum int, storeBookInfos []model.StoreBookInfo, childBookInfos []model.BookInfo) string
GetPageTitle 获取页面标题
func HeaderBackLeft ¶ added in v1.2.26
HeaderBackLeft 是常见左侧区域:返回按钮 + 离线全屏。
func HeaderBackSortLeft ¶ added in v1.2.26
HeaderBackSortLeft 是阅读页左侧区域:返回按钮 + 离线全屏 + 排序。
func HeaderDefaultRight ¶ added in v1.2.26
HeaderDefaultRight 是原 Header 右侧默认工具区:二维码、在线全屏、阅读器设置。
func HeaderEmptyTitle ¶ added in v1.2.26
HeaderEmptyTitle 定义了一个空标题组件,用于占位,使得标题区域保持居中对齐。这个组件不显示任何文本,也没有链接,纯粹作为布局占位符使用。
func HeaderQuickJumpTitle ¶ added in v1.2.26
func HeaderQuickJumpTitle(title string, currentBookID string, books *model.BookInfos) templ.Component
HeaderQuickJumpTitle 定义阅读页标题区;有同级可切换书籍时显示居中的有限宽 select。
func HeaderQuickJumpTitleView ¶ added in v1.2.33
func HeaderQuickJumpTitleView(title string, view BookSwitchView) templ.Component
func HeaderSettingsLeft ¶ added in v1.2.26
HeaderSettingsLeft 是设置页左侧区域:返回 + 离线全屏 + 本地阅读入口 + 占位。
func HeaderTextTitle ¶ added in v1.2.26
func HeaderTitle ¶ added in v1.1.5
HeaderTitle 保留原普通标题行为:离线文件显示标题,在线模式同步 document.title。
func MessageModal ¶
func RawBookInfoURL ¶ added in v1.2.33
RawBookInfoURL 根据 BookInfo 生成原始文件访问地址。 前端播放器、HTML 直出等场景只需要稳定的公开 URL,不需要知道本地 BookPath。
func RawBookURL ¶ added in v1.2.33
RawBookURL 生成单文件书籍的原始文件访问地址。 HTML/音视频这类单文件内容不需要阅读模板时,应跳转到该地址交给 raw API 返回源文件。
func ReSortIcon ¶ added in v1.1.5
ReSortIcon 定义了一个排序图标,点击后会显示一个下拉菜单,允许用户选择不同的排序方式。根据当前URL路径,菜单会设置不同的cookie参数名来保存用户的选择,并在页面加载时读取该cookie以确定当前的排序方式。
func ReadModeSelect ¶ added in v1.1.0
ReadModeSelect 切换书架打开书籍时使用的阅读模式。
func ReadModeSwitchButton ¶ added in v1.1.0
func ReadingHistory ¶ added in v1.1.8
ReadingHistory 阅读历史记录列表组件(限制显示数量,默认10条) 用于各个页面的 drawer 侧边栏
func ReadingHistoryWithLimit ¶ added in v1.2.11
ReadingHistoryWithLimit 阅读历史记录列表组件(可指定限制数量) 调用 /api/reading-history?limit=X 获取数据,后端已完成过滤和排序
func RenderHTML ¶ added in v1.2.30
RenderHTML 将 templ 组件直接写入 Echo 响应。 页面级 handler 统一通过这里处理渲染错误,避免重复 500 响应逻辑。
func ReturnButton ¶ added in v1.2.26
返回箭头,点击返回上一页
func ServerSettingsButton ¶ added in v1.2.26
服务器设置按钮,点击进入Comigo设置页面
func SettingDrawerButton ¶ added in v1.2.26
阅读器设定,点击屏幕中央也可以打开 可自定义方向 --> data-drawer-body-scrolling="true" 允许打开抽屉时继续滚动底层页面,避免背景布局抖动。
Types ¶
type BookSwitchItem ¶ added in v1.2.33
type BookSwitchView ¶ added in v1.2.33
type BookSwitchView struct {
Items []BookSwitchItem
PrevID string
NextID string
}
func NewBookSwitchView ¶ added in v1.2.33
func NewBookSwitchView(currentBookID string, books *model.BookInfos) BookSwitchView
NewBookSwitchView 把同级书籍列表整理成 header 和卷轴底部共用的切换视图。 只保留能进入图片/文本阅读页的条目,避免箭头或 select 跳到书籍组、音频、视频。
func (BookSwitchView) HasSwitchTarget ¶ added in v1.2.33
func (view BookSwitchView) HasSwitchTarget() bool
HasSwitchTarget 判断是否存在当前书以外的可切换目标。