@webx-ui/module-admin 0.28.0 → 0.29.0

package/README.md

@@ -35,6 +35,10 @@ createAdmin({
 reads the manifest address out of the `webx-manifest` meta tag beside it. Both are overridable
 for a panel served some other way.
 
+The name in the head of the sidebar, an arrow on the rail and an entry of the account menu lead
+to the site, in a new tab: to the home page in its main language the server names, to the
+address in `siteLink` when the project gives one, and nowhere at all with `siteLink: false`.
+
 Mounting does not wait for the server. The manifest needs a signed-in session, so a visit that
 starts at the sign-in screen would otherwise stare at a blank page waiting for a request it is
 bound to lose.

package/dist/RenameButton.d.ts

@@ -106,10 +106,10 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
             status: import('@webx-ui/core').InputStatus;
             id: string;
             readonly: boolean;
+            localized: boolean;
             autocomplete: string;
             maxlength: number;
             showCount: boolean;
-            localized: boolean;
             tokens: import('@webx-ui/core').TokenOption[];
             tokensTitle: string;
             tokensLabel: string;
@@ -143,10 +143,10 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
         status: import('@webx-ui/core').InputStatus;
         id: string;
         readonly: boolean;
+        localized: boolean;
         autocomplete: string;
         maxlength: number;
         showCount: boolean;
-        localized: boolean;
         tokens: import('@webx-ui/core').TokenOption[];
         tokensTitle: string;
         tokensLabel: string;

package/dist/SiteLink.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The name of the site in the panel's head, made into the way to the site: the name itself is
+ * the link, and the small arrow after it says the link leaves the panel.
+ *
+ * A new tab, because the panel is where the work is — somebody who glances at the site wants
+ * to come back to the screen they left, not to a sign-in and a menu.
+ *
+ * The arrow sits right after the name rather than at the far end of the row: the name is cut
+ * short with an ellipsis before the arrow is, so a long one never pushes it out.
+ */
+type __VLS_Props = {
+    href: string;
+    /** What the link is called aloud: the site's name, then what following it does. */
+    label: string;
+    /** The words of the tooltip. */
+    hint: string;
+};
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLAnchorElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLAnchorElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/admin.d.ts

@@ -40,6 +40,13 @@ export interface AdminContext {
      * fetched once for the session. Optional on the context so a hand-made one in a test needs none.
      */
     readonly blockLabels?: () => Promise<BlockLabels | null>;
+    /**
+     * The site this panel runs, as the way out of the panel: its home page in the site's main
+     * language. `null` when the project hid the link with `createAdmin({ siteLink: false })`, or
+     * when the server is too old to say. The header, the rail and the account menu all read it
+     * here, so an address given once moves all three.
+     */
+    readonly siteUrl: ComputedRef<string | null>;
     /** Ask the server what the panel is and who is signed in again. */
     reload(): Promise<void>;
     /**
@@ -96,6 +103,8 @@ export declare function createAdminContext(options: {
     loadDictionary?: (locale: string) => Promise<void>;
     types?: TypeRegistry;
     screens?: Record<string, Patch>;
+    /** The project's say over the way to the site: an address of its own, or `false` for none. */
+    siteLink?: string | false;
     /** Told who is signed in, so the theme they chose follows them to this machine. */
     theme?: ThemeController;
 }): AdminContext;

package/dist/createAdmin.d.ts

@@ -29,6 +29,12 @@ export interface CreateAdminOptions {
      * arrives; given here for the first paint, before it has.
      */
     basePath?: string;
+    /**
+     * The way from the panel to the site: the name in the sidebar's head, the arrow beside it and
+     * an entry of the account menu. By default the home page the server names, in the site's main
+     * language; an address here goes there instead, and `false` leaves the link out everywhere.
+     */
+    siteLink?: string | false;
     /** Replaces the panel's name in the header — a logo, usually. */
     brand?: Component;
     /** The corner of the header: who is signed in, and the way out. */