octicon

package module
v0.0.0-...-8b8d446 Latest Latest
Warning

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

 Go to latest Published: Dec 8, 2019 License: MIT Imports: 2 Imported by: 0

README

octicon

https://octicons.github.com/
Credit to shurcooL for a lot of the groundwork for this library.
The original source of this library is his octicon library.

Installation

go get -u gitea.com/go-icon/octicon

Usage

icon := octicon.Alert()

// Get the raw XML
xml := icon.XML()

// Get something suitable to pass directly to an html/template
html := icon.HTML()

Build

go generate generate.go

New Versions

To update the version of octicons, simply change octiconVersion in octicon_generate.go and re-build.

License

MIT License

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Icons = []string{} /* 196 elements not displayed */

Icons is a list of all Feather icons

Functions

This section is empty.

Types

type Octicon 

type Octicon struct {
	// contains filtered or unexported fields
}

Octicon represents an SVG node

func Alert 

func Alert() *Octicon

Alert returns the "alert" Octicon.

func Archive 

func Archive() *Octicon

Archive returns the "archive" Octicon.

func ArrowBoth 

func ArrowBoth() *Octicon

ArrowBoth returns the "arrow-both" Octicon.

func ArrowDown 

func ArrowDown() *Octicon

ArrowDown returns the "arrow-down" Octicon.

func ArrowLeft 

func ArrowLeft() *Octicon

ArrowLeft returns the "arrow-left" Octicon.

func ArrowRight 

func ArrowRight() *Octicon

ArrowRight returns the "arrow-right" Octicon.

func ArrowSmallDown 

func ArrowSmallDown() *Octicon

ArrowSmallDown returns the "arrow-small-down" Octicon.

func ArrowSmallLeft 

func ArrowSmallLeft() *Octicon

ArrowSmallLeft returns the "arrow-small-left" Octicon.

func ArrowSmallRight 

func ArrowSmallRight() *Octicon

ArrowSmallRight returns the "arrow-small-right" Octicon.

func ArrowSmallUp 

func ArrowSmallUp() *Octicon

ArrowSmallUp returns the "arrow-small-up" Octicon.

func ArrowUp 

func ArrowUp() *Octicon

ArrowUp returns the "arrow-up" Octicon.

func Beaker 

func Beaker() *Octicon

Beaker returns the "beaker" Octicon.

func Bell 

func Bell() *Octicon

Bell returns the "bell" Octicon.

func Bold 

func Bold() *Octicon

Bold returns the "bold" Octicon.

func Book 

func Book() *Octicon

Book returns the "book" Octicon.

func Bookmark 

func Bookmark() *Octicon

Bookmark returns the "bookmark" Octicon.

func Briefcase 

func Briefcase() *Octicon

Briefcase returns the "briefcase" Octicon.

func Broadcast 

func Broadcast() *Octicon

Broadcast returns the "broadcast" Octicon.

func Browser 

func Browser() *Octicon

Browser returns the "browser" Octicon.

func Bug 

func Bug() *Octicon

Bug returns the "bug" Octicon.

func Calendar 

func Calendar() *Octicon

Calendar returns the "calendar" Octicon.

func Check 

func Check() *Octicon

Check returns the "check" Octicon.

func Checklist 

func Checklist() *Octicon

Checklist returns the "checklist" Octicon.

func ChevronDown 

func ChevronDown() *Octicon

ChevronDown returns the "chevron-down" Octicon.

func ChevronLeft 

func ChevronLeft() *Octicon

ChevronLeft returns the "chevron-left" Octicon.

func ChevronRight 

func ChevronRight() *Octicon

ChevronRight returns the "chevron-right" Octicon.

func ChevronUp 

func ChevronUp() *Octicon

ChevronUp returns the "chevron-up" Octicon.

func CircleSlash 

func CircleSlash() *Octicon

CircleSlash returns the "circle-slash" Octicon.

func CircuitBoard 

func CircuitBoard() *Octicon

CircuitBoard returns the "circuit-board" Octicon.

func Clippy 

func Clippy() *Octicon

Clippy returns the "clippy" Octicon.

func Clock 

func Clock() *Octicon

Clock returns the "clock" Octicon.

func CloudDownload 

func CloudDownload() *Octicon

CloudDownload returns the "cloud-download" Octicon.

func CloudUpload 

