carbon

package module

v0.0.0-...-6ac86a7 Latest Latest Go to latest Published: Aug 31, 2023 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bjornpagen/carbon-go

Links

Open Source Insights

README ¶

carbon-go

https://carbon-go.io

every component implements the carbon.Component interface:

type Component interface {
	Render(w io.Writer)
	Attr(name, value string) Component
}

so, you can use it to write to anything that implements io.Writer. use in a server like this:

type foo struct {}

func (f *foo) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	carbon.Button("Hello world!").Render(w)
}

put HTMX tags on your component like this:

carbon.Button("Hello world!").Attr("hx-get", "https://example.com").Attr("hx-swap", "outerHTML").Render(w)

currently documentation sucks. just look at the docs for carbon design svelte. i've tried to keep it as similar as possible. moving forward, we should try to keep upstream with the react version when possible. i just didn't want to comb through react code.

will be adding doc comments.

TODO:

implement the rest of the components (copy button, textarea, etc...)
implement client side javascript for a few components
import icons on the fly and cache them server side instead of hardcoding them
automated testing against the react implemention to ensure markup generation parity
make every single component respect class Addr

Documentation ¶

Index ¶

Variables
func Accordion(cs ...*accordionItem) *accordion
func AccordionItem() *accordionItem
func Add() *iconComponent
func AspectRatio(cs ...Component) *aspectRatio
func Breadcrumb(children ...*breadcrumbItem) *breadcrumb
func BreadcrumbItem(children ...any) *breadcrumbItem
func Breakpoint(sm ...any) *breakpoint
func Button(children ...any) *button
func ButtonSet(children ...*button) *buttonSet
func Checkbox() *checkbox
func Checkmark() *iconComponent
func ChevronDown() *iconComponent
func ChevronRight() *iconComponent
func ClickableTile(children ...any) *clickableTile
func Column(c ...*row) *column
func Content(a ...any) *content
func ContentSwitcher(cs ...*switch_) *contentSwitcher
func Copy() *iconComponent
func Delete() *iconComponent
func Div(a ...any) *div
func EditOff() *iconComponent
func Escaped(s string) string
func GitHub() *iconComponent
func Grid(c ...*column) *grid
func Header() *header
func Html() *html_
func InlineScript(href string) *script
func InlineStyle(href string) *style
func Link(children ...any) *link
func ListItem(children ...any) *listItem
func OrderedList(children ...any) *orderedList
func P(a ...any) *p
func PasswordInput(labelText string) *passwordInput
func Row(a ...any) *row
func Script(s string) *script
func Section(a ...any) *section
func Select(s ...*selectItem) *select_
func SelectItem() *selectItem
func Style(s string) *style
func Switch(text string) *switch_
func TextInput(labelText string) *textInput
func Toggle() *toggle
func UnorderedList(children ...any) *unorderedList
func View() *iconComponent
func ViewOff() *iconComponent
func WarningAltFilled() *iconComponent
func WarningFilled() *iconComponent
type Attr
type Component

Constants ¶

This section is empty.

Variables ¶

View Source

var BaseCss string

View Source

var BaseFontCss string

Functions ¶

func Accordion ¶

func Accordion(cs ...*accordionItem) *accordion

func AccordionItem ¶

func AccordionItem() *accordionItem

func Add ¶

func Add() *iconComponent

func AspectRatio ¶

func AspectRatio(cs ...Component) *aspectRatio

func Breadcrumb(children ...*breadcrumbItem) *breadcrumb

func BreadcrumbItem ¶

func BreadcrumbItem(children ...any) *breadcrumbItem

func Breakpoint ¶

func Breakpoint(sm ...any) *breakpoint

func Button ¶

func Button(children ...any) *button

func ButtonSet ¶

func ButtonSet(children ...*button) *buttonSet

func Checkbox ¶

func Checkbox() *checkbox

func Checkmark ¶

func Checkmark() *iconComponent

func ChevronDown ¶

func ChevronDown() *iconComponent

func ChevronRight ¶

func ChevronRight() *iconComponent

func ClickableTile ¶

func ClickableTile(children ...any) *clickableTile

func Column ¶

func Column(c ...*row) *column

func Content ¶

func Content(a ...any) *content

func ContentSwitcher ¶

func ContentSwitcher(cs ...*switch_) *contentSwitcher

func Copy ¶

func Copy() *iconComponent

func Delete ¶

func Delete() *iconComponent

func Div ¶

func Div(a ...any) *div

func EditOff ¶

func EditOff() *iconComponent

func Escaped ¶

func Escaped(s string) string

func GitHub ¶

func GitHub() *iconComponent

func Grid ¶

func Grid(c ...*column) *grid

func Header ¶

func Header() *header

func Html ¶

func Html() *html_

func InlineScript ¶

func InlineScript(href string) *script

func InlineStyle ¶

func InlineStyle(href string) *style

func Link ¶

func Link(children ...any) *link

func ListItem ¶

func ListItem(children ...any) *listItem

func OrderedList ¶

func OrderedList(children ...any) *orderedList

func P ¶

func P(a ...any) *p

func PasswordInput ¶

func PasswordInput(labelText string) *passwordInput

func Row ¶

func Row(a ...any) *row

func Script ¶

func Script(s string) *script

func Section ¶

func Section(a ...any) *section

func Select ¶

func Select(s ...*selectItem) *select_

func SelectItem ¶

func SelectItem() *selectItem

func Style ¶

func Style(s string) *style

func Switch ¶

func Switch(text string) *switch_

func TextInput ¶

func TextInput(labelText string) *textInput

func Toggle ¶

func Toggle() *toggle

func UnorderedList ¶

func UnorderedList(children ...any) *unorderedList

func View ¶

func View() *iconComponent

func ViewOff ¶

func ViewOff() *iconComponent

func WarningAltFilled ¶

func WarningAltFilled() *iconComponent

func WarningFilled ¶

func WarningFilled() *iconComponent

Types ¶

type Attr ¶

type Attr struct {
	Name  string
	Value string
}

type Component ¶

type Component interface {
	Render(w io.Writer)
}

Source Files ¶

View all Source files

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