Shell Footer
Shell Footer component
Install
npx ui8kit add shell-footerPulls in: block, compose, dashboard-shell, kit-box, kit-text, list, list-item, menu-entry, nav-block, text, 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 shell-footer<!-- Code generated by packages/kit-compose/src/organisms.ts from packages/compose-gen/specs (compose-gen organism emitters on kit-compose). DO NOT EDIT. -->
<!--
The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the
whole shell (full).
-->
<script lang="ts" module>
import type { Snippet } from "svelte";
import type { ShellNav } from "../blocks/dashboard-shell.types";
export type ShellFooterProps = {
nav: ShellNav;
place?: "full" | "inset";
landmarkLabel?: string;
};
</script>
<script lang="ts">
import Block from "../compose/Block.svelte";
import List from "../compose/List.svelte";
import ListItem from "../compose/ListItem.svelte";
import Text from "../compose/Text.svelte";
import MenuEntry from "../components/menu-entry.svelte";
import NavBlock from "../components/nav-block.svelte";
import { cn, tpl, uniqLabel } from "../utils";
let { nav, place = "full", landmarkLabel }: ShellFooterProps = $props();
</script>
<Block
tag="footer"
class={cn(
"flex shrink-0 flex-wrap items-center justify-between gap-4 border-t border-border px-6 py-4",
(((place as string) === "full") ? "bg-card" : "")
)}
data-place={place}
aria-label={landmarkLabel}
data-slot="footer"
>
<Text size="xs" class="text-muted-foreground">
{nav.copyright}
</Text>
{#if ((nav.footer?.length ?? 0) > 0)}
<NavBlock
label={
landmarkLabel ? uniqLabel(tpl("{0}, {1}", nav.footerLabel, landmarkLabel))
: nav.footerLabel
}
>
<List class="m-0 flex list-none items-center gap-4 p-0">
{#each nav.footer as f (f.id)}
<ListItem data-slot="footer-row">
<MenuEntry href={f.href} class="text-xs text-muted-foreground" variant="muted" size="sm">
{f.name}
</MenuEntry>
</ListItem>
{/each}
</List>
</NavBlock>
{/if}
</Block>
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 shell-footer// Code generated by packages/kit-compose/src/organisms.ts from packages/compose-gen/specs (compose-gen organism emitters on kit-compose). DO NOT EDIT.
/**
* The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the
* whole shell (full).
*/
import { type ReactNode } from "react";
import { Block, List, ListItem, Text } from "../compose";
import { MenuEntry } from "../components/menu-entry";
import { NavBlock } from "../components/nav-block";
import { cn, tpl, uniqLabel } from "../utils";
import type { ShellNav } from "../blocks/dashboard-shell.types";
export type ShellFooterProps = {
nav: ShellNav;
place?: "full" | "inset";
landmarkLabel?: string;
};
export function ShellFooter({ nav, place = "full", landmarkLabel }: ShellFooterProps) {
return (
<Block
tag="footer"
className={cn(
"flex shrink-0 flex-wrap items-center justify-between gap-4 border-t border-border px-6 py-4",
(((place as string) === "full") ? "bg-card" : "")
)}
data-place={place}
aria-label={landmarkLabel}
data-slot="footer"
>
<Text size="xs" className="text-muted-foreground">
{nav.copyright}
</Text>
{((nav.footer?.length ?? 0) > 0) ? (
<NavBlock
label={
landmarkLabel ? uniqLabel(tpl("{0}, {1}", nav.footerLabel, landmarkLabel))
: nav.footerLabel
}
>
<List className="m-0 flex list-none items-center gap-4 p-0">
{(nav.footer ?? []).map((f) => (
<ListItem key={f.id} data-slot="footer-row">
<MenuEntry href={f.href} className="text-xs text-muted-foreground" variant="muted" size="sm">
{f.name}
</MenuEntry>
</ListItem>
))}
</List>
</NavBlock>
) : null}
</Block>
);
}
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 shell-footer<!-- Code generated by packages/kit-compose/src/organisms.ts from packages/compose-gen/specs (compose-gen organism emitters on kit-compose). DO NOT EDIT. -->
<!--
The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the
whole shell (full).
-->
<script lang="ts">
import type { ShellNav } from "../blocks/dashboard-shell.types";
export type ShellFooterProps = {
nav: ShellNav;
place?: "full" | "inset";
landmarkLabel?: string;
};
</script>
<script setup lang="ts">
import Block from "../compose/Block.vue";
import List from "../compose/List.vue";
import ListItem from "../compose/ListItem.vue";
import Text from "../compose/Text.vue";
import MenuEntry from "../components/menu-entry.vue";
import NavBlock from "../components/nav-block.vue";
import { cn, tpl, uniqLabel } from "../utils";
const { nav, place = "full", landmarkLabel } = defineProps<ShellFooterProps>();
</script>
<template>
<Block
tag="footer"
:class="cn(
'flex shrink-0 flex-wrap items-center justify-between gap-4 border-t border-border px-6 py-4',
(((place as string) === 'full') ? 'bg-card' : '')
)"
:data-place="place"
:aria-label="landmarkLabel"
data-slot="footer"
>
<Text size="xs" class="text-muted-foreground">
{{ nav.copyright }}
</Text>
<NavBlock v-if="((nav.footer?.length ?? 0) > 0)"
:label="
landmarkLabel ? uniqLabel(tpl('{0}, {1}', nav.footerLabel, landmarkLabel))
: nav.footerLabel
"
>
<List class="m-0 flex list-none items-center gap-4 p-0">
<ListItem v-for="f in nav.footer" :key="f.id" data-slot="footer-row">
<MenuEntry :href="f.href" class="text-xs text-muted-foreground" variant="muted" size="sm">
{{ f.name }}
</MenuEntry>
</ListItem>
</List>
</NavBlock>
</Block>
</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 shell-footer// Code generated by packages/kit-compose/src/organisms.ts from packages/compose-gen/specs (compose-gen organism emitters on kit-compose). DO NOT EDIT.
/**
* The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the
* whole shell (full).
*/
import { For, type JSX } from "solid-js";
import { Block, List, ListItem, Text } from "../compose";
import { MenuEntry } from "../components/menu-entry";
import { NavBlock } from "../components/nav-block";
import { cn, tpl, uniqLabel } from "../utils";
import type { ShellNav } from "../blocks/dashboard-shell.types";
export type ShellFooterProps = {
nav: ShellNav;
place?: "full" | "inset";
landmarkLabel?: string;
};
export function ShellFooter({ nav, place = "full", landmarkLabel }: ShellFooterProps) {
return (
<Block
tag="footer"
class={cn(
"flex shrink-0 flex-wrap items-center justify-between gap-4 border-t border-border px-6 py-4",
(((place as string) === "full") ? "bg-card" : "")
)}
data-place={place}
aria-label={landmarkLabel}
data-slot="footer"
>
<Text size="xs" class="text-muted-foreground">
{nav.copyright}
</Text>
{((nav.footer?.length ?? 0) > 0) ? (
<NavBlock
label={
landmarkLabel ? uniqLabel(tpl("{0}, {1}", nav.footerLabel, landmarkLabel))
: nav.footerLabel
}
>
<List class="m-0 flex list-none items-center gap-4 p-0">
<For each={nav.footer ?? []}>{(f) => (
<ListItem data-slot="footer-row">
<MenuEntry href={f.href} class="text-xs text-muted-foreground" variant="muted" size="sm">
{f.name}
</MenuEntry>
</ListItem>
)}</For>
</List>
</NavBlock>
) : null}
</Block>
);
}
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 shell-footer// Code generated by packages/kit-compose/src/server-organisms.ts from packages/compose-gen/specs (compose-gen organism emitters on kit-compose). DO NOT EDIT.
// Source: packages/compose-gen/specs/organisms/shell-footer.json
package blocks
import (
"github.com/ui8kit/codegen/generated/templ/ui/box"
"github.com/ui8kit/codegen/generated/templ/compose"
"github.com/ui8kit/codegen/generated/templ/ui/text"
uiutils "github.com/ui8kit/codegen/generated/templ/orgutils"
)
// ShellFooterProps are the props of ShellFooter; the values are the JSON shapes of the TypeScript props.
type ShellFooterProps struct {
Nav any `json:"nav"`
Place any `json:"place"`
LandmarkLabel any `json:"landmarkLabel"`
}
// The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the whole shell (full).
templ ShellFooter(p ShellFooterProps) {
{{ vNav := p.Nav }}
{{ vPlace := uiutils.Def(p.Place, "full") }}
{{ vLandmarkLabel := p.LandmarkLabel }}
@compose.Block(compose.BlockProps{BoxProps: box.BoxProps{Tag: "footer", Class: uiutils.S(uiutils.Cnv("flex shrink-0 flex-wrap items-center justify-between gap-4 border-t border-border px-6 py-4", uiutils.Cond(uiutils.T(uiutils.Eq(vPlace, "full")), "bg-card", ""))), Attrs: uiutils.Attrs("data-place", vPlace, "aria-label", vLandmarkLabel, "data-slot", "footer")}}) {
@compose.Text(compose.TextProps{Size: "xs", TextProps: text.TextProps{Class: "text-muted-foreground"}}) {
{ uiutils.Text(uiutils.Get(vNav, "copyright")) }
}
if uiutils.Gt(uiutils.Len(uiutils.Get(vNav, "footer")), float64(0)) {
@NavBlock(NavBlockProps{Label: uiutils.Cond(uiutils.T(vLandmarkLabel), uiutils.Uniq(uiutils.Tpl("{0}, {1}", uiutils.Get(vNav, "footerLabel"), vLandmarkLabel)), uiutils.Get(vNav, "footerLabel"))}) {
@compose.List(compose.ListProps{BoxProps: box.BoxProps{Class: "m-0 flex list-none items-center gap-4 p-0"}}) {
for _, vF := range uiutils.L(uiutils.Get(vNav, "footer")) {
@compose.ListItem(compose.ListItemProps{BoxProps: box.BoxProps{Attrs: uiutils.Attrs("data-slot", "footer-row")}}) {
@MenuEntry(MenuEntryProps{Href: uiutils.Get(vF, "href"), Class: uiutils.Cnv("text-xs text-muted-foreground"), Variant: "muted", Size: "sm"}) {
{ uiutils.Text(uiutils.Get(vF, "name")) }
}
}
}
}
}
}
}
}
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 shell-footer{#- Code generated by packages/kit-compose/src/server-organisms.ts from packages/compose-gen/specs (compose-gen organism emitters on kit-compose). DO NOT EDIT.
Source: packages/compose-gen/specs/organisms/shell-footer.json
The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the whole shell (full).
Props (p): nav, place, landmarkLabel. -#}
{%- set v_nav = (p.nav ?? null) -%}
{%- set v_place = (p.place ?? 'full') -%}
{%- set v_landmarkLabel = (p.landmarkLabel ?? null) -%}
{%- set c_6 -%}
{%- set c_1 -%}
{{ og_text(og_get(v_nav, ['copyright'])) }}
{%- endset -%}
{{ include('compose/Text.html.twig', {'size': 'xs', 'class': 'text-muted-foreground', 'children': c_1}, with_context = false) }}
{%- if og_t(og_gt(og_len(og_get(v_nav, ['footer'])), 0)) %}
{%- set c_5 -%}
{%- set c_4 -%}
{%- for v_f in og_l(og_get(v_nav, ['footer'])) %}
{%- set c_3 -%}
{%- set c_2 -%}
{{ og_text(og_get(v_f, ['name'])) }}
{%- endset -%}
{{ include('blocks/menu-entry.html.twig', {'p': {'href': og_get(v_f, ['href']), 'className': og_cnv(['text-xs text-muted-foreground']), 'variant': 'muted', 'size': 'sm'}, 'children': og_markup(c_2)}, with_context = false) }}
{%- endset -%}
{{ include('compose/ListItem.html.twig', {'attrs': og_attrs(['data-slot', 'footer-row']), 'children': c_3}, with_context = false) }}
{%- endfor %}
{%- endset -%}
{{ include('compose/List.html.twig', {'class': 'm-0 flex list-none items-center gap-4 p-0', 'children': c_4}, with_context = false) }}
{%- endset -%}
{{ include('blocks/nav-block.html.twig', {'p': {'label': (og_t(v_landmarkLabel) ? og_uniq(og_tpl('{0}, {1}', [og_get(v_nav, ['footerLabel']), v_landmarkLabel])) : og_get(v_nav, ['footerLabel']))}, 'children': og_markup(c_5)}, with_context = false) }}
{%- endif %}
{%- endset -%}
{{ include('compose/Block.html.twig', {'tag': 'footer', 'class': og_s(og_cnv(['flex shrink-0 flex-wrap items-center justify-between gap-4 border-t border-border px-6 py-4', (og_t(og_eq(v_place, 'full')) ? 'bg-card' : '')])), 'attrs': og_attrs(['data-place', v_place, 'aria-label', v_landmarkLabel, 'data-slot', 'footer']), 'children': c_6}, with_context = false) }}
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 shell-footer{* Code generated by packages/kit-compose/src/server-organisms.ts from packages/compose-gen/specs (compose-gen organism emitters on kit-compose). DO NOT EDIT.
Source: packages/compose-gen/specs/organisms/shell-footer.json
The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the whole shell (full).
Props (p): nav, place, landmarkLabel. *}
{var $v_nav = ($p['nav'] ?? null)}
{var $v_place = ($p['place'] ?? 'full')}
{var $v_landmarkLabel = ($p['landmarkLabel'] ?? null)}
{capture $c_6}
{capture $c_1}
{=og_text(og_get($v_nav, ['copyright']))}
{/capture}
{=og_include('compose/Text.latte', ['size' => 'xs', 'class' => 'text-muted-foreground', 'children' => (string) $c_1])|noescape}
{if og_t(og_gt(og_len(og_get($v_nav, ['footer'])), 0))}
{capture $c_5}
{capture $c_4}
{foreach og_l(og_get($v_nav, ['footer'])) as $v_f}
{capture $c_3}
{capture $c_2}
{=og_text(og_get($v_f, ['name']))}
{/capture}
{=og_include('blocks/menu-entry.latte', ['p' => ['href' => og_get($v_f, ['href']), 'className' => og_cnv(['text-xs text-muted-foreground']), 'variant' => 'muted', 'size' => 'sm'], 'children' => og_markup($c_2)])|noescape}
{/capture}
{=og_include('compose/ListItem.latte', ['attrs' => og_attrs(['data-slot', 'footer-row']), 'children' => (string) $c_3])|noescape}
{/foreach}
{/capture}
{=og_include('compose/List.latte', ['class' => 'm-0 flex list-none items-center gap-4 p-0', 'children' => (string) $c_4])|noescape}
{/capture}
{=og_include('blocks/nav-block.latte', ['p' => ['label' => (og_t($v_landmarkLabel) ? og_uniq(og_tpl('{0}, {1}', [og_get($v_nav, ['footerLabel']), $v_landmarkLabel])) : og_get($v_nav, ['footerLabel']))], 'children' => og_markup($c_5)])|noescape}
{/if}
{/capture}
{=og_include('compose/Block.latte', ['tag' => 'footer', 'class' => og_s(og_cnv(['flex shrink-0 flex-wrap items-center justify-between gap-4 border-t border-border px-6 py-4', (og_t(og_eq($v_place, 'full')) ? 'bg-card' : '')])), 'attrs' => og_attrs(['data-place', $v_place, 'aria-label', $v_landmarkLabel, 'data-slot', 'footer']), 'children' => (string) $c_6])|noescape}
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 shell-footer{#- Code generated by packages/kit-compose/src/server-organisms.ts from packages/compose-gen/specs (compose-gen organism emitters on kit-compose). DO NOT EDIT.
Source: packages/compose-gen/specs/organisms/shell-footer.json
The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the whole shell (full).
Props (p): nav, place, landmarkLabel. -#}
{%- set v_nav = og_def(p['nav'], none) -%}
{%- set v_place = og_def(p['place'], 'full') -%}
{%- set v_landmarkLabel = og_def(p['landmarkLabel'], none) -%}
{%- set c_6 -%}
{%- set c_1 -%}
{{ og_text(og_get(v_nav, ['copyright'])) }}
{%- endset -%}
{{ og_include('compose/text.html.j2', {'p': {'Size': 'xs', 'Class': 'text-muted-foreground'}, 'children': c_1}) }}
{%- if og_t(og_gt(og_len(og_get(v_nav, ['footer'])), 0)) %}
{%- set c_5 -%}
{%- set c_4 -%}
{%- for v_f in og_l(og_get(v_nav, ['footer'])) %}
{%- set c_3 -%}
{%- set c_2 -%}
{{ og_text(og_get(v_f, ['name'])) }}
{%- endset -%}
{{ og_include('blocks/menu-entry.html.j2', {'p': {'href': og_get(v_f, ['href']), 'className': og_cnv(['text-xs text-muted-foreground']), 'variant': 'muted', 'size': 'sm'}, 'children': og_markup(c_2)}) }}
{%- endset -%}
{{ og_include('compose/list-item.html.j2', {'p': {'Attrs': og_attrs(['data-slot', 'footer-row'])}, 'children': c_3}) }}
{%- endfor %}
{%- endset -%}
{{ og_include('compose/list.html.j2', {'p': {'Class': 'm-0 flex list-none items-center gap-4 p-0'}, 'children': c_4}) }}
{%- endset -%}
{{ og_include('blocks/nav-block.html.j2', {'p': {'label': (og_uniq(og_tpl('{0}, {1}', [og_get(v_nav, ['footerLabel']), v_landmarkLabel])) if og_t(v_landmarkLabel) else og_get(v_nav, ['footerLabel']))}, 'children': og_markup(c_5)}) }}
{%- endif %}
{%- endset -%}
{{ og_include('compose/block.html.j2', {'p': {'Tag': 'footer', 'Class': og_s(og_cnv(['flex shrink-0 flex-wrap items-center justify-between gap-4 border-t border-border px-6 py-4', ('bg-card' if og_t(og_eq(v_place, 'full')) else '')])), 'Attrs': og_attrs(['data-place', v_place, 'aria-label', v_landmarkLabel, 'data-slot', 'footer'])}, 'children': c_6}) }}
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.
The footer of DashboardShell: the copyright and a row of links, under the content column (inset) or across the whole shell (full).
| Prop | Type | Default | Description |
|---|---|---|---|
| nav (required) | ShellNav | - | the brand, the links and the texts of the shell |
| place | "full" | "inset" | "full" | |
| landmarkLabel | string | - | accessible name of the landmark of this component when the page shows it more than once (a variant); replaces the heading name of the root landmark, follows the name of a nested one |