@octabits-io/nuxt-ui-kit 0.2.1 → 0.3.1

package/src/components/PageHeader.vue

@@ -0,0 +1,110 @@
+<script setup lang="ts">
+// Shipped as source: the consumer's Vite compiles this SFC. All imports are
+// explicit — no reliance on the consumer's auto-import configuration.
+// i18n key contract: pageChrome.back (+ PageActionMenu/PageUtilityActions keys).
+import { computed } from 'vue'
+import { useI18n } from 'vue-i18n'
+import { useRouter, type RouteLocationRaw } from 'vue-router'
+import UButton from '@nuxt/ui/components/Button.vue'
+import USkeleton from '@nuxt/ui/components/Skeleton.vue'
+import type { DropdownMenuItem } from '@nuxt/ui'
+import PageActionMenu from './PageActionMenu.vue'
+import PageUtilityActions from './PageUtilityActions.vue'
+
+/**
+ * Standard page header.
+ *
+ * Conventions enforced by this component and its siblings:
+ * - Max 3 neutral icon buttons inline in `#actions`; more go in `overflowItems`.
+ * - Destructive actions are ALWAYS placed inside the overflow menu, never inline.
+ * - Header height, spacing, and tooltip behavior are normalized via `PageAction`.
+ * - Utility triggers (Help, AI history, …) live in `#utility` (default =
+ *   `PageUtilityActions`) and render as LABELED buttons, not icon-only.
+ */
+const props = withDefaults(defineProps<{
+  title?: string
+  subtitle?: string
+  /** Show a leading back button. `true` uses router.back(); pass `{ to }` to navigate. */
+  back?: boolean | { to: RouteLocationRaw }
+  /** Show skeleton title while loading. */
+  loading?: boolean
+  /**
+   * `default` = full-width top-of-page header with padding.
+   * `compact` = sits inside a detail panel / sidebar; smaller title + thinner divider.
+   * `flush`   = no padding/border (caller wraps it).
+   */
+  density?: 'default' | 'compact' | 'flush'
+  /** When false, the default utility cluster is hidden. */
+  utility?: boolean
+  /** Optional grouped overflow items. Alternative to using the #overflow slot. */
+  overflowItems?: DropdownMenuItem[][]
+}>(), {
+  back: false,
+  loading: false,
+  density: 'default',
+  utility: true,
+  overflowItems: () => [],
+})
+
+const { t } = useI18n()
+const router = useRouter()
+
+function onBack() {
+  if (typeof props.back === 'object' && props.back && 'to' in props.back) {
+    router.push(props.back.to)
+    return
+  }
+  router.back()
+}
+
+const wrapperClass = computed(() => {
+  switch (props.density) {
+    case 'compact':
+      return 'flex items-center gap-2 flex-wrap border-b border-default px-6 py-4'
+    case 'flush':
+      return 'flex items-center gap-2 flex-wrap'
+    case 'default':
+    default:
+      return 'flex items-center gap-2 flex-wrap'
+  }
+})
+
+const titleClass = computed(() => props.density === 'compact' ? 'font-display text-lg font-semibold tracking-tight' : 'font-display text-2xl font-semibold tracking-tight')
+</script>
+
+<template>
+  <div :class="wrapperClass">
+    <UButton
+      v-if="back"
+      icon="i-lucide-arrow-left"
+      color="neutral"
+      variant="ghost"
+      size="sm"
+      :aria-label="t('pageChrome.back')"
+      @click="onBack"
+    />
+
+    <div class="min-w-0">
+      <slot name="title">
+        <USkeleton v-if="loading" class="h-7 w-40" />
+        <h1 v-else-if="title" :class="titleClass">{{ title }}</h1>
+      </slot>
+      <p v-if="subtitle && !loading" class="text-sm text-muted mt-1">{{ subtitle }}</p>
+    </div>
+
+    <div v-if="$slots.badges" class="flex items-center gap-2">
+      <slot name="badges" />
+    </div>
+
+    <div class="ml-auto flex items-center gap-1">
+      <slot name="actions" />
+      <PageActionMenu
+        v-if="overflowItems.length"
+        :items="overflowItems"
+      />
+      <slot name="utility">
+        <PageUtilityActions v-if="utility" />
+      </slot>
+    </div>
+  </div>
+</template>

package/src/components/PageUtilityActions.vue

