Documentation
¶
Overview ¶
Package navigation はWebGoへ現在のDocument URLを安全な値として公開する。
Index ¶
- Constants
- Variables
- type API
- func (api *API) Back() error
- func (api *API) Current() Location
- func (api *API) DispatchHashChange(oldURL, newURL string)
- func (api *API) DispatchPopState(state string)
- func (api *API) Forward() error
- func (api *API) Go(delta int) error
- func (api *API) HistoryLength() int
- func (api *API) HistoryState() string
- func (api *API) Navigate(rawURL string) error
- func (api *API) OnHashChange(listener func(HashChangeEvent))
- func (api *API) OnPopState(listener func(PopStateEvent))
- func (api *API) PushState(stateJSON, rawURL string) error
- func (api *API) ReplaceState(stateJSON, rawURL string) error
- func (api *API) Resolve(rawURL string) (Location, error)
- func (api *API) SetPushStateHandler(handler func(string, *url.URL) error)
- func (api *API) SetReplaceStateHandler(handler func(string, *url.URL) error)
- func (api *API) SetTraversalHandler(traverse func(int) error, info func() (int, string))
- func (api *API) UpdateCurrent(documentURL *url.URL)
- type HashChangeEvent
- type Location
- type PopStateEvent
Constants ¶
const ( MaxURLSize = 8 * 1024 MaxHistoryStateSize = 64 * 1024 )
Variables ¶
var ( // ErrInvalidURL はNavigation対象として扱えないURLを表す。 ErrInvalidURL = errors.New("invalid navigation URL") ErrUnavailable = errors.New("navigation is unavailable") )
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
API は1つのPageに属するNavigation APIである。
func (*API) DispatchHashChange ¶
DispatchHashChange はBrowserからhashchange相当Eventを配送する。
func (*API) DispatchPopState ¶
DispatchPopState はBrowserからpopstate相当Eventを配送する。
func (*API) HistoryState ¶
HistoryState は現在entryのJSON stateを返す。未設定の場合は空文字列である。
func (*API) Navigate ¶
Navigate は検証・解決済みURLへのBrowser Navigationを要求する。 Network完了を待たず、commit前に検出できるErrorだけを返す。
func (*API) OnHashChange ¶
func (api *API) OnHashChange(listener func(HashChangeEvent))
OnHashChange はfragment Navigation後に呼ばれるlistenerを登録する。
func (*API) OnPopState ¶
func (api *API) OnPopState(listener func(PopStateEvent))
OnPopState はHistory traversal後に呼ばれるlistenerを登録する。
func (*API) ReplaceState ¶
ReplaceState は現在History entryのJSON stateとsame-origin URLを置換する。
func (*API) SetPushStateHandler ¶
SetPushStateHandler はsame-document History entryの追加先を設定する。
func (*API) SetReplaceStateHandler ¶
SetReplaceStateHandler は現在History entryの置換先を設定する。
func (*API) SetTraversalHandler ¶
SetTraversalHandler はBrowser History traversalと現在情報の取得先を設定する。
func (*API) UpdateCurrent ¶
UpdateCurrent はsame-document Navigation後のDocument URLを反映する。
type HashChangeEvent ¶
HashChangeEvent はfragment変更前後のcredentialを含まないURLを保持する。
type Location ¶
type Location struct {
Href string
Origin string
Scheme string
Host string
Hostname string
Port string
Path string
Query string
Fragment string
}
Location は現在のDocument URLをWebGoから参照するための不変な値である。 QueryとFragmentには先頭の?と#を含めない。
type PopStateEvent ¶
type PopStateEvent struct {
State string
}
PopStateEvent はHistory traversal後のWebGo Eventである。