inlinecode

Documentation

Overview

Package inlinecode renders short inline code fragments inside prose.

templ: version: v0.3.1020

Index

• type Instance
  • func InlineCode(text string, options ...Option) Instance
  • func (Instance) Kind() components.Kind
  • func (i Instance) Render(ctx context.Context, w io.Writer) error
• type Option
  • func WithRootAttrs(attrs templ.Attributes) Option
  • func WithRootClass(class string) Option

Types

type Instance

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

Instance is a renderable inline code fragment.

func InlineCode

func InlineCode(text string, options ...Option) Instance

InlineCode returns a semantic inline code fragment.

func (Instance) Kind

func (Instance) Kind() components.Kind

Kind identifies the component as inline code.

func (Instance) Render

func (i Instance) Render(ctx context.Context, w io.Writer) error

Render writes the inline code markup.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures inline code.

func WithRootAttrs

func WithRootAttrs(attrs templ.Attributes) Option

WithRootAttrs adds arbitrary attributes to the code element.

func WithRootClass

func WithRootClass(class string) Option

WithRootClass appends CSS classes to the code element.