Skip to main content
Foldkit
On this pageFunctions

Navigation

Functions

back

functionsource
/** Navigates back in browser history. */
(): Effect<void>

forward

functionsource
/** Navigates forward in browser history. */
(): Effect<void>

load

functionsource
/** Performs a full page navigation to the given href. */
(href: string): Effect<void>

openUrl

functionsource
/**
 * Opens the given href in a new browsing context (tab or window, at the browser's discretion).
 *  The current page is unchanged. Subject to popup blockers when not called from a user-gesture handler.
 */
(href: string): Effect<void>

pushUrl

functionsource
/** Pushes a new URL to browser history and triggers Foldkit's URL change handling. */
(url: string): Effect<void>

replaceUrl

functionsource
/** Replaces the current URL in browser history and triggers Foldkit's URL change handling. */
(url: string): Effect<void>

Constants

UrlRequest

constsource
/** Union of `Internal` and `External` URL request types. */
const UrlRequest: TaggedUnion<{
  External: {
    href: String
  }
  Internal: {
    url: Struct<{
      hash: Option<String>
      host: String
      pathname: String
      port: Option<String>
      protocol: String
      search: Option<String>
    }>
  }
}>