@farming-labs/nuxt-theme 0.0.50 → 0.0.52

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/nuxt-theme",
-  "version": "0.0.50",
+  "version": "0.0.52",
   "description": "Nuxt/Vue UI components for @farming-labs/docs — layout, sidebar, TOC, search, and theme toggle",
   "keywords": [
     "docs",
@@ -60,7 +60,7 @@
   },
   "dependencies": {
     "sugar-high": "^0.9.5",
-    "@farming-labs/docs": "0.0.50"
+    "@farming-labs/docs": "0.0.52"
   },
   "peerDependencies": {
     "nuxt": ">=3.0.0",

package/src/components/DocsContent.vue

@@ -20,6 +20,7 @@ const props = defineProps<{
     editOnGithub?: string;
     lastModified?: string;
     entry?: string;
+    slug?: string;
     locale?: string;
   };
   config?: Record<string, unknown> | null;
@@ -29,6 +30,7 @@ const route = useRoute();
 const openDropdownMenu = ref(false);
 const copyLabel = ref("Copy page");
 const copied = ref(false);
+const selectedFeedback = ref<"positive" | "negative" | null>(null);
 
 const titleSuffix = computed(() =>
   props.config?.metadata?.titleTemplate
@@ -145,6 +147,35 @@ const showPageActions = computed(
 );
 const showActionsAbove = computed(() => pageActionsPosition.value === "above-title" && showPageActions.value);
 const showActionsBelow = computed(() => pageActionsPosition.value === "below-title" && showPageActions.value);
+const feedbackConfig = computed(() => {
+  const defaults = {
+    enabled: false,
+    question: "How is this guide?",
+    positiveLabel: "Good",
+    negativeLabel: "Bad",
+    onFeedback: undefined as ((payload: Record<string, unknown>) => void) | undefined,
+  };
+
+  const feedback = props.config?.feedback as Record<string, unknown> | boolean | null | undefined;
+  if (feedback === undefined || feedback === false) return defaults;
+  if (feedback === true) return { ...defaults, enabled: true };
+  if (typeof feedback !== "object" || feedback === null) return defaults;
+
+  return {
+    enabled: feedback.enabled !== false,
+    question: String((feedback as { question?: string }).question ?? defaults.question),
+    positiveLabel: String(
+      feedback.positiveLabel ?? defaults.positiveLabel,
+    ),
+    negativeLabel: String(
+      feedback.negativeLabel ?? defaults.negativeLabel,
+    ),
+    onFeedback:
+      typeof feedback.onFeedback === "function"
+        ? (feedback.onFeedback as (payload: Record<string, unknown>) => void)
+        : undefined,
+  };
+});
 
 useHead({
   title: () => `${props.data.title}${titleSuffix.value}`,
@@ -201,6 +232,43 @@ function openInProvider(provider: { name: string; urlTemplate: string }) {
   closeDropdown();
 }
 
+function handleFeedback(value: "positive" | "negative") {
+  selectedFeedback.value = value;
+
+  const pathname =
+    typeof window !== "undefined"
+      ? window.location.pathname.replace(/\/$/, "") || "/"
+      : props.data.slug
+        ? `/${entry.value}/${props.data.slug}`
+        : `/${entry.value}`;
+
+  const payload = {
+    value,
+    title: props.data.title,
+    description: props.data.description,
+    url: typeof window !== "undefined" ? window.location.href : pathname,
+    pathname,
+    path: pathname,
+    entry: entry.value,
+    slug: props.data.slug ?? "",
+    locale: props.data.locale,
+  };
+
+  try {
+    feedbackConfig.value.onFeedback?.(payload);
+  } catch {}
+
+  try {
+    if (typeof window !== "undefined" && (window as any).__fdOnFeedback__) {
+      (window as any).__fdOnFeedback__(payload);
+    }
+  } catch {}
+
+  if (typeof window !== "undefined") {
+    window.dispatchEvent(new CustomEvent("fd:feedback", { detail: payload }));
+  }
+}
+
 function handleClickOutside(e: MouseEvent) {
   const target = e.target as Node;
   if (openDropdownMenu.value && !(target as Element).closest?.(".fd-page-action-dropdown")) {
@@ -354,5 +422,49 @@ onUnmounted(() => {
     </template>
 
     <div v-html="htmlWithoutFirstH1" />
+
+    <section v-if="feedbackConfig.enabled" class="fd-feedback" aria-label="Page feedback">
+      <div class="fd-feedback-content">
+        <p class="fd-feedback-question">{{ feedbackConfig.question }}</p>
+        <div class="fd-feedback-actions" role="group" :aria-label="feedbackConfig.question">
+          <button
+            type="button"
+            class="fd-page-action-btn"
+            :aria-pressed="selectedFeedback === 'positive'"
+            :data-selected="selectedFeedback === 'positive' ? 'true' : undefined"
+            @click="handleFeedback('positive')"
+          >
+            <svg width="14" height="14" viewBox="0 0 24 24" fill="none" aria-hidden="true">
+              <path
+                d="M7 21H5a2 2 0 0 1-2-2v-7a2 2 0 0 1 2-2h2m0 11V10m0 11h9.28a2 2 0 0 0 1.97-1.66l1.2-7A2 2 0 0 0 17.48 10H13V6.5a2.5 2.5 0 0 0-2.5-2.5L7 10"
+                stroke="currentColor"
+                stroke-width="2"
+                stroke-linecap="round"
+                stroke-linejoin="round"
+              />
+            </svg>
+            <span>{{ feedbackConfig.positiveLabel }}</span>
+          </button>
+          <button
+            type="button"
+            class="fd-page-action-btn"
+            :aria-pressed="selectedFeedback === 'negative'"
+            :data-selected="selectedFeedback === 'negative' ? 'true' : undefined"
+            @click="handleFeedback('negative')"
+          >
+            <svg width="14" height="14" viewBox="0 0 24 24" fill="none" aria-hidden="true">
+              <path
+                d="M17 3h2a2 2 0 0 1 2 2v7a2 2 0 0 1-2 2h-2M17 3v11m0-11H7.72a2 2 0 0 0-1.97 1.66l-1.2 7A2 2 0 0 0 6.52 14H11v3.5a2.5 2.5 0 0 0 2.5 2.5L17 14"
+                stroke="currentColor"
+                stroke-width="2"
+                stroke-linecap="round"
+                stroke-linejoin="round"
+              />
+            </svg>
+            <span>{{ feedbackConfig.negativeLabel }}</span>
+          </button>
+        </div>
+      </div>
+    </section>
   </DocsPage>
 </template>

package/src/components/DocsPage.vue

@@ -70,6 +70,24 @@ function scanHeadings() {
   });
 }
 
+function setHoverLinkOpen(root: HTMLElement, open: boolean) {
+  const trigger = root.querySelector(".fd-hover-link-trigger");
+  const popover = root.querySelector(".fd-hover-link-popover");
+  if (!(trigger instanceof HTMLElement) || !(popover instanceof HTMLElement)) return;
+
+  root.classList.toggle("fd-hover-link-open", open);
+  trigger.setAttribute("aria-expanded", String(open));
+  popover.setAttribute("aria-hidden", String(!open));
+}
+
+function closeOpenHoverLinks(event: Event) {
+  document.querySelectorAll("[data-hover-link].fd-hover-link-open").forEach((root) => {
+    if (!(root instanceof HTMLElement)) return;
+    if (event.target instanceof Node && root.contains(event.target)) return;
+    setHoverLinkOpen(root, false);
+  });
+}
+
 function wireInteractive() {
   requestAnimationFrame(() => {
     document.querySelectorAll(".fd-copy-btn").forEach((btn) => {
@@ -122,6 +140,82 @@ function wireInteractive() {
       const localized = withLang(href);
       if (localized) link.setAttribute("href", localized);
     });
+
+    document.querySelectorAll("[data-hover-link]").forEach((root) => {
+      if (!(root instanceof HTMLElement)) return;
+      if (root.dataset.fdHoverLinkBound === "true") return;
+      root.dataset.fdHoverLinkBound = "true";
+
+      const trigger = root.querySelector(".fd-hover-link-trigger");
+      const popover = root.querySelector(".fd-hover-link-popover");
+      if (!(trigger instanceof HTMLElement) || !(popover instanceof HTMLElement)) return;
+
+      let closeTimer = 0;
+      const containsTarget = (target: EventTarget | null) => target instanceof Node && root.contains(target);
+      const clearCloseTimer = () => {
+        if (closeTimer !== 0) {
+          window.clearTimeout(closeTimer);
+          closeTimer = 0;
+        }
+      };
+
+      const openPopover = () => {
+        clearCloseTimer();
+        setHoverLinkOpen(root, true);
+      };
+      const closePopover = () => {
+        clearCloseTimer();
+        setHoverLinkOpen(root, false);
+      };
+      const closePopoverSoon = () => {
+        clearCloseTimer();
+        closeTimer = window.setTimeout(closePopover, 90);
+      };
+
+      trigger.addEventListener("pointerenter", openPopover);
+      trigger.addEventListener("pointerleave", (event) => {
+        if (containsTarget(event.relatedTarget)) return;
+        closePopoverSoon();
+      });
+      trigger.addEventListener("focus", (event) => {
+        if (!(event.currentTarget instanceof HTMLElement)) return;
+        if (typeof event.currentTarget.matches === "function" && !event.currentTarget.matches(":focus-visible")) {
+          return;
+        }
+        openPopover();
+      });
+      trigger.addEventListener("blur", (event) => {
+        if (containsTarget(event.relatedTarget)) return;
+        closePopoverSoon();
+      });
+      trigger.addEventListener("click", (event) => {
+        event.preventDefault();
+        openPopover();
+      });
+
+      popover.addEventListener("pointerenter", openPopover);
+      popover.addEventListener("pointerleave", (event) => {
+        if (containsTarget(event.relatedTarget)) return;
+        closePopoverSoon();
+      });
+      popover.addEventListener("focusin", openPopover);
+      popover.addEventListener("focusout", (event) => {
+        if (containsTarget(event.relatedTarget)) return;
+        closePopoverSoon();
+      });
+
+      root.addEventListener("keydown", (event) => {
+        if (event.key !== "Escape") return;
+        closePopover();
+      });
+    });
+
+    if (document.documentElement.dataset.fdHoverLinkGlobalBound !== "true") {
+      document.documentElement.dataset.fdHoverLinkGlobalBound = "true";
+
+      document.addEventListener("pointerdown", closeOpenHoverLinks);
+      document.addEventListener("focusin", closeOpenHoverLinks);
+    }
   });
 }
 

package/src/themes/colorful.js

@@ -30,6 +30,7 @@ const ColorfulUIDefaults = {
   components: {
     Callout: { variant: "soft", icon: true },
     CodeBlock: { showCopyButton: true },
+    HoverLink: { linkLabel: "Open page", showIndicator: false },
     Tabs: { style: "default" },
   },
 };

package/src/themes/darksharp.js

@@ -30,6 +30,7 @@ const DarksharpUIDefaults = {
   components: {
     Callout: { variant: "soft", icon: true },
     CodeBlock: { showCopyButton: true },
+    HoverLink: { linkLabel: "Open page", showIndicator: false },
     Tabs: { style: "default" },
   },
 };

package/src/themes/default.js

@@ -30,6 +30,7 @@ const DefaultUIDefaults = {
   components: {
     Callout: { variant: "soft", icon: true },
     CodeBlock: { showCopyButton: true },
+    HoverLink: { linkLabel: "Open page", showIndicator: false },
     Tabs: { style: "default" },
   },
 };

package/src/themes/greentree.js

@@ -30,6 +30,7 @@ const GreenTreeUIDefaults = {
   components: {
     Callout: { variant: "soft", icon: true },
     CodeBlock: { showCopyButton: true },
+    HoverLink: { linkLabel: "Open page", showIndicator: false },
     Tabs: { style: "default" },
   },
 };

package/src/themes/pixel-border.js

@@ -27,7 +27,9 @@ const PixelBorderUIDefaults = {
     toc: { enabled: true, depth: 3 },
     header: { height: 56, sticky: true },
   },
-  components: {},
+  components: {
+    HoverLink: { linkLabel: "Open page", showIndicator: false },
+  },
 };
 
 export const pixelBorder = createTheme({

package/styles/docs.css

@@ -649,10 +649,19 @@ samp {
   color: var(--color-fd-foreground);
 }
 
+.fd-page-action-btn[data-selected="true"] {
+  color: var(--color-fd-accent-foreground);
+  background: var(--color-fd-accent);
+}
+
 .fd-page-action-btn svg {
   flex-shrink: 0;
 }
 
+.fd-page-action-btn[data-selected="true"] svg {
+  color: currentColor;
+}
+
 .fd-page-action-dropdown {
   position: relative;
 }
@@ -720,6 +729,35 @@ samp {
   margin-bottom: 1rem;
 }
 
+.fd-feedback {
+  margin-top: 2rem;
+  padding-top: 1.25rem;
+  border-top: 1px solid var(--color-fd-border);
+}
+
+.fd-feedback-content {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  gap: 1rem;
+  flex-wrap: wrap;
+}
+
+.fd-feedback-question {
+  margin: 0;
+  font-size: 0.9375rem;
+  font-weight: 600;
+  line-height: 1.5;
+  color: var(--color-fd-foreground);
+}
+
+.fd-feedback-actions {
+  display: inline-flex;
+  align-items: center;
+  gap: 0.5rem;
+  flex-wrap: wrap;
+}
+
 /* ─── Breadcrumb ─────────────────────────────────────────────────────── */
 
 .fd-breadcrumb {
@@ -919,6 +957,206 @@ samp {
   opacity: 0.8;
 }
 
+.fd-hover-link {
+  position: relative;
+  display: inline-block;
+  vertical-align: baseline;
+  max-width: 100%;
+}
+
+.fd-hover-link-trigger {
+  display: inline !important;
+  border: none;
+  background: transparent;
+  padding: 0;
+  margin: 0;
+  color: var(--color-fd-foreground);
+  cursor: pointer;
+  text-decoration: underline;
+  text-decoration-style: dashed;
+  text-decoration-thickness: 0.08em;
+  text-underline-offset: 0.22em;
+  text-decoration-color: color-mix(in srgb, var(--color-fd-foreground) 46%, transparent);
+  font: inherit;
+  line-height: inherit;
+  vertical-align: baseline;
+  appearance: none;
+  transition: text-decoration-color 180ms ease, opacity 180ms ease;
+}
+
+.fd-hover-link-trigger:hover,
+.fd-hover-link-trigger:focus-visible,
+.fd-hover-link-open > .fd-hover-link-trigger {
+  text-decoration-color: color-mix(in srgb, var(--color-fd-foreground) 68%, transparent);
+}
+
+.fd-hover-link-trigger:focus-visible {
+  outline: none;
+}
+
+.fd-hover-link-popover {
+  --fd-hover-link-rest-x: -50%;
+  --fd-hover-link-rest-y: 8px;
+  --fd-hover-link-open-x: -50%;
+  --fd-hover-link-open-y: 0;
+  position: absolute;
+  top: calc(100% + var(--fd-hover-link-side-offset, 12px));
+  left: 50%;
+  z-index: 40;
+  width: min(22rem, calc(100vw - 2rem));
+  max-width: min(22rem, calc(100vw - 2rem));
+  opacity: 0;
+  visibility: hidden;
+  pointer-events: none;
+  transform: translate3d(var(--fd-hover-link-rest-x), var(--fd-hover-link-rest-y), 0);
+  transition: opacity 180ms ease, transform 180ms ease, visibility 180ms linear;
+}
+
+.fd-hover-link[data-align="start"] > .fd-hover-link-popover {
+  left: 0;
+  --fd-hover-link-rest-x: 0;
+  --fd-hover-link-open-x: 0;
+}
+
+.fd-hover-link[data-align="end"] > .fd-hover-link-popover {
+  left: auto;
+  right: 0;
+  --fd-hover-link-rest-x: 0;
+  --fd-hover-link-open-x: 0;
+}
+
+.fd-hover-link[data-side="top"] > .fd-hover-link-popover {
+  top: auto;
+  bottom: calc(100% + var(--fd-hover-link-side-offset, 12px));
+  --fd-hover-link-rest-y: -8px;
+  --fd-hover-link-open-y: 0;
+}
+
+.fd-hover-link[data-side="right"] > .fd-hover-link-popover {
+  top: 50%;
+  left: calc(100% + var(--fd-hover-link-side-offset, 12px));
+  right: auto;
+  --fd-hover-link-rest-x: 8px;
+  --fd-hover-link-rest-y: -50%;
+  --fd-hover-link-open-x: 0;
+  --fd-hover-link-open-y: -50%;
+}
+
+.fd-hover-link[data-side="right"][data-align="start"] > .fd-hover-link-popover {
+  top: 0;
+  --fd-hover-link-rest-y: 0;
+  --fd-hover-link-open-y: 0;
+}
+
+.fd-hover-link[data-side="right"][data-align="end"] > .fd-hover-link-popover {
+  top: auto;
+  bottom: 0;
+  --fd-hover-link-rest-y: 0;
+  --fd-hover-link-open-y: 0;
+}
+
+.fd-hover-link[data-side="left"] > .fd-hover-link-popover {
+  top: 50%;
+  left: auto;
+  right: calc(100% + var(--fd-hover-link-side-offset, 12px));
+  --fd-hover-link-rest-x: -8px;
+  --fd-hover-link-rest-y: -50%;
+  --fd-hover-link-open-x: 0;
+  --fd-hover-link-open-y: -50%;
+}
+
+.fd-hover-link[data-side="left"][data-align="start"] > .fd-hover-link-popover {
+  top: 0;
+  --fd-hover-link-rest-y: 0;
+  --fd-hover-link-open-y: 0;
+}
+
+.fd-hover-link[data-side="left"][data-align="end"] > .fd-hover-link-popover {
+  top: auto;
+  bottom: 0;
+  --fd-hover-link-rest-y: 0;
+  --fd-hover-link-open-y: 0;
+}
+
+.fd-hover-link-open > .fd-hover-link-popover {
+  opacity: 1;
+  visibility: visible;
+  pointer-events: auto;
+  transform: translate3d(var(--fd-hover-link-open-x), var(--fd-hover-link-open-y), 0);
+}
+
+.fd-hover-link-card {
+  display: flex;
+  flex-direction: column;
+  gap: 0.75rem;
+  width: 100%;
+  border-radius: calc(var(--radius, 0.75rem) + 2px);
+  border: 1px solid color-mix(in srgb, var(--color-fd-border) 88%, transparent);
+  background: var(--color-fd-popover, var(--color-fd-background));
+  color: var(--color-fd-popover-foreground, var(--color-fd-foreground));
+  padding: 0.95rem 1rem;
+  box-shadow: 0 20px 45px color-mix(in srgb, var(--color-fd-background) 78%, transparent);
+  backdrop-filter: blur(14px);
+}
+
+.fd-hover-link-body {
+  display: flex;
+  flex-direction: column;
+  gap: 0.35rem;
+}
+
+.fd-hover-link-preview-label {
+  font-size: 0.68rem;
+  text-transform: uppercase;
+  letter-spacing: 0.1em;
+  font-family: var(--fd-font-mono, var(--font-geist-mono, ui-monospace, monospace));
+  color: color-mix(in srgb, var(--color-fd-popover-foreground, var(--color-fd-foreground)) 55%, transparent);
+}
+
+.fd-hover-link-title,
+.fd-hover-link-cta {
+  text-decoration: none !important;
+}
+
+.fd-hover-link-title {
+  color: var(--color-fd-popover-foreground, var(--color-fd-foreground));
+  font-size: 1rem;
+  font-weight: 600 !important;
+  line-height: 1.3;
+}
+
+.fd-hover-link-title:hover,
+.fd-hover-link-cta:hover {
+  opacity: 1;
+}
+
+.fd-hover-link-description {
+  font-size: 0.92rem;
+  line-height: 1.6;
+  color: color-mix(in srgb, var(--color-fd-popover-foreground, var(--color-fd-foreground)) 74%, transparent);
+}
+
+.fd-hover-link-footer {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  gap: 0.75rem;
+  padding-top: 0.25rem;
+  border-top: 1px solid color-mix(in srgb, var(--color-fd-border) 72%, transparent);
+}
+
+.fd-hover-link-cta {
+  display: inline-flex !important;
+  align-items: center;
+  gap: 0.4rem;
+  color: var(--color-fd-primary);
+  font-size: 0.8rem;
+  font-weight: 600 !important;
+  text-transform: uppercase;
+  letter-spacing: 0.08em;
+  font-family: var(--fd-font-mono, var(--font-geist-mono, ui-monospace, monospace));
+}
+
 .fd-page-body h1 {
   font-size: var(--fd-h1-size, 2.25rem);
   font-weight: var(--fd-h1-weight, 700);