inline

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Nov 18, 2021 License: BSD-3-Clause Imports: 7 Imported by: 0

Documentation

Overview

Package inline styles inline text such as HTML-spans or console-output.

Status

Work in progress.

_________________________________________________________________________

BSD 3-Clause License

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func InnerText

func InnerText(n *html.Node) (*styled.Text, error)

InnerText creates a styled text for the textual content of an HTML element and all its descendents. It resembles the text produced by

document.getElementById("myNode").innerText

in JavaScript, except that `InnerText` cannot respect CSS styling (including properties changing the visibility of the node's descendents). Therefore the resulting styled text is limited to inline span elements like

<strong> … </strong>
<i> … </i>

etc. Clients should provide a paragraph-like element.

The fragment organization of the resulting styled text will reflect the hierarchy of the element node's descendents.

func T

func T() tracing.Trace

T traces to a global core-tracer.

func TextFromHTML

func TextFromHTML(input io.Reader) (*styled.Text, error)

TextFromHTML creates a styled.Text from the textual content of an HTML fragment. The HTML fragment should reflect the content of a paragraph-like element.

Types

type Style

type Style int

Style is a text style, applicable on runs of characters

const (
	PlainStyle Style = 0
	BoldStyle  Style = 1 << iota
	ItalicsStyle
	StrongStyle
	EmStyle
	SmallStyle
	MarkedStyle
)

Some standard text formats

func StyleFromHTMLName

func StyleFromHTMLName(s string) Style

StyleFromHTMLName returns a style from an HTML inline span name, like <strong>, <i>, etc.

func (Style) Add

func (s Style) Add(other Style) Style

func (Style) Equals

func (s Style) Equals(other styled.Style) bool

func (Style) Minus

func (s Style) Minus(other Style) Style

func (Style) String

func (s Style) String() string

Jump to

Keyboard shortcuts

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