func CloudUpload() *Octicon

CloudUpload returns the "cloud-upload" Octicon.

func Code 

func Code() *Octicon

Code returns the "code" Octicon.

func Comment 

func Comment() *Octicon

Comment returns the "comment" Octicon.

func CommentDiscussion 

func CommentDiscussion() *Octicon

CommentDiscussion returns the "comment-discussion" Octicon.

func CreditCard 

func CreditCard() *Octicon

CreditCard returns the "credit-card" Octicon.

func Dash 

func Dash() *Octicon

Dash returns the "dash" Octicon.

func Dashboard 

func Dashboard() *Octicon

Dashboard returns the "dashboard" Octicon.

func Database 

func Database() *Octicon

Database returns the "database" Octicon.

func Dependent 

func Dependent() *Octicon

Dependent returns the "dependent" Octicon.

func DesktopDownload 

func DesktopDownload() *Octicon

DesktopDownload returns the "desktop-download" Octicon.

func DeviceCamera 

func DeviceCamera() *Octicon

DeviceCamera returns the "device-camera" Octicon.

func DeviceCameraVideo 

func DeviceCameraVideo() *Octicon

DeviceCameraVideo returns the "device-camera-video" Octicon.

func DeviceDesktop 

func DeviceDesktop() *Octicon

DeviceDesktop returns the "device-desktop" Octicon.

func DeviceMobile 

func DeviceMobile() *Octicon

DeviceMobile returns the "device-mobile" Octicon.

func Diff 

func Diff() *Octicon

Diff returns the "diff" Octicon.

func DiffAdded 

func DiffAdded() *Octicon

DiffAdded returns the "diff-added" Octicon.

func DiffIgnored 

func DiffIgnored() *Octicon

DiffIgnored returns the "diff-ignored" Octicon.

func DiffModified 

func DiffModified() *Octicon

DiffModified returns the "diff-modified" Octicon.

func DiffRemoved 

func DiffRemoved() *Octicon

DiffRemoved returns the "diff-removed" Octicon.

func DiffRenamed 

func DiffRenamed() *Octicon

DiffRenamed returns the "diff-renamed" Octicon.

func Ellipsis 

func Ellipsis() *Octicon

Ellipsis returns the "ellipsis" Octicon.

func Eye 

func Eye() *Octicon

Eye returns the "eye" Octicon.

func EyeClosed 

func EyeClosed() *Octicon

EyeClosed returns the "eye-closed" Octicon.

func File 

func File() *Octicon

File returns the "file" Octicon.

func FileBinary 

func FileBinary() *Octicon

FileBinary returns the "file-binary" Octicon.

func FileCode 

func FileCode() *Octicon

FileCode returns the "file-code" Octicon.

func FileDirectory 

func FileDirectory() *Octicon

FileDirectory returns the "file-directory" Octicon.

func FileMedia 

func FileMedia() *Octicon

FileMedia returns the "file-media" Octicon.

func FilePdf 

func FilePdf() *Octicon

FilePdf returns the "file-pdf" Octicon.

func FileSubmodule 

func FileSubmodule() *Octicon

FileSubmodule returns the "file-submodule" Octicon.

func FileSymlinkDirectory 

func FileSymlinkDirectory() *Octicon

FileSymlinkDirectory returns the "file-symlink-directory" Octicon.

func FileSymlinkFile 

func FileSymlinkFile() *Octicon

FileSymlinkFile returns the "file-symlink-file" Octicon.

func FileZip 

func FileZip() *Octicon

FileZip returns the "file-zip" Octicon.

func Flame 

func Flame() *Octicon

Flame returns the "flame" Octicon.

func Fold 

func Fold() *Octicon

Fold returns the "fold" Octicon.

func FoldDown 

func FoldDown() *Octicon

FoldDown returns the "fold-down" Octicon.

func FoldUp 

func FoldUp() *Octicon

FoldUp returns the "fold-up" Octicon.

func Gear 

func Gear() *Octicon

Gear returns the "gear" Octicon.

func Gift 

func Gift() *Octicon

Gift returns the "gift" Octicon.

func Gist 

func Gist() *Octicon

Gist returns the "gist" Octicon.

func GistSecret 

func GistSecret() *Octicon

GistSecret returns the "gist-secret" Octicon.

func GitBranch 

