varvara-typedoc-theme 0.1.2 → 0.1.3

package/README.md

@@ -1,15 +1,16 @@
 # Varvara TypeDoc Theme
 
-Varvara TypeDoc Theme is a [custom theme](https://typedoc.org/documents/Development.Custom_Themes.html) for TypeDoc, designed to provide an seamless documentation experience for TypeScript projects.
+_View a_ [_live example here_](https://marcmarine.github.io/western-signs).
 
-[![license](https://img.shields.io/github/license/marcmarine/varvara-js)](https://github.com/marcmarine/varvara-js/blob/main/LICENSE)
+Varvara TypeDoc Theme is a custom theme for TypeDoc, designed to provide a seamless documentation experience for TypeScript projects.
 
-## Prerequisites
-
-Ensure TypeDoc is [installed](https://typedoc.org/index.html#quick-start) in your project.
+![NPM Version](https://img.shields.io/npm/v/varvara-typedoc-theme)
+[![GitHub License](https://img.shields.io/github/license/marcmarine/varvara-js)](https://github.com/marcmarine/varvara-js/blob/main/LICENSE)
 
 ## Installation
 
+Ensure TypeDoc is [installed](https://typedoc.org/index.html#quick-start) in your project.
+
 Install the Varvara TypeDoc theme as a development dependency:
 
 ```bash

package/dist/index.js

@@ -89,21 +89,28 @@ function sidebar(context) {
   };
 }
 
-// src/partials/pageSidebar.tsx
+// src/partials/navigation.tsx
 import {
   JSX as JSX3,
   ReflectionFlag
 } from "typedoc";
 function pageSidebar(context) {
   return (props) => {
+    return /* @__PURE__ */ JSX3.createElement("div", {
+      class: "va-button-group"
+    }, context.settings(), context.pageNavigation(props));
+  };
+}
+var flagOptionNameToReflectionFlag = {
+  protected: ReflectionFlag.Protected,
+  private: ReflectionFlag.Private,
+  external: ReflectionFlag.External,
+  inherited: ReflectionFlag.Inherited
+};
+function settings(context) {
+  return () => {
     const defaultFilters = context.options.getValue("visibilityFilters");
     const visibilityOptions = [];
-    const flagOptionNameToReflectionFlag = {
-      protected: ReflectionFlag.Protected,
-      private: ReflectionFlag.Private,
-      external: ReflectionFlag.External,
-      inherited: ReflectionFlag.Inherited
-    };
     for (const key of Object.keys(defaultFilters)) {
       if (key.startsWith("@")) {
         const filterName = key.substring(1).replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
@@ -112,25 +119,7 @@ function pageSidebar(context) {
         visibilityOptions.push(buildFilterItem(context, key, context.internationalization.flagString(flagOptionNameToReflectionFlag[key]), defaultFilters[key]));
       }
     }
-    if (!props.pageSections.some((sect) => sect.headings.length)) {
-      return /* @__PURE__ */ JSX3.createElement(JSX3.Fragment, null);
-    }
-    const sections = [];
-    for (const section of props.pageSections) {
-      if (section.title) {
-        sections.push(/* @__PURE__ */ JSX3.createElement("details", {
-          open: true,
-          class: "va-collapse tsd-accordion"
-        }, /* @__PURE__ */ JSX3.createElement("summary", {
-          "data-key": `section-${section.title}`
-        }, section.title), buildSectionNavigation(context, section.headings)));
-      } else {
-        sections.push(buildSectionNavigation(context, section.headings));
-      }
-    }
-    return /* @__PURE__ */ JSX3.createElement("div", {
-      class: "va-button-group"
-    }, /* @__PURE__ */ JSX3.createElement("details", {
+    return /* @__PURE__ */ JSX3.createElement("details", {
       class: "va-collapse settings tsd-accordion",
       open: false
     }, /* @__PURE__ */ JSX3.createElement("summary", null, context.i18n.theme_settings()), visibilityOptions.length && /* @__PURE__ */ JSX3.createElement("div", {
@@ -150,10 +139,7 @@ function pageSidebar(context) {
       value: "light"
     }, context.i18n.theme_light()), /* @__PURE__ */ JSX3.createElement("option", {
       value: "dark"
-    }, context.i18n.theme_dark())))), /* @__PURE__ */ JSX3.createElement("details", {
-      open: false,
-      class: "va-collapse page-navigation tsd-accordion"
-    }, /* @__PURE__ */ JSX3.createElement("summary", null, context.i18n.theme_on_this_page()), sections));
+    }, context.i18n.theme_dark()))));
   };
 }
 function buildSectionNavigation(context, headings) {
@@ -201,6 +187,30 @@ function buildFilterItem(context, name, displayName, defaultValue) {
     checked: defaultValue
   }), context.icons.checkbox(), /* @__PURE__ */ JSX3.createElement("span", null, displayName)));
 }
+function pageNavigation(context) {
+  return (props) => {
+    if (!props.pageSections.some((sect) => sect.headings.length)) {
+      return /* @__PURE__ */ JSX3.createElement(JSX3.Fragment, null);
+    }
+    const sections = [];
+    for (const section of props.pageSections) {
+      if (section.title) {
+        sections.push(/* @__PURE__ */ JSX3.createElement("details", {
+          open: true,
+          class: "va-collapse tsd-accordion"
+        }, /* @__PURE__ */ JSX3.createElement("summary", {
+          "data-key": `section-${section.title}`
+        }, section.title), buildSectionNavigation(context, section.headings)));
+      } else {
+        sections.push(buildSectionNavigation(context, section.headings));
+      }
+    }
+    return /* @__PURE__ */ JSX3.createElement("details", {
+      open: false,
+      class: "va-collapse page-navigation tsd-accordion"
+    }, /* @__PURE__ */ JSX3.createElement("summary", null, context.i18n.theme_on_this_page()), sections);
+  };
+}
 
 // src/partials/toolbar.tsx
 import {
@@ -428,6 +438,8 @@ class VarvaraThemeContext extends DefaultThemeRenderContext3 {
     this.toolbar = toolbar(this);
     this.defaultLayout = layout(this);
     this.sidebar = sidebar(this);
+    this.settings = settings(this);
+    this.pageNavigation = pageNavigation(this);
   }
   footer = () => footer(this);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "varvara-typedoc-theme",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "author": "Marc Mariné <shenobi@gmail.com>",
   "repository": {
     "type": "git",