Skip to content
ui8kit

primitive / primitives

Legend

Legend primitive

Install

npx ui8kit add legend

Pulls in: kit-text, recipes, utils

Preview

size: sm
size: default
size: lg
variant: default
variant: muted

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 legend
compose/Legend.svelte
<!-- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. -->
<!-- Legend: Text <legend> + recipe legend. -->
<script lang="ts">
  import type { ComponentProps, Snippet } from "svelte";
  import Prim from "../kit/ui/text/Text.svelte";
  import { cn } from "../kit/utils";
  import { rc } from "./recipes";

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

<Prim tag={"legend" as never} 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 legend
compose/legend.tsx
// Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.
import type { ComponentProps } from "react";
import { Text as Prim } from "../kit/ui/text/text";
import { cn } from "../kit/utils";
import { rc } from "./recipes";

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

/** Legend: Text <legend> + recipe legend. */
export function Legend({ "size": v_size, "variant": v_variant, className, ...rest }: LegendProps) {
  return <Prim tag={"legend" as never} className={cn(rc("legend", { "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 legend
compose/Legend.vue
<!-- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. -->
<!-- Legend: Text <legend> + recipe legend. -->
<script setup lang="ts">
import { computed, useAttrs } from "vue";
import Prim from "../kit/ui/text/Text.vue";
import { cn } from "../kit/utils";
import { rc } from "./recipes";

defineOptions({ name: "Legend", 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("legend", { "size": props["size"], "variant": props["variant"] }), attrs.class as string | undefined));
const tagValue = computed(() => "legend");
</script>

<template>
  <Prim :tag="tagValue as never" :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 legend
compose/legend.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 { Text as Prim } from "../kit/ui/text/text.solid";
import { cn } from "../kit/utils";
import { rc } from "./recipes";

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

/** Legend: Text <legend> + recipe legend. */
export function Legend(props: LegendProps) {
  const [local, rest] = splitProps(props, ["size", "variant", "class", "className"]);
  return <Prim tag={"legend" as never} class={cn(rc("legend", { "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 legend
compose/legend.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/text"

// LegendProps: Legend: Text <legend> + recipe legend.
type LegendProps struct {
	Size string
	Variant string
	text.TextProps
}

func legendInner(p LegendProps) text.TextProps {
	in := p.TextProps
	in.Class = Join(Rc("legend", map[string]string{"size": p.Size, "variant": p.Variant}), p.TextProps.Class)
	in.Tag = "legend"
	return in
}

// Legend renders Text with the composition classes.
templ Legend(p LegendProps) {
	@text.Text(legendInner(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 legend
compose/Legend.html.twig
{# Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. #}
{# Legend: Text <legend> + recipe legend. Params: size, variant, class, attrs + the params of Text. #}
{% include 'ui/text/Text.html.twig' with compose_props('Legend', _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 legend
compose/Legend.latte
{* Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. *}
{* Legend: Text <legend> + recipe legend. *}
{parameters
  string $class = '',
  string $tag = '',
  array $attrs = [],
  string $children = '',
  $size = null,
  $variant = null,
}
{include '../ui/text/Text.latte', ...\CodegenX\Compose\Latte\Compose::props('Legend', ['class' => $class, 'tag' => $tag, '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 legend
compose/legend.html.j2
{#- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.
    Legend: Text <legend> + recipe legend. Props (p): Size, Variant, Class, Attrs + the props of Text. -#}
{%- with p = compose_props('Legend', p) %}{% include 'ui/text/text.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.

No props.