@farming-labs/theme 0.2.15 → 0.2.16

package/dist/docs-feedback.d.mts

@@ -8,6 +8,7 @@ interface DocsFeedbackProps {
   locale?: string;
   question?: string;
   placeholder?: string;
+  requireComment?: boolean;
   positiveLabel?: string;
   negativeLabel?: string;
   submitLabel?: string;
@@ -20,6 +21,7 @@ declare function DocsFeedback({
   locale,
   question,
   placeholder,
+  requireComment,
   positiveLabel,
   negativeLabel,
   submitLabel,

package/dist/docs-feedback.mjs

@@ -116,12 +116,13 @@ function CheckIcon() {
 		})
 	});
 }
-function DocsFeedback({ pathname, entry, locale, question = "How is this guide?", placeholder = "Leave your feedback...", positiveLabel = "Good", negativeLabel = "Bad", submitLabel = "Submit", onFeedback, analytics = false }) {
+function DocsFeedback({ pathname, entry, locale, question = "How is this guide?", placeholder = "Leave your feedback...", requireComment = false, positiveLabel = "Good", negativeLabel = "Bad", submitLabel = "Submit", onFeedback, analytics = false }) {
 	const [selected, setSelected] = useState(null);
 	const [comment, setComment] = useState("");
 	const [status, setStatus] = useState("idle");
 	const normalizedPathname = useMemo(() => normalizePathname(pathname), [pathname]);
 	const showForm = selected !== null;
+	const commentRequired = requireComment && comment.trim().length === 0;
 	const submitButtonLabel = status === "submitted" ? "Submitted" : submitLabel;
 	useEffect(() => {
 		setSelected(null);
@@ -151,7 +152,7 @@ function DocsFeedback({ pathname, entry, locale, question = "How is this guide?"
 		}
 	}
 	async function handleSubmit() {
-		if (!selected || status === "submitting") return;
+		if (!selected || status === "submitting" || commentRequired) return;
 		setStatus("submitting");
 		const payload = buildFeedbackPayload(selected, normalizedPathname, entry, comment, locale);
 		try {
@@ -221,6 +222,8 @@ function DocsFeedback({ pathname, entry, locale, question = "How is this guide?"
 					className: "fd-feedback-input",
 					"aria-label": "Additional feedback",
 					placeholder,
+					required: requireComment,
+					"aria-required": requireComment,
 					value: comment,
 					disabled: status === "submitting",
 					onChange: (event) => {
@@ -233,7 +236,7 @@ function DocsFeedback({ pathname, entry, locale, question = "How is this guide?"
 					children: [/* @__PURE__ */ jsxs("button", {
 						type: "button",
 						className: "fd-page-action-btn fd-feedback-submit",
-						disabled: status === "submitting" || status === "submitted",
+						disabled: status === "submitting" || status === "submitted" || commentRequired,
 						onClick: () => void handleSubmit(),
 						children: [
 							status === "submitting" && /* @__PURE__ */ jsx("span", {

package/dist/docs-layout.mjs

@@ -652,6 +652,7 @@ function createDocsLayout(config, options) {
 	const layoutDimensions = config.theme?.ui?.layout;
 	const pageActions = config.pageActions;
 	const copyMarkdownEnabled = resolveBool(pageActions?.copyMarkdown);
+	const copyMarkdownConfig = pageActions?.copyMarkdown && typeof pageActions.copyMarkdown === "object" ? pageActions.copyMarkdown : void 0;
 	const openDocsEnabled = resolveBool(pageActions?.openDocs);
 	const pageActionsPosition = pageActions?.position ?? "below-title";
 	const pageActionsAlignment = pageActions?.alignment ?? "left";
@@ -790,6 +791,8 @@ function createDocsLayout(config, options) {
 						publicPath: localeContext.publicPath,
 						locale: activeLocale,
 						copyMarkdown: copyMarkdownEnabled,
+						copyMarkdownLabel: copyMarkdownConfig?.label,
+						copyMarkdownCopiedLabel: copyMarkdownConfig?.copiedLabel,
 						openDocs: openDocsEnabled,
 						openDocsProviders,
 						openDocsTarget: openDocsConfig?.target,
@@ -812,6 +815,7 @@ function createDocsLayout(config, options) {
 						feedbackEnabled: feedbackConfig.enabled,
 						feedbackQuestion: feedbackConfig.question,
 						feedbackPlaceholder: feedbackConfig.placeholder,
+						feedbackRequireComment: feedbackConfig.requireComment,
 						feedbackPositiveLabel: feedbackConfig.positiveLabel,
 						feedbackNegativeLabel: feedbackConfig.negativeLabel,
 						feedbackSubmitLabel: feedbackConfig.submitLabel,
@@ -839,6 +843,7 @@ function resolveFeedbackConfig(feedback) {
 		enabled: false,
 		question: "How is this guide?",
 		placeholder: "Leave your feedback...",
+		requireComment: false,
 		positiveLabel: "Good",
 		negativeLabel: "Bad",
 		submitLabel: "Submit"
@@ -848,11 +853,12 @@ function resolveFeedbackConfig(feedback) {
 		...defaults,
 		enabled: true
 	};
-	const hasHumanFeedbackConfig = feedback.enabled !== void 0 || feedback.question !== void 0 || feedback.placeholder !== void 0 || feedback.positiveLabel !== void 0 || feedback.negativeLabel !== void 0 || feedback.submitLabel !== void 0 || feedback.onFeedback !== void 0;
+	const hasHumanFeedbackConfig = feedback.enabled !== void 0 || feedback.question !== void 0 || feedback.placeholder !== void 0 || feedback.requireComment !== void 0 || feedback.positiveLabel !== void 0 || feedback.negativeLabel !== void 0 || feedback.submitLabel !== void 0 || feedback.onFeedback !== void 0;
 	return {
 		enabled: feedback.enabled === true || feedback.enabled !== false && hasHumanFeedbackConfig,
 		question: feedback.question ?? defaults.question,
 		placeholder: feedback.placeholder ?? defaults.placeholder,
+		requireComment: feedback.requireComment ?? defaults.requireComment,
 		positiveLabel: feedback.positiveLabel ?? defaults.positiveLabel,
 		negativeLabel: feedback.negativeLabel ?? defaults.negativeLabel,
 		submitLabel: feedback.submitLabel ?? defaults.submitLabel

package/dist/docs-page-client.d.mts

@@ -23,6 +23,8 @@ interface DocsPageClientProps {
   /** Active locale (used for llms.txt links) */
   locale?: string;
   copyMarkdown?: boolean;
+  copyMarkdownLabel?: string;
+  copyMarkdownCopiedLabel?: string;
   openDocs?: boolean;
   openDocsProviders?: SerializedProvider[];
   openDocsTarget?: "markdown" | "page" | "source" | "github";
@@ -74,6 +76,7 @@ interface DocsPageClientProps {
   feedbackEnabled?: boolean;
   feedbackQuestion?: string;
   feedbackPlaceholder?: string;
+  feedbackRequireComment?: boolean;
   feedbackPositiveLabel?: string;
   feedbackNegativeLabel?: string;
   feedbackSubmitLabel?: string;
@@ -90,6 +93,8 @@ declare function DocsPageClient({
   publicPath,
   locale,
   copyMarkdown,
+  copyMarkdownLabel,
+  copyMarkdownCopiedLabel,
   openDocs,
   openDocsProviders,
   openDocsTarget,
@@ -117,6 +122,7 @@ declare function DocsPageClient({
   feedbackEnabled,
   feedbackQuestion,
   feedbackPlaceholder,
+  feedbackRequireComment,
   feedbackPositiveLabel,
   feedbackNegativeLabel,
   feedbackSubmitLabel,

package/dist/docs-page-client.mjs

@@ -255,7 +255,7 @@ function findThreadlineTocActionsContainer() {
 	}
 	return toc.parentElement ?? toc;
 }
-function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled = true, changelogBasePath, entry = "docs", publicPath, locale, copyMarkdown = false, openDocs = false, openDocsProviders, openDocsTarget, openDocsPrompt, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, contentDir, githubBranch = "main", githubDirectory, editOnGithubUrl, lastModifiedMap, lastModified: lastModifiedProp, readingTimeMap, readingTime: readingTimeProp, readingTimeFormat = "long", structuredDataMap, structuredData: structuredDataProp, readingTimeEnabled = false, lastUpdatedEnabled = true, lastUpdatedPosition = "footer", llmsTxtEnabled = false, descriptionMap, description, feedbackEnabled = false, feedbackQuestion, feedbackPlaceholder, feedbackPositiveLabel, feedbackNegativeLabel, feedbackSubmitLabel, feedbackOnFeedback, analytics = false, children }) {
+function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled = true, changelogBasePath, entry = "docs", publicPath, locale, copyMarkdown = false, copyMarkdownLabel, copyMarkdownCopiedLabel, openDocs = false, openDocsProviders, openDocsTarget, openDocsPrompt, pageActionsPosition = "below-title", pageActionsAlignment = "left", githubUrl, contentDir, githubBranch = "main", githubDirectory, editOnGithubUrl, lastModifiedMap, lastModified: lastModifiedProp, readingTimeMap, readingTime: readingTimeProp, readingTimeFormat = "long", structuredDataMap, structuredData: structuredDataProp, readingTimeEnabled = false, lastUpdatedEnabled = true, lastUpdatedPosition = "footer", llmsTxtEnabled = false, descriptionMap, description, feedbackEnabled = false, feedbackQuestion, feedbackPlaceholder, feedbackRequireComment, feedbackPositiveLabel, feedbackNegativeLabel, feedbackSubmitLabel, feedbackOnFeedback, analytics = false, children }) {
 	const fdTocStyle = tocStyle === "directional" ? "clerk" : void 0;
 	const [toc, setToc] = useState([]);
 	const [titlePortalHost, setTitlePortalHost] = useState(null);
@@ -465,6 +465,8 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 				"data-actions-alignment": pageActionsAlignment,
 				children: /* @__PURE__ */ jsx(PageActions, {
 					copyMarkdown,
+					copyMarkdownLabel,
+					copyMarkdownCopiedLabel,
 					openDocs,
 					providers: openDocsProviders,
 					openDocsTarget,
@@ -508,6 +510,8 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 		className: "fd-actions-toc-portal not-prose",
 		children: /* @__PURE__ */ jsx(PageActions, {
 			copyMarkdown,
+			copyMarkdownLabel,
+			copyMarkdownCopiedLabel,
 			openDocs,
 			providers: openDocsProviders,
 			openDocsTarget,
@@ -560,6 +564,8 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 						"data-actions-alignment": pageActionsAlignment,
 						children: /* @__PURE__ */ jsx(PageActions, {
 							copyMarkdown,
+							copyMarkdownLabel,
+							copyMarkdownCopiedLabel,
 							openDocs,
 							providers: openDocsProviders,
 							openDocsTarget,
@@ -589,6 +595,7 @@ function DocsPageClient({ tocEnabled, tocStyle = "default", breadcrumbEnabled =
 							locale: activeLocale,
 							question: feedbackQuestion,
 							placeholder: feedbackPlaceholder,
+							requireComment: feedbackRequireComment,
 							positiveLabel: feedbackPositiveLabel,
 							negativeLabel: feedbackNegativeLabel,
 							submitLabel: feedbackSubmitLabel,

package/dist/page-actions.d.mts

@@ -11,6 +11,8 @@ interface SerializedProvider {
 }
 interface PageActionsProps {
   copyMarkdown?: boolean;
+  copyMarkdownLabel?: string;
+  copyMarkdownCopiedLabel?: string;
   openDocs?: boolean;
   providers?: SerializedProvider[];
   openDocsTarget?: "markdown" | "page" | "source" | "github";
@@ -23,6 +25,8 @@ interface PageActionsProps {
 }
 declare function PageActions({
   copyMarkdown,
+  copyMarkdownLabel,
+  copyMarkdownCopiedLabel,
   openDocs,
   providers,
   openDocsTarget,

package/dist/page-actions.mjs

@@ -132,7 +132,7 @@ function pageUrlToMarkdownUrl(pageUrl) {
 function fillPromptTemplate(template, values) {
 	return template.replace(/\{pageUrl\}/g, values.pageUrl).replace(/\{markdownUrl\}/g, values.markdownUrl).replace(/\{sourceUrl\}/g, values.sourceUrl).replace(/\{mdxUrl\}/g, values.sourceUrl).replace(/\{githubUrl\}/g, values.githubUrl).replace(/\{url\}/g, values.url);
 }
-function PageActions({ copyMarkdown, openDocs, providers, openDocsTarget = DEFAULT_OPEN_DOCS_TARGET, openDocsPrompt = DEFAULT_OPEN_DOCS_PROMPT, alignment = "left", variant = "default", githubFileUrl, analytics = false }) {
+function PageActions({ copyMarkdown, copyMarkdownLabel = "Copy page", copyMarkdownCopiedLabel = "Copied!", openDocs, providers, openDocsTarget = DEFAULT_OPEN_DOCS_TARGET, openDocsPrompt = DEFAULT_OPEN_DOCS_PROMPT, alignment = "left", variant = "default", githubFileUrl, analytics = false }) {
 	const [copied, setCopied] = useState(false);
 	const [dropdownOpen, setDropdownOpen] = useState(false);
 	const dropdownRef = useRef(null);
@@ -238,7 +238,7 @@ function PageActions({ copyMarkdown, openDocs, providers, openDocsTarget = DEFAU
 				onClick: handleCopyMarkdown,
 				className: "fd-page-action-btn",
 				"data-copied": copied,
-				children: [copied ? /* @__PURE__ */ jsx(CheckIcon, {}) : /* @__PURE__ */ jsx(CopyIcon, {}), /* @__PURE__ */ jsx("span", { children: copied ? "Copied!" : "Copy page" })]
+				children: [copied ? /* @__PURE__ */ jsx(CheckIcon, {}) : /* @__PURE__ */ jsx(CopyIcon, {}), /* @__PURE__ */ jsx("span", { children: copied ? copyMarkdownCopiedLabel : copyMarkdownLabel })]
 			}),
 			openDocs && /* @__PURE__ */ jsxs("a", {
 				className: "fd-page-action-btn",
@@ -271,7 +271,7 @@ function PageActions({ copyMarkdown, openDocs, providers, openDocsTarget = DEFAU
 			onClick: handleCopyMarkdown,
 			className: "fd-page-action-btn",
 			"data-copied": copied,
-			children: [copied ? /* @__PURE__ */ jsx(CheckIcon, {}) : /* @__PURE__ */ jsx(CopyIcon, {}), /* @__PURE__ */ jsx("span", { children: copied ? "Copied!" : "Copy page" })]
+			children: [copied ? /* @__PURE__ */ jsx(CheckIcon, {}) : /* @__PURE__ */ jsx(CopyIcon, {}), /* @__PURE__ */ jsx("span", { children: copied ? copyMarkdownCopiedLabel : copyMarkdownLabel })]
 		}), openDocs && resolvedProviders.length > 0 && /* @__PURE__ */ jsxs("div", {
 			ref: dropdownRef,
 			className: "fd-page-action-dropdown",

package/dist/tanstack-layout.mjs

@@ -193,6 +193,7 @@ function resolveFeedbackConfig(feedback) {
 		enabled: false,
 		question: "How is this guide?",
 		placeholder: "Leave your feedback...",
+		requireComment: false,
 		positiveLabel: "Good",
 		negativeLabel: "Bad",
 		submitLabel: "Submit"
@@ -202,11 +203,12 @@ function resolveFeedbackConfig(feedback) {
 		...defaults,
 		enabled: true
 	};
-	const hasHumanFeedbackConfig = feedback.enabled !== void 0 || feedback.question !== void 0 || feedback.placeholder !== void 0 || feedback.positiveLabel !== void 0 || feedback.negativeLabel !== void 0 || feedback.submitLabel !== void 0 || feedback.onFeedback !== void 0;
+	const hasHumanFeedbackConfig = feedback.enabled !== void 0 || feedback.question !== void 0 || feedback.placeholder !== void 0 || feedback.requireComment !== void 0 || feedback.positiveLabel !== void 0 || feedback.negativeLabel !== void 0 || feedback.submitLabel !== void 0 || feedback.onFeedback !== void 0;
 	return {
 		enabled: feedback.enabled === true || feedback.enabled !== false && hasHumanFeedbackConfig,
 		question: feedback.question ?? defaults.question,
 		placeholder: feedback.placeholder ?? defaults.placeholder,
+		requireComment: feedback.requireComment ?? defaults.requireComment,
 		positiveLabel: feedback.positiveLabel ?? defaults.positiveLabel,
 		negativeLabel: feedback.negativeLabel ?? defaults.negativeLabel,
 		submitLabel: feedback.submitLabel ?? defaults.submitLabel
@@ -238,6 +240,7 @@ function TanstackDocsLayout({ config, tree, locale, description, readingTime, la
 	const layoutDimensions = config.theme?.ui?.layout;
 	const pageActions = config.pageActions;
 	const copyMarkdownEnabled = resolveBool(pageActions?.copyMarkdown);
+	const copyMarkdownConfig = pageActions?.copyMarkdown && typeof pageActions.copyMarkdown === "object" ? pageActions.copyMarkdown : void 0;
 	const openDocsEnabled = resolveBool(pageActions?.openDocs);
 	const pageActionsPosition = pageActions?.position ?? "below-title";
 	const pageActionsAlignment = pageActions?.alignment ?? "left";
@@ -354,6 +357,8 @@ function TanstackDocsLayout({ config, tree, locale, description, readingTime, la
 					entry: config.entry ?? "docs",
 					locale,
 					copyMarkdown: copyMarkdownEnabled,
+					copyMarkdownLabel: copyMarkdownConfig?.label,
+					copyMarkdownCopiedLabel: copyMarkdownConfig?.copiedLabel,
 					openDocs: openDocsEnabled,
 					openDocsProviders,
 					openDocsTarget: openDocsConfig?.target,
@@ -372,6 +377,7 @@ function TanstackDocsLayout({ config, tree, locale, description, readingTime, la
 					feedbackEnabled: feedbackConfig.enabled,
 					feedbackQuestion: feedbackConfig.question,
 					feedbackPlaceholder: feedbackConfig.placeholder,
+					feedbackRequireComment: feedbackConfig.requireComment,
 					feedbackPositiveLabel: feedbackConfig.positiveLabel,
 					feedbackNegativeLabel: feedbackConfig.negativeLabel,
 					feedbackSubmitLabel: feedbackConfig.submitLabel,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/theme",
-  "version": "0.2.15",
+  "version": "0.2.16",
   "description": "Theme package for @farming-labs/docs — layout, provider, MDX components, and styles",
   "keywords": [
     "docs",
@@ -145,7 +145,7 @@
     "tsdown": "^0.20.3",
     "typescript": "^5.9.3",
     "vitest": "^4.1.8",
-    "@farming-labs/docs": "0.2.15"
+    "@farming-labs/docs": "0.2.16"
   },
   "peerDependencies": {
     "@farming-labs/docs": ">=0.0.1",