Skip to main content Link Search Menu Expand Document (external link)

Added in v1.0.0


Table of contents


utils

Signature

export declare function Link<
  Props extends LinkProps,
  Children extends ReadonlyArray<Renderable<any, any>> = readonly []
>(
  input: Props,
  ...children: Children
): Fx.Fx<
  RenderEvent,
  Placeholder.Error<Props[keyof Props] | Children[number]>,
  | Navigation.Navigation
  | CurrentRoute
  | RenderTemplate
  | RenderQueue
  | Scope.Scope
  | Placeholder.Context<Props[keyof Props] | Children[number]>
>

Added in v1.0.0

LinkProps (type alias)

Signature

export type LinkProps = Omit<TypedPropertiesMap["a"], keyof URL> & {
  readonly to: string | Placeholder.Any<string>
  readonly relative?: boolean | Placeholder.Any<boolean>
  readonly replace?: boolean | Placeholder.Any<boolean>
  readonly state?: unknown | Placeholder.Any<unknown>
  readonly info?: unknown | Placeholder.Any<unknown>
  readonly reloadDocument?: boolean | Placeholder.Any<boolean>
}

Added in v1.0.0