keyboard

package

v0.1.5 Latest Latest Go to latest Published: Feb 23, 2023 License: MIT Imports: 1 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

This section is empty.

This section is empty.

This section is empty.

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

KeyDist is the type that allows to find the best alternative based on keyboard layouts

func New(l Layout) KeyDist

New produces a new instance of KeyDist, based on the keyboard layout you choose

func (kd KeyDist) CalculateDistance(input, ref string) float64

CalculateDistance calculates the total distances of the reference to the input

func (kd KeyDist) FindNearest(input string, list []string) (string, float64)

FindNearest finds the item in the list that is nearest to the input, based on the keyboard layout

type Layout string

Layout is the type used to define keyboard layouts

const (
	Default  Layout = QwertyUS
	QwertyUS Layout = "qwerty-us"
)

Predefined keyboard layouts