func GitBranch() *Octicon

GitBranch returns the "git-branch" Octicon.

func GitCommit 

func GitCommit() *Octicon

GitCommit returns the "git-commit" Octicon.

func GitCompare 

func GitCompare() *Octicon

GitCompare returns the "git-compare" Octicon.

func GitMerge 

func GitMerge() *Octicon

GitMerge returns the "git-merge" Octicon.

func GitPullRequest 

func GitPullRequest() *Octicon

GitPullRequest returns the "git-pull-request" Octicon.

func GithubAction 

func GithubAction() *Octicon

GithubAction returns the "github-action" Octicon.

func Globe 

func Globe() *Octicon

Globe returns the "globe" Octicon.

func Grabber 

func Grabber() *Octicon

Grabber returns the "grabber" Octicon.

func Graph 

func Graph() *Octicon

Graph returns the "graph" Octicon.

func Heart 

func Heart() *Octicon

Heart returns the "heart" Octicon.

func History 

func History() *Octicon

History returns the "history" Octicon.

func Home 

func Home() *Octicon

Home returns the "home" Octicon.

func HorizontalRule 

func HorizontalRule() *Octicon

HorizontalRule returns the "horizontal-rule" Octicon.

func Hubot 

func Hubot() *Octicon

Hubot returns the "hubot" Octicon.

func Icon 

func Icon(name string) *Octicon

Icon returns the named Octicon SVG node. It returns nil if name is not a valid Octicon symbol name.

func Inbox 

func Inbox() *Octicon

Inbox returns the "inbox" Octicon.

func Info 

func Info() *Octicon

Info returns the "info" Octicon.

func IssueClosed 

func IssueClosed() *Octicon

IssueClosed returns the "issue-closed" Octicon.

func IssueOpened 

func IssueOpened() *Octicon

IssueOpened returns the "issue-opened" Octicon.

func IssueReopened 

func IssueReopened() *Octicon

IssueReopened returns the "issue-reopened" Octicon.

func Italic 

func Italic() *Octicon

Italic returns the "italic" Octicon.

func Jersey 

func Jersey() *Octicon

Jersey returns the "jersey" Octicon.

func KebabHorizontal 

func KebabHorizontal() *Octicon

KebabHorizontal returns the "kebab-horizontal" Octicon.

func KebabVertical 

func KebabVertical() *Octicon

KebabVertical returns the "kebab-vertical" Octicon.

func Key 

func Key() *Octicon

Key returns the "key" Octicon.

func Keyboard 

func Keyboard() *Octicon

Keyboard returns the "keyboard" Octicon.

func Law 

func Law() *Octicon

Law returns the "law" Octicon.

func LightBulb 

func LightBulb() *Octicon

LightBulb returns the "light-bulb" Octicon. 

func Link() *Octicon

Link returns the "link" Octicon.

func LinkExternal 

func LinkExternal() *Octicon

LinkExternal returns the "link-external" Octicon.

func ListOrdered 

func ListOrdered() *Octicon

ListOrdered returns the "list-ordered" Octicon.

func ListUnordered 

func ListUnordered() *Octicon

ListUnordered returns the "list-unordered" Octicon.

func Location 

func Location() *Octicon

Location returns the "location" Octicon.

func Lock 

func Lock() *Octicon

Lock returns the "lock" Octicon.

func LogoGist 

func LogoGist() *Octicon

LogoGist returns the "logo-gist" Octicon.

func LogoGithub 

func LogoGithub() *Octicon

LogoGithub returns the "logo-github" Octicon.

func Mail 

func Mail() *Octicon

Mail returns the "mail" Octicon.

func MailRead 

func MailRead() *Octicon

MailRead returns the "mail-read" Octicon.

func MarkGithub 

func MarkGithub() *Octicon

MarkGithub returns the "mark-github" Octicon.

func Markdown 

func Markdown() *Octicon

Markdown returns the "markdown" Octicon.

func Megaphone 

func Megaphone() *Octicon

Megaphone returns the "megaphone" Octicon.

func Mention 

func Mention() *Octicon

Mention returns the "mention" Octicon.

func Milestone 

func Milestone() *Octicon

Milestone returns the "milestone" Octicon.

func Mirror 

func Mirror() *Octicon

Mirror returns the "mirror" Octicon.

func MortarBoard 

