@bndynet/vue-site 1.4.1 → 1.8.0

package/dist/composables/useMobileViewport.d.ts

@@ -0,0 +1,36 @@
+import { Ref } from 'vue';
+/**
+ * Breakpoint in CSS pixels below which the site switches to the mobile layout.
+ *
+ * CSS `@media (max-width: ...)` rules cannot read this value (media queries do not
+ * support `var()`), so any change here must also update the matching media queries in
+ * `src/styles/layout.css`, `src/styles/markdown.css`, `src/components/SideNav.vue`,
+ * and `src/components/ShellActions.vue`. Those files carry a `keep in sync` comment.
+ */
+export declare const MOBILE_BREAKPOINT_PX = 840;
+/** Provide the active viewport state to components rendered by the site layout. */
+export declare function provideMobileViewport(isMobileViewport: Ref<boolean>): void;
+/**
+ * Return the site's reactive mobile viewport state.
+ *
+ * The value is `true` when the viewport is {@link MOBILE_BREAKPOINT_PX} CSS pixels wide or
+ * narrower. It is shared with the responsive site layout and updates when the viewport crosses
+ * that breakpoint.
+ *
+ * This composable must be called from a Vue component rendered inside `createSiteApp()`.
+ * The returned ref is read-only; use CSS media queries for presentation-only changes.
+ *
+ * @example
+ * ```vue
+ * <script setup lang="ts">
+ * import { useMobileViewport } from '@bndynet/vue-site'
+ *
+ * const isMobileViewport = useMobileViewport()
+ * </script>
+ *
+ * <template>
+ *   <button v-if="isMobileViewport">Open compact menu</button>
+ * </template>
+ * ```
+ */
+export declare function useMobileViewport(): Readonly<Ref<boolean>>;

package/dist/composables/useSiteConfig.d.ts

@@ -10,5 +10,12 @@ export interface SiteContext {
 }
 /** Use `Symbol.for` so pages still inject context if Vite resolves the package twice. */
 export declare const siteContextKey: InjectionKey<SiteContext>;
+/** Register the configuration for access outside Vue's injection context. */
+export declare function registerSiteConfig(config: SiteConfig): void;
 export declare function provideSiteConfig(context: SiteContext): void;
+/**
+ * Return the active site configuration outside Vue's setup / injection context.
+ * `createSiteApp()` must have started before this function is called.
+ */
+export declare function getSiteConfig(): SiteConfig;
 export declare function useSiteConfig(): SiteContext;

package/dist/create-app.d.ts

@@ -1,11 +1,2 @@
 import { SiteConfig } from './types';
-/**
- * Returns the site config passed to `createSiteApp()`. Can be called from anywhere — plain
- * modules, `bootstrap.ts` (after the app is created), utility functions, etc. — without a Vue
- * injection context. Returns `undefined` if `createSiteApp` has not been called yet.
- *
- * For reactive, component-scoped access to the full `SiteContext` (config + nav + refreshAuthNav),
- * use {@link useSiteConfig} inside a Vue component instead.
- */
-export declare function getSiteConfig(): SiteConfig | undefined;
 export declare function createSiteApp(config: SiteConfig): Promise<import('vue').App<Element>>;

package/dist/index.d.ts

@@ -1,12 +1,13 @@
 import { SiteConfig } from './types';
-export { createSiteApp, getSiteConfig } from './create-app';
+export { createSiteApp } from './create-app';
 export { useTheme, themeRefKey } from './composables/useTheme';
 export { useLocale, localeRefKey } from './composables/useLocale';
 export { useLocalize } from './composables/useLocalize';
+export { useMobileViewport } from './composables/useMobileViewport';
 export { resolveLocalized, resolveField, resolveMessage, mergeCatalog, flattenMessages, tk, isMessageRef, localizedPage } from './i18n-utils';
 export type { LocalizedPageOptions, MessageCatalog } from './i18n-utils';
 export { builtinMessages } from './i18n-messages';
-export { useSiteConfig } from './composables/useSiteConfig';
+export { getSiteConfig, useSiteConfig } from './composables/useSiteConfig';
 export { builtinThemePalettes } from './theme/presets';
 export { ElMessage, ElMessageBox, ElNotification, } from 'element-plus';
 export type { SiteConfig, SiteEnvConfig, SiteViteConfig, SiteCustomConfig, SiteExternalLink, ShellConfig, ShellAction, ShellActionLoader, NavItem, StandalonePage, PageLayout, AuthRule, AuthContext, AuthConfig, RouterConfig, ThemeConfig, ThemeOption, ThemePaletteVars, ResolvedNavItem, LocaleCode, LocalizedString, IconRegistry, MessageRef, MessageTree, LocaleOption, I18nConfig, PageLoader, } from './types';