templates

package
v1.18.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 19, 2023 License: MIT Imports: 43 Imported by: 138

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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 added in v1.14.0

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

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

func AvatarByAction added in v1.14.0

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

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

func AvatarByEmail added in v1.14.0

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

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

func AvatarHTML added in v1.14.0

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

AvatarHTML creates the HTML for an avatar

func BuiltinAsset added in v1.17.4

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

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

func BuiltinAssetNames added in v1.17.4

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 added in v1.16.5

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 added in v1.3.3

func Escape(raw string) string

Escape escapes a HTML string

func GetAsset added in v1.14.0

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

GetAsset returns asset content via name

func GetAssetFilename added in v1.17.4

func GetAssetFilename(name string) (string, error)

GetAssetFilename returns the filename of the provided asset

func GetTemplateAssetNames added in v1.17.4

func GetTemplateAssetNames() []string

GetTemplateAssetNames returns list of template names

func HTMLRenderer added in v1.6.0

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 added in v1.4.0

func IsMultilineCommitMessage(msg string) bool

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

func JSEscape added in v1.14.0

func JSEscape(raw string) string

JSEscape escapes a JS string

func JsPrettyNumber added in v1.17.0

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

Mailer provides the templates required for sending notification mails.

func MigrationIcon added in v1.10.0

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 added in v1.11.0

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 added in v1.12.0

func ReactionToEmoji(reaction string) template.HTML

ReactionToEmoji renders emoji for use in reactions

func RenderCodeBlock added in v1.17.4

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 added in v1.4.0

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(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 added in v1.10.0

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 added in v1.12.0

func RenderEmoji(text string) template.HTML

RenderEmoji renders html text with emoji post processors

func RenderIssueTitle added in v1.14.0

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 added in v1.9.0

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 added in v1.14.0

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

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

func SVG added in v1.13.0

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 added in v1.2.0

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 added in v1.14.0

type Vars map[string]interface{}

Vars represents variables to be render in golang templates

func BaseVars added in v1.14.0

func BaseVars() Vars

BaseVars returns all basic vars

func (Vars) Merge added in v1.14.0

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

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL