Documentation
¶
Index ¶
- Constants
- type Anchor
- type BadgePill
- type BigTitle
- type Card
- type Column
- type Component
- type Components
- type CountBadge
- type DirectoryFileWriter
- type Div
- type Empty
- type File
- type FileWriter
- type FooterRow
- type GoogleAnalytics
- type HTML
- type Heading
- type HorizontalRule
- type HorizontalRuleRow
- type KeyedTableRow
- type LineBreak
- type Lines
- type Link
- type NavItem
- type NavLink
- type NavPills
- type NavPillsRow
- type NavTabs
- type Number
- type Octicon
- type Page
- type Row
- type Space
- type Span
- type Table
- type TableCell
- type TableHead
- type TableRow
- type Tag
- type Text
Constants ¶
const ( QuarterRow = 3 HalfRow = 6 EntireRow = 12 )
const (
CardNoBadgeCount = -1
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BadgePill ¶
type BadgePill struct {
// contains filtered or unexported fields
}
BadgePill is a rounded badge that contains a value.
func NewBadgePill ¶
type BigTitle ¶
type BigTitle struct {
// contains filtered or unexported fields
}
func NewBigTitle ¶
type Card ¶
type Card struct {
// contains filtered or unexported fields
}
Card is a simple box with a header and body section.
type Column ¶
type Column struct {
// contains filtered or unexported fields
}
Column is used inside of a row. The row consists of 12 virtual columns and each column can specify how many of the columns it represents.
type Components ¶
type Components struct {
// contains filtered or unexported fields
}
Components is a wrapper for zero more components that rendered at the same time.
func NewComponents ¶
func NewComponents(items ...Component) *Components
func (*Components) WriteHTMLTo ¶
func (c *Components) WriteHTMLTo(w io.Writer) (int64, error)
type CountBadge ¶
type CountBadge struct {
// contains filtered or unexported fields
}
CountBadge shows a pill badge containing an integer. The appropriate localization will be applied (like a thousands separator).
func NewCountBadge ¶
func NewCountBadge(value int) *CountBadge
func (*CountBadge) WriteHTMLTo ¶
func (c *CountBadge) WriteHTMLTo(w io.Writer) (int64, error)
type DirectoryFileWriter ¶
type DirectoryFileWriter struct {
WillWriteFile func(file *File)
// contains filtered or unexported fields
}
func NewDirectoryFileWriter ¶
func NewDirectoryFileWriter(outputDir string) *DirectoryFileWriter
func (*DirectoryFileWriter) WriteFile ¶
func (writer *DirectoryFileWriter) WriteFile(file *File) error
type Div ¶
type Div struct {
// contains filtered or unexported fields
}
Div is a <div> tag with a class.
type Empty ¶
type Empty struct{}
Empty is used a placeholder for a component where nothing should be visible.
type FileWriter ¶
type FooterRow ¶
type FooterRow struct{}
FooterRow appears on all pages at the bottom.
func NewFooterRow ¶
func NewFooterRow() *FooterRow
type GoogleAnalytics ¶
type GoogleAnalytics struct {
// contains filtered or unexported fields
}
func NewGoogleAnalytics ¶
func NewGoogleAnalytics(id string) *GoogleAnalytics
func (*GoogleAnalytics) WriteHTMLTo ¶
func (c *GoogleAnalytics) WriteHTMLTo(w io.Writer) (int64, error)
type Heading ¶
type Heading struct {
// contains filtered or unexported fields
}
Heading is larger text.
type HorizontalRule ¶
type HorizontalRule struct{}
HorizontalRule is a dividing line.
func NewHorizontalRule ¶
func NewHorizontalRule() *HorizontalRule
func (*HorizontalRule) WriteHTMLTo ¶
func (c *HorizontalRule) WriteHTMLTo(w io.Writer) (int64, error)
type HorizontalRuleRow ¶
type HorizontalRuleRow struct{}
HorizontalRuleRow is a dividing line.
func NewHorizontalRuleRow ¶
func NewHorizontalRuleRow() *HorizontalRuleRow
func (*HorizontalRuleRow) WriteHTMLTo ¶
func (c *HorizontalRuleRow) WriteHTMLTo(w io.Writer) (int64, error)
type KeyedTableRow ¶
type KeyedTableRow struct {
// contains filtered or unexported fields
}
KeyedTableRow is a table row consisting of two columns where the left column is a header and a key for the data in the right column. It also allows the row to be hidden altogether if needed.
func NewKeyedTableRow ¶
func NewKeyedTableRow(title string, value Component, visible bool) *KeyedTableRow
func (*KeyedTableRow) WriteHTMLTo ¶
func (c *KeyedTableRow) WriteHTMLTo(w io.Writer) (int64, error)
type NavItem ¶
type NavItem struct {
// contains filtered or unexported fields
}
NavItem is a single tab in the tab bar.
type NavPills ¶
type NavPills struct {
// contains filtered or unexported fields
}
func NewNavPills ¶
type NavPillsRow ¶
type NavPillsRow struct {
// contains filtered or unexported fields
}
func NewNavPillsRow ¶
func NewNavPillsRow(links []Component) *NavPillsRow
func (*NavPillsRow) WriteHTMLTo ¶
func (c *NavPillsRow) WriteHTMLTo(w io.Writer) (int64, error)
type NavTabs ¶
type NavTabs struct {
// contains filtered or unexported fields
}
NavTabs is a group of tabs.
func NewNavTabs ¶
type Page ¶
type Page struct {
// contains filtered or unexported fields
}
Page is the entire page wrapped that provides the HTML head and body.
type Row ¶
type Row struct {
// contains filtered or unexported fields
}
Row is a page row for Bootstrap.
type Space ¶
type Space struct{}
Space is an empty row used as a white space separator between other page rows.
type TableCell ¶
type TableCell struct {
// contains filtered or unexported fields
}
func NewTableCell ¶
type TableHead ¶
type TableHead struct {
// contains filtered or unexported fields
}
TableHead is the <thead> section of a table that contains the table heading cells.
func NewTableHead ¶
type TableRow ¶
type TableRow struct {
// contains filtered or unexported fields
}
func NewTableRow ¶
Source Files
¶
- anchor.go
- badge_pill.go
- big_title.go
- card.go
- column.go
- component.go
- components.go
- count_badge.go
- directory_file_writer.go
- div.go
- empty.go
- file.go
- file_writer.go
- footer_row.go
- google_analytics.go
- heading.go
- horizontal_rule.go
- horizontal_rule_row.go
- html.go
- keyed_table_row.go
- line_break.go
- lines.go
- link.go
- nav_item.go
- nav_link.go
- nav_pills.go
- nav_pills_row.go
- nav_tabs.go
- number.go
- octicon.go
- page.go
- row.go
- space.go
- span.go
- table.go
- table_cell.go
- table_head.go
- table_row.go
- tag.go
- text.go
- util.go