templates

Documentation

Index

• func ActionContent2Commits(act Actioner) *repository.PushCommits
• func ActionIcon(opType activities_model.ActionType) string
• func Avatar(item interface{}, others ...interface{}) template.HTML
• func AvatarByAction(action *activities_model.Action, others ...interface{}) template.HTML
• func AvatarByEmail(email, name string, others ...interface{}) template.HTML
• func AvatarHTML(src string, size int, class, name string) template.HTML
• func BuiltinAsset(name string) ([]byte, error)
• func BuiltinAssetNames() []string
• func DiffLineTypeToStr(diffType int) string
• func DiffTypeToStr(diffType int) string
• func DotEscape(raw string) string
• func Escape(raw string) string
• func GetAsset(name string) ([]byte, error)
• func GetAssetFilename(name string) (string, error)
• func GetTemplateAssetNames() []string
• func HTMLRenderer(ctx context.Context) (context.Context, *render.Render)
• func IsMultilineCommitMessage(msg string) bool
• func JSEscape(raw string) string
• func JsPrettyNumber(i interface{}) template.HTML
• func Mailer(ctx context.Context) (*texttmpl.Template, *template.Template)
• func MigrationIcon(hostname string) string
• func NewFuncMap() []template.FuncMap
• func NewTextFuncMap() []texttmpl.FuncMap
• func ReactionToEmoji(reaction string) template.HTML
• func RenderCodeBlock(htmlEscapedTextToRender template.HTML) template.HTML
• func RenderCommitBody(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML
• func RenderCommitMessage(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML
• func RenderCommitMessageLink(ctx context.Context, msg, urlPrefix, urlDefault string, ...) template.HTML
• func RenderCommitMessageLinkSubject(ctx context.Context, msg, urlPrefix, urlDefault string, ...) template.HTML
• func RenderEmoji(text string) template.HTML
• func RenderIssueTitle(ctx context.Context, text, urlPrefix string, metas map[string]string) template.HTML
• func RenderNote(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML
• func RepoAvatar(repo *repo_model.Repository, others ...interface{}) template.HTML
• func SVG(icon string, others ...interface{}) template.HTML
• func Safe(raw string) template.HTML
• func SafeJS(raw string) template.JS
• func Str2html(raw string) template.HTML
• type Actioner
• type Vars
  • func BaseVars() Vars
  • func (vars Vars) Merge(another map[string]interface{}) Vars

Functions

func ActionContent2Commits

func ActionContent2Commits(act Actioner) *repository.PushCommits

ActionContent2Commits converts action content to push commits

func ActionIcon

func ActionIcon(opType activities_model.ActionType) string

ActionIcon accepts an action operation type and returns an icon class name.

func Avatar

func Avatar(item interface{}, others ...interface{}) template.HTML

Avatar renders user avatars. args: user, size (int), class (string)

func AvatarByAction

func AvatarByAction(action *activities_model.Action, others ...interface{}) template.HTML

AvatarByAction renders user avatars from action. args: action, size (int), class (string)

func AvatarByEmail

func AvatarByEmail(email, name string, others ...interface{}) template.HTML

AvatarByEmail renders avatars by email address. args: email, name, size (int), class (string)

func AvatarHTML

func AvatarHTML(src string, size int, class, name string) template.HTML

AvatarHTML creates the HTML for an avatar

func BuiltinAsset

func BuiltinAsset(name string) ([]byte, error)

BuiltinAsset will read the provided asset from the embedded assets (This always returns os.ErrNotExist)

func BuiltinAssetNames

func BuiltinAssetNames() []string

BuiltinAssetNames returns the names of the embedded assets (This always returns nil)

func DiffLineTypeToStr

func DiffLineTypeToStr(diffType int) string

DiffLineTypeToStr returns diff line type name

func DiffTypeToStr

func DiffTypeToStr(diffType int) string

DiffTypeToStr returns diff type name

func DotEscape

func DotEscape(raw string) string

DotEscape wraps a dots in names with ZWJ [U+200D] in order to prevent autolinkers from detecting these as urls

func Escape

func Escape(raw string) string

Escape escapes a HTML string

func GetAsset

func GetAsset(name string) ([]byte, error)

GetAsset returns asset content via name

func GetAssetFilename

func GetAssetFilename(name string) (string, error)

GetAssetFilename returns the filename of the provided asset

func GetTemplateAssetNames

func GetTemplateAssetNames() []string

GetTemplateAssetNames returns list of template names

func HTMLRenderer

func HTMLRenderer(ctx context.Context) (context.Context, *render.Render)

HTMLRenderer returns the current html renderer for the context or creates and stores one within the context for future use

func IsMultilineCommitMessage

func IsMultilineCommitMessage(msg string) bool

IsMultilineCommitMessage checks to see if a commit message contains multiple lines.

func JSEscape

func JSEscape(raw string) string

JSEscape escapes a JS string

func JsPrettyNumber

func JsPrettyNumber(i interface{}) template.HTML

JsPrettyNumber renders a number using english decimal separators, e.g. 1,200 and subsequent JS will replace the number with locale-specific separators, based on the user's selected language

func Mailer

func Mailer(ctx context.Context) (*texttmpl.Template, *template.Template)

Mailer provides the templates required for sending notification mails.

func MigrationIcon

func MigrationIcon(hostname string) string

MigrationIcon returns a SVG name matching the service an issue/comment was migrated from

func NewFuncMap

func NewFuncMap() []template.FuncMap

NewFuncMap returns functions for injecting to templates

func NewTextFuncMap

func NewTextFuncMap() []texttmpl.FuncMap

NewTextFuncMap returns functions for injecting to text templates It's a subset of those used for HTML and other templates

func ReactionToEmoji

func ReactionToEmoji(reaction string) template.HTML

ReactionToEmoji renders emoji for use in reactions

func RenderCodeBlock

func RenderCodeBlock(htmlEscapedTextToRender template.HTML) template.HTML

RenderCodeBlock renders "`…`" as highlighted "<code>" block. Intended for issue and PR titles, these containers should have styles for "<code>" elements

func RenderCommitBody

func RenderCommitBody(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML

RenderCommitBody extracts the body of a commit message without its title.

func RenderCommitMessage

func RenderCommitMessage(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML

RenderCommitMessage renders commit message with XSS-safe and special links.

func RenderCommitMessageLink

func RenderCommitMessageLink(ctx context.Context, msg, urlPrefix, urlDefault string, metas map[string]string) template.HTML

RenderCommitMessageLink renders commit message as a XXS-safe link to the provided default url, handling for special links.

func RenderCommitMessageLinkSubject

func RenderCommitMessageLinkSubject(ctx context.Context, msg, urlPrefix, urlDefault string, metas map[string]string) template.HTML

RenderCommitMessageLinkSubject renders commit message as a XXS-safe link to the provided default url, handling for special links without email to links.

func RenderEmoji

func RenderEmoji(text string) template.HTML

RenderEmoji renders html text with emoji post processors

func RenderIssueTitle

func RenderIssueTitle(ctx context.Context, text, urlPrefix string, metas map[string]string) template.HTML

RenderIssueTitle renders issue/pull title with defined post processors

func RenderNote

func RenderNote(ctx context.Context, msg, urlPrefix string, metas map[string]string) template.HTML

RenderNote renders the contents of a git-notes file as a commit message.

func RepoAvatar

func RepoAvatar(repo *repo_model.Repository, others ...interface{}) template.HTML

RepoAvatar renders repo avatars. args: repo, size(int), class (string)

func SVG

func SVG(icon string, others ...interface{}) template.HTML

SVG render icons - arguments icon name (string), size (int), class (string)

func Safe

func Safe(raw string) template.HTML

Safe render raw as HTML

func SafeJS

func SafeJS(raw string) template.JS

SafeJS renders raw as JS

func Str2html

func Str2html(raw string) template.HTML

Str2html render Markdown text to HTML

Types

type Actioner

type Actioner interface {
	GetOpType() activities_model.ActionType
	GetActUserName() string
	GetRepoUserName() string
	GetRepoName() string
	GetRepoPath() string
	GetRepoLink() string
	GetBranch() string
	GetContent() string
	GetCreate() time.Time
	GetIssueInfos() []string
}

Actioner describes an action

type Vars

type Vars map[string]interface{}

Vars represents variables to be render in golang templates

func BaseVars

func BaseVars() Vars

BaseVars returns all basic vars

func (Vars) Merge

func (vars Vars) Merge(another map[string]interface{}) Vars

Merge merges another vars to the current, another Vars will override the current