[]previous and next page

ABaseProps

The props of A that do not depend on its target.

The props of A that do not depend on its target. Attributes other than the ones listed pass to the anchor.

Import#

ts
import type { ABaseProps } from "@shadow-js/router";

Signature#

ts
interface ABaseProps {
  /** A raw href. Absolute URLs and other schemes are rendered as plain links. */
  readonly href?: string;
  /** Search merged onto the target's query. `undefined` removes a key. */
  readonly search?: SearchPatch;
  /** Hash for the target. */
  readonly hash?: string;
  /** Replace the current entry instead of pushing. */
  readonly replace?: boolean;
  /**
   * How a relative `to` resolves: `"path"` against the current pathname, `"route"` against the pattern of
   * the deepest route matched there. See {@link NavigateToOptions.relative}.
   */
  readonly relative?: "path" | "route";
  /** Stored in `history.state` for the new entry. */
  readonly state?: unknown;
  /** `false` commits this link's navigation without a view transition (needs the `transitions` feature). */
  readonly viewTransition?: boolean;
  /**
   * When the target loads ahead of a click. `"intent"` (default) on hover after 50 ms, focus or touch; `"viewport"`
   * once the link has been visible; `"render"` when the link mounts; `"none"` or `false` never. `"render"` and
   * `"none"` need the `prefetch()` feature; with it, the router's own default applies when this is not set.
   */
  readonly preload?: PrefetchStrategy | false;
  /** Class added while the target is the current location (or below it, unless `end`). */
  readonly activeClass?: string;
  /** Only the exact location counts as active. */
  readonly end?: boolean;
  readonly children?: unknown;
  readonly [attribute: string]: unknown;
}

Members#

Name Type Description
href? readonly href?: string A raw href. Absolute URLs and other schemes are rendered as plain links.
search? readonly search?: SearchPatch Search merged onto the target's query. undefined removes a key.
hash? readonly hash?: string Hash for the target.
replace? readonly replace?: boolean Replace the current entry instead of pushing.
relative? readonly relative?: "path" | "route" How a relative to resolves: "path" against the current pathname, "route" against the pattern of the deepest route matched there. See NavigateToOptions.relative.
state? readonly state?: unknown Stored in history.state for the new entry.
viewTransition? readonly viewTransition?: boolean false commits this link's navigation without a view transition (needs the transitions feature).
preload? readonly preload?: PrefetchStrategy | false When the target loads ahead of a click. "intent" (default) on hover after 50 ms, focus or touch; "viewport" once the link has been visible; "render" when the link mounts; "none" or false never. "render" and "none" need the prefetch() feature; with it, the router's own default applies when this is not set.
activeClass? readonly activeClass?: string Class added while the target is the current location (or below it, unless end).
end? readonly end?: boolean Only the exact location counts as active.
children? readonly children?: unknown