Skip to content
ui8kit

primitive / primitives

List

List primitive

Install

npx ui8kit add list

Pulls in: kit-box, recipes, utils

Preview

default

    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 list
    compose/List.svelte
    <!-- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. -->
    <!-- List: Box + recipe list. -->
    <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("list", {  }), className));
    </script>
    
    <Prim tag={(tag ?? "ul") 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 list
    compose/list.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 ListProps = Omit<ComponentProps<typeof Prim>, "tag"> & { tag?: string; className?: string };
    
    /** List: Box + recipe list. */
    export function List({ tag, className, ...rest }: ListProps) {
      return <Prim tag={(tag ?? "ul") as never} className={cn(rc("list", {  }), 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 list
    compose/List.vue
    <!-- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. -->
    <!-- List: Box + recipe list. -->
    <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: "List", 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("list", {  }), attrs.class as string | undefined));
    const tagValue = computed(() => (props.tag ?? "ul"));
    </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 list
    compose/list.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 ListProps = Omit<ComponentProps<typeof Prim>, "tag" | "class" | "className"> & { tag?: string; class?: string; className?: string };
    
    /** List: Box + recipe list. */
    export function List(props: ListProps) {
      const [local, rest] = splitProps(props, ["tag", "class", "className"]);
      return <Prim tag={(local.tag ?? "ul") as never} class={cn(rc("list", {  }), 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 list
    compose/list.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"
    
    // ListProps: List: Box + recipe list.
    type ListProps struct {
    	box.BoxProps
    }
    
    func listInner(p ListProps) box.BoxProps {
    	in := p.BoxProps
    	in.Class = Join(Rc("list", map[string]string{}), p.BoxProps.Class)
    	in.Tag = Or(in.Tag, "ul")
    	return in
    }
    
    // List renders Box with the composition classes.
    templ List(p ListProps) {
    	@box.Box(listInner(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 list
    compose/List.html.twig
    {# Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. #}
    {# List: Box + recipe list. Params: tag, class, attrs + the params of Box. #}
    {% include 'ui/box/Box.html.twig' with compose_props('List', _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 list
    compose/List.latte
    {* Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT. *}
    {* List: Box + recipe list. *}
    {parameters
      string $class = '',
      string $tag = '',
      array $attrs = [],
      string $children = '',
    }
    {include '../ui/box/Box.latte', ...\CodegenX\Compose\Latte\Compose::props('List', ['class' => $class, 'tag' => $tag, 'attrs' => $attrs, 'children' => $children])}

    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 list
    compose/list.html.j2
    {#- Code generated by packages/kit-compose/src/build.ts from src/map.ts + variants/. DO NOT EDIT.
        List: Box + recipe list. Props (p): Tag, Class, Attrs + the props of Box. -#}
    {%- with p = compose_props('List', p) %}{% include 'ui/box/box.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.