Skip to main content
On this pageFunctions

Navigation

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>

UrlRequestSchema

interfacesource
/** Schema for internal and external browser URL requests. */
interface UrlRequestSchema {
  constructor: unknown
  ~effect/Schema/Schema: "~effect/Schema/Schema"
  ~encoded.mutability: "readonly"
  ~encoded.optionality: "required"
  ~type.constructor.default: "no-default"
  ~type.make: {
    _tag: "Internal"
    url: Url.Url
  } | {
    _tag: "External"
    href: string
  }
  ~type.make.in: {
    _tag: "Internal"
    url: Url.Url
  } | {
    _tag: "External"
    href: string
  }
  ~type.mutability: "readonly"
  ~type.optionality: "required"
  ~type.parameters: readonly []
  ast: Union
  DecodingServices: never
  Encoded: {
    _tag: "Internal"
    url: Url.Url
  } | {
    _tag: "External"
    href: string
  }
  EncodingServices: never
  External: CallableTaggedStruct<"External", {
    href: String
  }>
  guards: {
    External: (u: unknown) => unknown
    Internal: (u: unknown) => unknown
  }
  Internal: CallableTaggedStruct<"Internal", {
    url: Struct<{
      hash: Option<String>
      host: String
      pathname: String
      port: Option<String>
      protocol: String
      search: Option<String>
    }>
  }>
  isAnyOf: (keys: readonly Array<Keys>) => (value: {
    _tag: "Internal"
    url: Url.Url
  } | {
    _tag: "External"
    href: string
  }) => unknown
  Iso: {
    _tag: "Internal"
    url: Url.Url
  } | {
    _tag: "External"
    href: string
  }
  match: TaggedUnionMatch<{
    External: {
      href: String
    }
    Internal: {
      url: Struct<{
        hash: Option<String>
        host: String
        pathname: String
        port: Option<String>
        protocol: String
        search: Option<String>
      }>
    }
  }>
  matchOrElse: TaggedUnionMatchOrElse<{
    External: {
      href: String
    }
    Internal: {
      url: Struct<{
        hash: Option<String>
        host: String
        pathname: String
        port: Option<String>
        protocol: String
        search: Option<String>
      }>
    }
  }>
  members: readonly Array<TaggedUnionMember<{
    External: {
      href: String
    }
    Internal: {
      url: Struct<{
        hash: Option<String>
        host: String
        pathname: String
        port: Option<String>
        protocol: String
        search: Option<String>
      }>
    }
  }>>
  Rebuild: UnionSchema<{
    External: {
      href: String
    }
    Internal: {
      url: Struct<{
        hash: Option<String>
        host: String
        pathname: String
        port: Option<String>
        protocol: String
        search: Option<String>
      }>
    }
  }>
  subset: (tags: Tags) => Union<TaggedUnionSubsetMembers<{
    External: {
      href: String
    }
    Internal: {
      url: Struct<{
        hash: Option<String>
        host: String
        pathname: String
        port: Option<String>
        protocol: String
        search: Option<String>
      }>
    }
  }, Tags>>
  Type: {
    _tag: "Internal"
    url: Url.Url
  } | {
    _tag: "External"
    href: string
  }
  annotate: unknown
  annotateKey: unknown
  check: unknown
  make: unknown
  makeEffect: unknown
  makeOption: unknown
  pipe: unknown
  rebuild: unknown
}

UrlRequest

constsource
/** Union of `Internal` and `External` URL request types. */
const UrlRequest: UrlRequestSchema