@@ -0,0 +1,31 @@
+<script setup lang="ts">
+// Shipped as source: the consumer's Vite compiles this SFC. All imports are
+// explicit — no reliance on the consumer's auto-import configuration.
+// i18n key contract: pageChrome.help.
+// Utility triggers stay LABELED buttons (not icon-only) by convention.
+import { computed, inject } from 'vue'
+import { useI18n } from 'vue-i18n'
+import USeparator from '@nuxt/ui/components/Separator.vue'
+import UButton from '@nuxt/ui/components/Button.vue'
+import { HELP_PANEL_KEY } from '@octabits-io/nuxt-ui-kit'
+
+const { t } = useI18n()
+const helpPanel = inject(HELP_PANEL_KEY, null)
+
+const showHelp = computed(() => Boolean(helpPanel?.hasActions.value))
+</script>
+
+<template>
+  <div v-if="showHelp" class="flex items-center gap-1">
+    <USeparator orientation="vertical" class="h-5 mx-1" />
+    <UButton
+      v-if="helpPanel"
+      icon="i-lucide-circle-help"
+      :label="t('pageChrome.help')"
+      size="sm"
+      color="neutral"
+      :variant="helpPanel.isOpen.value ? 'soft' : 'ghost'"
+      @click="helpPanel.toggle()"
+    />
+  </div>
+</template>

package/src/components/TranslationBadge.vue

@@ -0,0 +1,65 @@
+<script setup lang="ts">
+// Shipped as source: the consumer's Vite compiles this SFC. All imports are
+// explicit — no reliance on the consumer's auto-import configuration.
+// i18n key contract: localeField.translationStatus.complete / .missing.
+// Requires provideLocaleFieldContext() near the app root.
+import { computed, toValue } from 'vue'
+import { useI18n } from 'vue-i18n'
+import UTooltip from '@nuxt/ui/components/Tooltip.vue'
+import UBadge from '@nuxt/ui/components/Badge.vue'
+import UIcon from '@nuxt/ui/components/Icon.vue'
+import {
+  useLocaleFieldContext,
+  type TranslationStatus,
+} from '@octabits-io/nuxt-ui-kit/locale'
+
+/**
+ * Translation-completeness badge for list rows and detail headers.
+ *
+ * - Hidden for single-locale content (nothing to translate into).
+ * - Green check when every in-use translatable leaf covers all supported
+ *   locales (register variants inherit their base).
+ * - Orange with the total missing-leaf count otherwise; the tooltip breaks
+ *   the count down per locale.
+ */
+const props = defineProps<{
+  status: TranslationStatus | undefined
+}>()
+
+const { t } = useI18n()
+const { locales } = useLocaleFieldContext().useSource()
+
+const visible = computed(() => !!props.status && toValue(locales).length > 1)
+
+const totalMissing = computed(() =>
+  Object.values(props.status?.missing ?? {}).reduce((sum, n) => sum + n, 0),
+)
+
+const tooltip = computed(() => {
+  if (!props.status) return ''
+  if (props.status.complete) return t('localeField.translationStatus.complete')
+  const perLocale = Object.entries(props.status.missing)
+    .map(([locale, n]) => `${locale.toUpperCase()}: ${n}`)
+    .join(', ')
+  return t('localeField.translationStatus.missing', { details: perLocale })
+})
+</script>
+
+<template>
+  <UTooltip v-if="visible" :text="tooltip">
+    <UBadge
+      v-if="!status!.complete"
+      color="warning"
+      variant="subtle"
+      size="xs"
+      icon="i-lucide-languages"
+      :label="String(totalMissing)"
+    />
+    <UIcon
+      v-else
+      name="i-lucide-check-circle-2"
+      class="size-4 text-success"
+      :aria-label="t('localeField.translationStatus.complete')"
+    />
+  </UTooltip>
+</template>

package/src/styles.css

@@ -0,0 +1,17 @@
+/*
+ * Tailwind v4 source registration for the kit's source-shipped SFCs.
+ *
+ * The kit's components live in the consumer's node_modules, which Tailwind's
+ * automatic source detection skips — so utility classes that appear only in
+ * kit markup (e.g. SubSidebar's default `w-[240px]`) would be missing from
+ * the consumer's CSS build. Importing this file registers them:
+ *
+ *   @import "tailwindcss";
+ *   @import "@nuxt/ui";
+ *   @import "@octabits-io/nuxt-ui-kit/styles.css";
+ *
+ * The @source path resolves relative to THIS file (same mechanism @nuxt/ui
+ * uses in its own shipped CSS), so consumers never hardcode node_modules
+ * paths.
+ */
+@source "./components";