func MortarBoard() *Octicon

MortarBoard returns the "mortar-board" Octicon.

func Mute 

func Mute() *Octicon

Mute returns the "mute" Octicon.

func NoNewline 

func NoNewline() *Octicon

NoNewline returns the "no-newline" Octicon.

func Note 

func Note() *Octicon

Note returns the "note" Octicon.

func Octoface 

func Octoface() *Octicon

Octoface returns the "octoface" Octicon.

func Organization 

func Organization() *Octicon

Organization returns the "organization" Octicon.

func Package 

func Package() *Octicon

Package returns the "package" Octicon.

func Paintcan 

func Paintcan() *Octicon

Paintcan returns the "paintcan" Octicon.

func Pencil 

func Pencil() *Octicon

Pencil returns the "pencil" Octicon.

func Person 

func Person() *Octicon

Person returns the "person" Octicon.

func Pin 

func Pin() *Octicon

Pin returns the "pin" Octicon.

func Play 

func Play() *Octicon

Play returns the "play" Octicon.

func Plug 

func Plug() *Octicon

Plug returns the "plug" Octicon.

func Plus 

func Plus() *Octicon

Plus returns the "plus" Octicon.

func PlusSmall 

func PlusSmall() *Octicon

PlusSmall returns the "plus-small" Octicon.

func PrimitiveDot 

func PrimitiveDot() *Octicon

PrimitiveDot returns the "primitive-dot" Octicon.

func PrimitiveDotStroke 

func PrimitiveDotStroke() *Octicon

PrimitiveDotStroke returns the "primitive-dot-stroke" Octicon.

func PrimitiveSquare 

func PrimitiveSquare() *Octicon

PrimitiveSquare returns the "primitive-square" Octicon.

func Project 

func Project() *Octicon

Project returns the "project" Octicon.

func Pulse 

func Pulse() *Octicon

Pulse returns the "pulse" Octicon.

func Question 

func Question() *Octicon

Question returns the "question" Octicon.

func Quote 

func Quote() *Octicon

Quote returns the "quote" Octicon.

func RadioTower 

func RadioTower() *Octicon

RadioTower returns the "radio-tower" Octicon.

func Reply 

func Reply() *Octicon

Reply returns the "reply" Octicon.

func Repo 

func Repo() *Octicon

Repo returns the "repo" Octicon.

func RepoClone 

func RepoClone() *Octicon

RepoClone returns the "repo-clone" Octicon.

func RepoForcePush 

func RepoForcePush() *Octicon

RepoForcePush returns the "repo-force-push" Octicon.

func RepoForked 

func RepoForked() *Octicon

RepoForked returns the "repo-forked" Octicon.

func RepoPull 

func RepoPull() *Octicon

RepoPull returns the "repo-pull" Octicon.

func RepoPush 

func RepoPush() *Octicon

RepoPush returns the "repo-push" Octicon.

func RepoTemplate 

func RepoTemplate() *Octicon

RepoTemplate returns the "repo-template" Octicon.

func RepoTemplatePrivate 

func RepoTemplatePrivate() *Octicon

RepoTemplatePrivate returns the "repo-template-private" Octicon.

func Report 

func Report() *Octicon

Report returns the "report" Octicon.

func RequestChanges 

func RequestChanges() *Octicon

RequestChanges returns the "request-changes" Octicon.

func Rocket 

func Rocket() *Octicon

Rocket returns the "rocket" Octicon.

func Rss 

func Rss() *Octicon

Rss returns the "rss" Octicon.

func Ruby 

func Ruby() *Octicon

Ruby returns the "ruby" Octicon.

func Saved 

func Saved() *Octicon

Saved returns the "saved" Octicon.

func ScreenFull 

func ScreenFull() *Octicon

ScreenFull returns the "screen-full" Octicon.

func ScreenNormal 

func ScreenNormal() *Octicon

ScreenNormal returns the "screen-normal" Octicon. 

func Search() *Octicon

Search returns the "search" Octicon.

func Server 

func Server() *Octicon

Server returns the "server" Octicon.

func Settings 

func Settings() *Octicon

Settings returns the "settings" Octicon.

func Shield 

func Shield() *Octicon

Shield returns the "shield" Octicon.

func ShieldCheck 

func ShieldCheck() *Octicon

ShieldCheck returns the "shield-check" Octicon.

