@lexibase/rdx-types 2.4.0 → 2.6.0

package/dist/config.d.ts

@@ -115,6 +115,20 @@ export type RDXConfig = {
   }
 }
 
+/** Values available to a project-owned homepage. */
+export type RdxHomepageProps = {
+  /** Active language tag, such as 'en' or 'pt-BR'. */
+  lang: string
+  /** Documentation entry point for the active language. */
+  docsHref: string
+}
+
+/** Props for the server homepage enabled by homepage.translations. */
+export type RdxTranslatedHomepageProps = RdxHomepageProps & {
+  /** Translate a source phrase, falling back to the phrase itself. */
+  t: (text: string) => string
+}
+
 /** Options for the built-in landing page or a project-owned home.tsx component. */
 export type RdxHomepage = {
   /**
@@ -124,17 +138,19 @@ export type RdxHomepage = {
   enabled?: boolean
   /**
    * Imported React component that owns the homepage body.
-   * The shared navbar remains; built-in title, description and buttons are not
-   * injected into this component. Used only when enabled is true.
+   * The shared navbar remains. Use the lang and docsHref props to localize the
+   * homepage content and navigation. Used only when enabled is true.
    * @example
    * component: Home // import Home from './home'
    */
-  component?: ComponentType
+  component?: ComponentType<RdxHomepageProps>
+  /** Load components/home.tsx on the server and translate its text from locale folders. */
+  translations?: boolean
   /** Built-in homepage heading. Defaults to metadata.applicationName. */
   title?: string
-  /** Optional text below the built-in heading; omitted means no description. */
+  /** Text below the built-in heading. Defaults to the site description. */
   description?: string
-  /** Buttons below the built-in description. The first button is primary. */
+  /** Hero buttons. The first is primary. Defaults to a Docs link; use [] to hide it. */
   buttons?: {
     /** Visible button text and accessible name; must not be empty. */
     label: string

package/dist/index.d.ts

@@ -3,6 +3,8 @@ export { RdxSearchEntry, RdxSearchIndex } from './search'
 export {
   RDXConfig,
   RdxHomepage,
+  RdxHomepageProps,
+  RdxTranslatedHomepageProps,
   RdxMetadata,
   RdxRuntimeConfig,
   ResolvedRdxConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/rdx-types",
-  "version": "2.4.0",
+  "version": "2.6.0",
   "license": "MIT",
   "description": "Shared TypeScript types for RDX documentation projects.",
   "types": "./dist/index.d.ts",