Box
Box primitive
Install
npx ui8kit add boxPulls in: kit-box, recipes, utils
Preview
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-cdnnpx ui8kit add boxcompose/Box.svelte
<!-- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. -->
<!-- Box: Box + recipe box. -->
<script lang="ts">
import type { ComponentProps, Snippet } from "svelte";
import Prim from "../kit/ui/box/Box.svelte";
import { cn } from "../kit/utils";
import { rc } from "./recipes";
let { tag, class: className, children, ...rest }: Omit<ComponentProps<typeof Prim>, "tag"> & { tag?: string | number; class?: string; children?: Snippet } = $props();
const cls = $derived(cn(rc("box", { }), className));
</script>
<Prim tag={(tag ?? "div") as never} class={cls} {...rest}>{@render children?.()}</Prim>
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-cdnnpx ui8kit add boxcompose/box.tsx
// Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.
import type { ComponentProps } from "react";
import { Box as Prim } from "../kit/ui/box/box";
import { cn } from "../kit/utils";
import { rc } from "./recipes";
export type BoxProps = Omit<ComponentProps<typeof Prim>, "tag"> & { tag?: string; className?: string };
/** Box: Box + recipe box. */
export function Box({ tag, className, ...rest }: BoxProps) {
return <Prim tag={(tag ?? "div") as never} className={cn(rc("box", { }), className)} {...rest} />;
}
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-cdnnpx ui8kit add boxcompose/Box.vue
<!-- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. -->
<!-- Box: Box + recipe box. -->
<script setup lang="ts">
import { computed, useAttrs } from "vue";
import Prim from "../kit/ui/box/Box.vue";
import { cn } from "../kit/utils";
import { rc } from "./recipes";
defineOptions({ name: "Box", inheritAttrs: false });
const props = defineProps<{ tag?: string | number }>();
const attrs = useAttrs();
const rest = computed(() => {
const { class: _class, ...r } = attrs;
return r;
});
const cls = computed(() => cn(rc("box", { }), attrs.class as string | undefined));
const tagValue = computed(() => (props.tag ?? "div"));
</script>
<template>
<Prim :tag="tagValue as never" :class="cls" v-bind="rest"><slot /></Prim>
</template>
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-cdnnpx ui8kit add boxcompose/box.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 { Box as Prim } from "../kit/ui/box/box.solid";
import { cn } from "../kit/utils";
import { rc } from "./recipes";
export type BoxProps = Omit<ComponentProps<typeof Prim>, "tag" | "class" | "className"> & { tag?: string; class?: string; className?: string };
/** Box: Box + recipe box. */
export function Box(props: BoxProps) {
const [local, rest] = splitProps(props, ["tag", "class", "className"]);
return <Prim tag={(local.tag ?? "div") as never} class={cn(rc("box", { }), local.class ?? local.className)} {...rest} />;
}
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-cdnnpx ui8kit add boxcompose/box.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/box"
// BoxProps: Box: Box + recipe box.
type BoxProps struct {
box.BoxProps
}
func boxInner(p BoxProps) box.BoxProps {
in := p.BoxProps
in.Class = Join(Rc("box", map[string]string{}), p.BoxProps.Class)
in.Tag = Or(in.Tag, "div")
return in
}
// Box renders Box with the composition classes.
templ Box(p BoxProps) {
@box.Box(boxInner(p)) {
{ children... }
}
}
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-cdnnpx ui8kit add boxcompose/Box.html.twig
{# Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. #}
{# Box: Box + recipe box. Params: tag, class, attrs + the params of Box. #}
{% include 'ui/box/Box.html.twig' with compose_props('Box', _context) only %}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-cdnnpx ui8kit add boxcompose/Box.latte
{* Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. *}
{* Box: Box + recipe box. *}
{parameters
string $class = '',
string $tag = '',
array $attrs = [],
string $children = '',
}
{include '../ui/box/Box.latte', ...\CodegenX\Compose\Latte\Compose::props('Box', ['class' => $class, 'tag' => $tag, 'attrs' => $attrs, 'children' => $children])}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-cdnnpx ui8kit add boxcompose/box.html.j2
{#- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.
Box: Box + recipe box. Props (p): Tag, Class, Attrs + the props of Box. -#}
{%- with p = compose_props('Box', p) %}{% include 'ui/box/box.html.j2' %}{% endwith %}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.
Box renders the requested structural HTML element (default div).
| Prop | Type | Default | Description |
|---|---|---|---|
| tag | string | - | HTML5 structural tag (default div) |