Documentation
¶
Index ¶
- func APIResponseWithMessage(c *gin.Context, code, msg string, data interface{})
- func ConfigureMessage(options ...func(*Config))
- func DelayedMessage(c *gin.Context, title, content, msgType string, delay time.Duration, ...)
- func Error(c *gin.Context, title, content string, options ...func(*Data))
- func Info(c *gin.Context, title, content string, options ...func(*Data))
- func Render(c *gin.Context, title, content, msgType string, options ...func(*Data))
- func RenderMessageWithRenderer(c *gin.Context, title, content, msgType string, renderer Renderer, ...)
- func SetGlobalConfigPath(path string)
- func SetGlobalRenderer(renderer Renderer)
- func SetMessageTemplate(templateContent string) error
- func Simple(c *gin.Context, content string, isSuccess bool)
- func Success(c *gin.Context, title, content string, options ...func(*Data))
- func Warning(c *gin.Context, title, content string, options ...func(*Data))
- func WithAutoRedirect(enabled bool) func(*Data)
- func WithDefaultMessageType(msgType string) func(*Config)
- func WithMessageAutoRedirect(auto bool) func(*Config)
- func WithMessageTitlePrefix(prefix string) func(*Config)
- func WithMessageTitleSuffix(suffix string) func(*Config)
- func WithRedirect(url string) func(*Data)
- func WithReferer(referer string) func(*Data)
- func WithTemplateContent(content string) func(*Config)
- func WithTemplatePath(path string) func(*Config)
- type Config
- type ConfigManager
- type Data
- type DefaultMessageRenderer
- type Renderer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func APIResponseWithMessage ¶
APIResponseWithMessage API响应包含消息
func DelayedMessage ¶
func DelayedMessage(c *gin.Context, title, content, msgType string, delay time.Duration, options ...func(*Data))
DelayedMessage 延迟消息(用于需要等待的操作)
func RenderMessageWithRenderer ¶
func RenderMessageWithRenderer(c *gin.Context, title, content, msgType string, renderer Renderer, options ...func(*Data))
RenderMessageWithRenderer 使用指定渲染器渲染消息
func SetMessageTemplate ¶
SetMessageTemplate 设置消息模板
func WithDefaultMessageType ¶
WithDefaultMessageType 设置默认消息类型
func WithMessageAutoRedirect ¶
WithMessageAutoRedirect 设置自动跳转
func WithMessageTitlePrefix ¶
WithMessageTitlePrefix 设置标题前缀
func WithMessageTitleSuffix ¶
WithMessageTitleSuffix 设置标题后缀
func WithTemplateContent ¶
WithTemplateContent 设置模板内容
Types ¶
type Config ¶
type Config struct {
TemplatePath string `json:"template_path"` // 模板文件路径(可选)
TemplateContent string `json:"template_content"` // 模板内容(优先使用)
AutoRedirect bool `json:"auto_redirect"` // 是否自动跳转
DefaultType string `json:"default_type"` // 默认消息类型
TitlePrefix string `json:"title_prefix"` // 标题前缀
TitleSuffix string `json:"title_suffix"` // 标题后缀
}
Config 消息配置结构
type ConfigManager ¶
type ConfigManager struct {
// contains filtered or unexported fields
}
ConfigManager 配置管理器
func GetGlobalConfigManager ¶
func GetGlobalConfigManager() *ConfigManager
GetGlobalConfigManager 获取全局配置管理器
func NewMessageConfigManager ¶
func NewMessageConfigManager(configPath string) *ConfigManager
NewMessageConfigManager 创建配置管理器
func (*ConfigManager) ApplyConfig ¶
func (m *ConfigManager) ApplyConfig() error
ApplyConfig 应用配置到渲染器
func (*ConfigManager) UpdateConfig ¶
func (m *ConfigManager) UpdateConfig(updates map[string]interface{}) error
UpdateConfig 更新配置
type Data ¶
type Data struct {
Title string // 标题
Content string // 内容
Type string // 类型:success, error, info
Referer string // 返回链接
RedirectURL string // 跳转链接
AutoRedirect bool // 是否自动跳转
AutoRedirectSet bool // 是否显式设置自动跳转
}
Data 消息提示数据结构
type DefaultMessageRenderer ¶
type DefaultMessageRenderer struct {
// contains filtered or unexported fields
}
DefaultMessageRenderer 默认消息渲染器实现
func NewDefaultMessageRenderer ¶
func NewDefaultMessageRenderer() *DefaultMessageRenderer
NewDefaultMessageRenderer 创建默认消息渲染器
func (*DefaultMessageRenderer) GetTemplate ¶
func (r *DefaultMessageRenderer) GetTemplate() string
GetTemplate 获取当前模板内容(用于调试)
func (*DefaultMessageRenderer) Render ¶
func (r *DefaultMessageRenderer) Render(c *gin.Context, data *Data) error
Render 渲染消息页面
func (*DefaultMessageRenderer) SetTemplate ¶
func (r *DefaultMessageRenderer) SetTemplate(tpl string) error
SetTemplate 设置自定义模板
Click to show internal directories.
Click to hide internal directories.