Skip to content
ui8kit

primitive / primitives

Link

Link primitive

Install

npx ui8kit add link

Pulls in: kit-link, recipes, utils

Preview

size: sm
size: default
size: md
size: lg
variant: block
variant: default
variant: external
variant: muted
variant: nav

Code

Point the CLI at this runtime once, then add the item:

npx ui8kit init --yes --framework svelte --dir src --registry-url https://registry.buildy.tw/svelte --strict-cdn
npx ui8kit add link
compose/Link.svelte
<!-- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. -->
<!-- Link: Link + recipe link. -->
<script lang="ts">
  import type { ComponentProps, Snippet } from "svelte";
  import Prim from "../kit/ui/link/Link.svelte";
  import { cn } from "../kit/utils";
  import { rc } from "./recipes";

  let { "size": v_size, "variant": v_variant, class: className, children, ...rest }: ComponentProps<typeof Prim> & { "size"?: string | number; "variant"?: string | number; class?: string; children?: Snippet } = $props();
  const cls = $derived(cn(rc("link", { "size": v_size, "variant": v_variant }), className));
</script>

<Prim class={cls} {...rest}>{@render children?.()}</Prim>

Svelte registry item (JSON)

Point the CLI at this runtime once, then add the item:

npx ui8kit init --yes --framework react --dir src --registry-url https://registry.buildy.tw/react --strict-cdn
npx ui8kit add link
compose/link.tsx
// Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.
import type { ComponentProps } from "react";
import { Link as Prim } from "../kit/ui/link/link";
import { cn } from "../kit/utils";
import { rc } from "./recipes";

export type LinkProps = Omit<ComponentProps<typeof Prim>, "tag" | "size" | "variant"> & { "size"?: string | number; "variant"?: string | number; className?: string };

/** Link: Link + recipe link. */
export function Link({ "size": v_size, "variant": v_variant, className, ...rest }: LinkProps) {
  return <Prim className={cn(rc("link", { "size": v_size, "variant": v_variant }), className)} {...rest} />;
}

React registry item (JSON)

Point the CLI at this runtime once, then add the item:

npx ui8kit init --yes --framework vue --dir src --registry-url https://registry.buildy.tw/vue --strict-cdn
npx ui8kit add link
compose/Link.vue
<!-- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. -->
<!-- Link: Link + recipe link. -->
<script setup lang="ts">
import { computed, useAttrs } from "vue";
import Prim from "../kit/ui/link/Link.vue";
import { cn } from "../kit/utils";
import { rc } from "./recipes";

defineOptions({ name: "Link", inheritAttrs: false });
const props = defineProps<{ "size"?: string | number; "variant"?: string | number }>();
const attrs = useAttrs();
const rest = computed(() => {
  const { class: _class, ...r } = attrs;
  return r;
});
const cls = computed(() => cn(rc("link", { "size": props["size"], "variant": props["variant"] }), attrs.class as string | undefined));
const tagValue = computed(() => "");
</script>

<template>
  <Prim :class="cls" v-bind="rest"><slot /></Prim>
</template>

Vue registry item (JSON)

Point the CLI at this runtime once, then add the item:

npx ui8kit init --yes --framework solid --dir src --registry-url https://registry.buildy.tw/solid --strict-cdn
npx ui8kit add link
compose/link.solid.tsx
// Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.
import { splitProps, type ComponentProps } from "solid-js";
import { Link as Prim } from "../kit/ui/link/link.solid";
import { cn } from "../kit/utils";
import { rc } from "./recipes";

export type LinkProps = Omit<ComponentProps<typeof Prim>, "tag" | "class" | "className" | "size" | "variant"> & { "size"?: string | number; "variant"?: string | number; class?: string; className?: string };

/** Link: Link + recipe link. */
export function Link(props: LinkProps) {
  const [local, rest] = splitProps(props, ["size", "variant", "class", "className"]);
  return <Prim class={cn(rc("link", { "size": local["size"], "variant": local["variant"] }), local.class ?? local.className)} {...rest} />;
}

Solid registry item (JSON)

Point the CLI at this runtime once, then add the item:

npx ui8kit init --yes --framework templ --dir src --registry-url https://registry.buildy.tw/templ --strict-cdn
npx ui8kit add link
compose/link.templ
// Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.

package compose

import "github.com/ui8kit/codegen/generated/templ/ui/link"

// LinkProps: Link: Link + recipe link.
type LinkProps struct {
	Size string
	Variant string
	link.LinkProps
}

func linkInner(p LinkProps) link.LinkProps {
	in := p.LinkProps
	in.Class = Join(Rc("link", map[string]string{"size": p.Size, "variant": p.Variant}), p.LinkProps.Class)
	return in
}

// Link renders Link with the composition classes.
templ Link(p LinkProps) {
	@link.Link(linkInner(p)) {
		{ children... }
	}
}

templ registry item (JSON)

Point the CLI at this runtime once, then add the item:

npx ui8kit init --yes --framework twig --dir src --registry-url https://registry.buildy.tw/twig --strict-cdn
npx ui8kit add link
compose/Link.html.twig
{# Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. #}
{# Link: Link + recipe link. Params: size, variant, class, attrs + the params of Link. #}
{% include 'ui/link/Link.html.twig' with compose_props('Link', _context) only %}

Twig registry item (JSON)

Point the CLI at this runtime once, then add the item:

npx ui8kit init --yes --framework latte --dir src --registry-url https://registry.buildy.tw/latte --strict-cdn
npx ui8kit add link
compose/Link.latte
{* Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. *}
{* Link: Link + recipe link. *}
{parameters
  string $class = '',
  ?string $href = null,
  string $target = '',
  string $rel = '',
  bool $external = false,
  ?string $download = null,
  ?string $ariaCurrent = null,
  ?string $ariaLabel = null,
  array $attrs = [],
  string $children = '',
  $size = null,
  $variant = null,
}
{include '../ui/link/Link.latte', ...\CodegenX\Compose\Latte\Compose::props('Link', ['class' => $class, 'href' => $href, 'target' => $target, 'rel' => $rel, 'external' => $external, 'download' => $download, 'ariaCurrent' => $ariaCurrent, 'ariaLabel' => $ariaLabel, 'attrs' => $attrs, 'children' => $children, 'size' => $size, 'variant' => $variant])}

Latte registry item (JSON)

Point the CLI at this runtime once, then add the item:

npx ui8kit init --yes --framework jinja2 --dir src --registry-url https://registry.buildy.tw/jinja2 --strict-cdn
npx ui8kit add link
compose/link.html.j2
{#- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.
    Link: Link + recipe link. Props (p): Size, Variant, Class, Attrs + the props of Link. -#}
{%- with p = compose_props('Link', p) %}{% include 'ui/link/link.html.j2' %}{% endwith %}

Jinja2 registry item (JSON)

Props

Names and types come from the xgen specs of the source. Standard HTML attributes (id, role, tabIndex, aria-*) pass through to the root element; the class prop is className in React.

Link renders an anchor; External opens a new tab with rel=noopener noreferrer.

Props of Link
PropTypeDefault Description
target string-explicit target; External implies _blank
rel string-explicit rel; External defaults to noopener noreferrer
external boolean-opens in a new tab with safe rel defaults