webbrowser

package module
v1.1.0 Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2017 License: MIT Imports: 7 Imported by: 368

README

webbrowser Build Status GoDoc

webbrowser provides a simple API for opening web pages on your default browser. It's inspired on Python's webbrowser package but lacks some of its features (open new window).

It just opens a webpage, most browsers will open it on a new tab.

Installation

As simple as: go get -u github.com/toqueteos/webbrowser

Usage

package main

import "github.com/toqueteos/webbrowser"

func main() {
    webbrowser.Open("http://golang.org")
}

That's it!

Already disliking it?

No problem! There's alternative libraries that may be better to your needs:

Crossplatform support

The package is guaranteed to work on windows, linux and darwin. It also has default support for freebsd, openbsd and netbsd but these three have not been tested yet (that I'm aware of).

License

It is licensed under the MIT open source license, please see the [LICENSE.md] file for more information.

Thanks...

Miki Tebeka wrote a nicer version that wasn't on godoc.org when I did this, check it out!.

Documentation

Overview

Package webbrowser provides a simple API for opening web pages on your default browser.

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrCantOpenBrowser = errors.New("webbrowser: can't open browser")
	ErrNoCandidates    = errors.New("webbrowser: no browser candidate found for your OS")
)
View Source
var Candidates []Browser

Candidates contains a list of registered `Browser`s that will be tried with Open.

Functions

func Open

func Open(s string) (err error)

Open tries to open a URL in your default browser ensuring you have a display set up and not running this from SSH. NOTE: This may cause your program to hang until the browser process is closed in some OSes, see https://github.com/toqueteos/webbrowser/issues/4.

Types

type Browser

type Browser interface {
	// Command returns a ready to be used Cmd that will open an URL.
	Command(string) (*exec.Cmd, error)
	// Open tries to open a URL in your default browser. NOTE: This may cause
	// your program to hang until the browser process is closed in some OSes,
	// see https://github.com/toqueteos/webbrowser/issues/4.
	Open(string) error
}

Jump to

Keyboard shortcuts

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