Documentation navigation

Published API · 0.1.0-rc.1

foldkit · navigation

Published foldkit API declarations for navigation.

./navigation

@wsagency/wseffect-foldkit · MIT · source · MIT license · WS-AGENCY-NOTICE · THIRD-PARTY-NOTICES

This entry point is published in @wsagency/wseffect-foldkit@0.1.0-rc.1. Import it from the package subpath shown below; the signatures and documentation are read from the installed package declarations.

import * as Wseffect from '@wsagency/wseffect-foldkit/navigation'

Exported declarations

back

Navigates back in browser history.

back: () => Effect.Effect<void>

forward

Navigates forward in browser history.

forward: () => Effect.Effect<void>

load

Performs a full page navigation to the given href.

load: (href: string) => Effect.Effect<void>

openUrl

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.

openUrl: (href: string) => Effect.Effect<void>

pushUrl

Pushes a new URL to browser history and triggers Foldkit's URL change handling.

pushUrl: (url: string) => Effect.Effect<void>

replaceUrl

Replaces the current URL in browser history and triggers Foldkit's URL change handling.

replaceUrl: (url: string) => Effect.Effect<void>

UrlRequest

Union of `Internal` and `External` URL request types.

export type UrlRequest = typeof UrlRequest.Type;

UrlRequest

Union of `Internal` and `External` URL request types.

UrlRequest: import("../schema/index.js").TaggedUnion<{
    readonly Internal: {
        url: Schema.Struct<{
            readonly protocol: Schema.String;
            readonly host: Schema.String;
            readonly port: Schema.Option<Schema.String>;
            readonly pathname: Schema.String;
            readonly search: Schema.Option<Schema.String>;
            readonly hash: Schema.Option<Schema.String>;
        }>;
    };
    readonly External: {
        href: Schema.String;
    };
}>