func ShieldLock 

func ShieldLock() *Octicon

ShieldLock returns the "shield-lock" Octicon.

func ShieldX 

func ShieldX() *Octicon

ShieldX returns the "shield-x" Octicon.

func SignIn 

func SignIn() *Octicon

SignIn returns the "sign-in" Octicon.

func SignOut 

func SignOut() *Octicon

SignOut returns the "sign-out" Octicon.

func Skip 

func Skip() *Octicon

Skip returns the "skip" Octicon.

func Smiley 

func Smiley() *Octicon

Smiley returns the "smiley" Octicon.

func Squirrel 

func Squirrel() *Octicon

Squirrel returns the "squirrel" Octicon.

func Star 

func Star() *Octicon

Star returns the "star" Octicon.

func Stop 

func Stop() *Octicon

Stop returns the "stop" Octicon.

func Sync 

func Sync() *Octicon

Sync returns the "sync" Octicon.

func Tag 

func Tag() *Octicon

Tag returns the "tag" Octicon.

func Tasklist 

func Tasklist() *Octicon

Tasklist returns the "tasklist" Octicon.

func Telescope 

func Telescope() *Octicon

Telescope returns the "telescope" Octicon.

func Terminal 

func Terminal() *Octicon

Terminal returns the "terminal" Octicon.

func TextSize 

func TextSize() *Octicon

TextSize returns the "text-size" Octicon.

func ThreeBars 

func ThreeBars() *Octicon

ThreeBars returns the "three-bars" Octicon.

func Thumbsdown 

func Thumbsdown() *Octicon

Thumbsdown returns the "thumbsdown" Octicon.

func Thumbsup 

func Thumbsup() *Octicon

Thumbsup returns the "thumbsup" Octicon.

func Tools 

func Tools() *Octicon

Tools returns the "tools" Octicon.

func Trashcan 

func Trashcan() *Octicon

Trashcan returns the "trashcan" Octicon.

func TriangleDown 

func TriangleDown() *Octicon

TriangleDown returns the "triangle-down" Octicon.

func TriangleLeft 

func TriangleLeft() *Octicon

TriangleLeft returns the "triangle-left" Octicon.

func TriangleRight 

func TriangleRight() *Octicon

TriangleRight returns the "triangle-right" Octicon.

func TriangleUp 

func TriangleUp() *Octicon

TriangleUp returns the "triangle-up" Octicon.

func Unfold 

func Unfold() *Octicon

Unfold returns the "unfold" Octicon.

func Unmute 

func Unmute() *Octicon

Unmute returns the "unmute" Octicon.

func Unsaved 

func Unsaved() *Octicon

Unsaved returns the "unsaved" Octicon.

func Unverified 

func Unverified() *Octicon

Unverified returns the "unverified" Octicon.

func Verified 

func Verified() *Octicon

Verified returns the "verified" Octicon.

func Versions 

func Versions() *Octicon

Versions returns the "versions" Octicon.

func Watch 

func Watch() *Octicon

Watch returns the "watch" Octicon.

func Workflow 

func Workflow() *Octicon

Workflow returns the "workflow" Octicon.

func WorkflowAll 

func WorkflowAll() *Octicon

WorkflowAll returns the "workflow-all" Octicon.

func X 

func X() *Octicon

X returns the "x" Octicon.

func Zap 

func Zap() *Octicon

Zap returns the "zap" Octicon.

func (*Octicon) Class 

func (o *Octicon) Class(class string)

Class sets the class of an Octicon

func (*Octicon) HTML 

func (o *Octicon) HTML() template.HTML

HTML returns the SVG node as an HTML template, safe for use in Go templates

func (*Octicon) Height 

func (o *Octicon) Height(height int)

Height sets the height of an Octicon

func (*Octicon) Id 

func (o *Octicon) Id(id string)

Id sets the id of an Octicon

func (*Octicon) Size 

func (o *Octicon) Size(size int)

Size sets the size of an Octicon Short for calling Width and Height with the same int

func (*Octicon) Style 

func (o *Octicon) Style(style string)

Style sets the style of an Octicon

func (*Octicon) Width 

func (o *Octicon) Width(width int)

Width sets the width of an Octicon

func (*Octicon) XML 

func (o *Octicon) XML() string

XML returns the SVG node as an XML string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.