@wervt/nuxt 0.2.15 → 0.3.0

package/dist/runtime/email/components.d.ts

@@ -1,4 +1,4 @@
-import { InjectionKey } from "vue";
+import { InjectionKey, PropType } from "vue";
 //#region src/runtime/email/components.d.ts
 /** The template's subject, handed to renderEmail() while rendering. */
 export declare const SUBJECT_KEY: InjectionKey<(subject: string) => void>;
@@ -6,19 +6,31 @@ export declare const emailTheme: {
   page: string;
   card: string;
   border: string;
+  rule: string;
   text: string;
   highlighted: string;
   muted: string;
   dimmed: string;
+  accent: string;
+  accentSoft: string;
+  accentBorder: string;
+  band: string;
+  bandText: string;
+  bandDimmed: string;
   button: string;
   buttonText: string;
   codeBackground: string;
   radius: string;
   font: string;
   mono: string;
+  /** Where the logo images live. PNG, because Gmail and Outlook don't show SVG. */
+  assets: string;
+  site: string;
+  docs: string;
 };
 /**
- * The whole email: document, preheader, card and footer. Put it at the root of every template.
+ * The whole email: document, preheader, header with the logo, body and footer. Put it at the
+ * root of every template.
  *
  * ```vue
  * <WervtEmail subject="Your code" app="kontor"> … </WervtEmail>
@@ -30,7 +42,7 @@ export declare const WervtEmail: import("vue").DefineComponent<import("vue").Ext
     type: StringConstructor;
     required: true;
   };
-  /** Shown above the card and in the footer, e.g. the app's name. */
+  /** The app that sends the mail, shown in the header and the footer. */
   app: {
     type: StringConstructor;
     default: string;
@@ -40,11 +52,16 @@ export declare const WervtEmail: import("vue").DefineComponent<import("vue").Ext
     type: StringConstructor;
     default: string;
   };
-  /** Replaces the footer line ("Sent by <app> on wervt."). */
+  /** Replaces the footer's "Sent by <app> via wervt" line. */
   footer: {
     type: StringConstructor;
     default: string;
   };
+  /** Why the recipient got this mail, shown small in the footer. */
+  reason: {
+    type: StringConstructor;
+    default: string;
+  };
 }>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
   [key: string]: any;
 }>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -53,7 +70,7 @@ export declare const WervtEmail: import("vue").DefineComponent<import("vue").Ext
     type: StringConstructor;
     required: true;
   };
-  /** Shown above the card and in the footer, e.g. the app's name. */
+  /** The app that sends the mail, shown in the header and the footer. */
   app: {
     type: StringConstructor;
     default: string;
@@ -63,19 +80,39 @@ export declare const WervtEmail: import("vue").DefineComponent<import("vue").Ext
     type: StringConstructor;
     default: string;
   };
-  /** Replaces the footer line ("Sent by <app> on wervt."). */
+  /** Replaces the footer's "Sent by <app> via wervt" line. */
   footer: {
     type: StringConstructor;
     default: string;
   };
+  /** Why the recipient got this mail, shown small in the footer. */
+  reason: {
+    type: StringConstructor;
+    default: string;
+  };
 }>> & Readonly<{}>, {
   app: string;
   preview: string;
   footer: string;
+  reason: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
-export declare const EmailHeading: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+export declare const EmailHeading: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+  /** A short label above the heading, in the landing page's mono eyebrow style. */
+  eyebrow: {
+    type: StringConstructor;
+    default: string;
+  };
+}>, () => (import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
   [key: string]: any;
-}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+}> | null)[], {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+  /** A short label above the heading, in the landing page's mono eyebrow style. */
+  eyebrow: {
+    type: StringConstructor;
+    default: string;
+  };
+}>> & Readonly<{}>, {
+  eyebrow: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export declare const EmailText: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
   [key: string]: any;
 }>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
@@ -102,6 +139,11 @@ export declare const EmailButton: import("vue").DefineComponent<import("vue").Ex
     type: StringConstructor;
     required: true;
   };
+  /** `primary` is the landing page's blue; `neutral` the dashboard's black. */
+  color: {
+    type: PropType<'primary' | 'neutral'>;
+    default: string;
+  };
 }>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
   [key: string]: any;
 }>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -109,13 +151,25 @@ export declare const EmailButton: import("vue").DefineComponent<import("vue").Ex
     type: StringConstructor;
     required: true;
   };
-}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+  /** `primary` is the landing page's blue; `neutral` the dashboard's black. */
+  color: {
+    type: PropType<'primary' | 'neutral'>;
+    default: string;
+  };
+}>> & Readonly<{}>, {
+  color: "neutral" | "primary";
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 /** A one-time code, large and spaced so it reads (and copies) easily. */
 export declare const EmailCode: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
   code: {
     type: StringConstructor;
     required: true;
   };
+  /** A small line under the code, e.g. when it expires. */
+  caption: {
+    type: StringConstructor;
+    default: string;
+  };
 }>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
   [key: string]: any;
 }>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
@@ -123,7 +177,14 @@ export declare const EmailCode: import("vue").DefineComponent<import("vue").Extr
     type: StringConstructor;
     required: true;
   };
-}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+  /** A small line under the code, e.g. when it expires. */
+  caption: {
+    type: StringConstructor;
+    default: string;
+  };
+}>> & Readonly<{}>, {
+  caption: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export declare const EmailDivider: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
   [key: string]: any;
 }>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;