dom

Documentation

Index

• Constants
• func AbortContext(ctx context.Context, signal *AbortSignal) context.Context
• type AbortController
  • func NewAbortController() *AbortController
  • func (c *AbortController) Abort(reason any)
  • func (c *AbortController) Signal() *AbortSignal
• type AbortSignal
  • func (s AbortSignal) Aborted() bool
  • func (s AbortSignal) Onabort() event.EventHandler
  • func (s AbortSignal) Reason() any
  • func (s AbortSignal) SetOnabort(event.EventHandler)
  • func (s AbortSignal) ThrowIfAborted() error
• type ChildrenRenderer
• type Renderer

Constants

const EventTypeAbort = "abort"

Functions

func AbortContext

func AbortContext(ctx context.Context, signal *AbortSignal) context.Context

AbortContext will listen to abort events from an AbortSignal. The return value is a child context of ctx which will be cancelled if a, abort event is dispatched before the parent context cancels.

If the context is cancelled due to an abort event, the abort reason can be used as the cancel cause, which can be read using context.Cause. If the cause is not an error type, an [ErrAny] will be returned.

Types

type AbortController

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

func NewAbortController

func NewAbortController() *AbortController

func (*AbortController) Abort

func (c *AbortController) Abort(reason any)

func (*AbortController) Signal

func (c *AbortController) Signal() *AbortSignal

type AbortSignal

type AbortSignal struct {
	event.EventTarget
	// contains filtered or unexported fields
}

func (AbortSignal) Aborted

func (s AbortSignal) Aborted() bool

func (AbortSignal) Onabort

func (s AbortSignal) Onabort() event.EventHandler

func (AbortSignal) Reason

func (s AbortSignal) Reason() any

func (AbortSignal) SetOnabort

func (s AbortSignal) SetOnabort(event.EventHandler)

func (AbortSignal) ThrowIfAborted

func (s AbortSignal) ThrowIfAborted() error

type ChildrenRenderer

type ChildrenRenderer interface {
	RenderChildren(*strings.Builder)
}

ChildrenRenderer is the interface for DOM types that have children that can be rendered.

ChildrenRenderer is used for generating HTML and TextContent from DOM nodes.

type Renderer

type Renderer interface {
	Render(*strings.Builder)
}

Renderer is the interface for DOM types that can render themselves.

Renderer is used for generating HTML and TextContent from DOM nodes.