@webx-ui/module-banners 0.1.12 → 0.2.0

package/dist/LayerInspector.d.ts

@@ -0,0 +1,30 @@
+import { BannerLayer, LayerFrame, LayerView } from './layers';
+type __VLS_Props = {
+    layer: BannerLayer;
+    view: LayerView;
+    tags: {
+        value: string;
+        label: string;
+    }[];
+    variants: {
+        value: string;
+        label: string;
+    }[];
+    palette: {
+        key: string;
+        value: string;
+    }[];
+    disabled?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    delete: () => any;
+    "same-as-desktop": () => any;
+    update: (layer: BannerLayer) => any;
+    frame: (patch: Partial<LayerFrame>) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onDelete?: (() => any) | undefined;
+    "onSame-as-desktop"?: (() => any) | undefined;
+    onUpdate?: ((layer: BannerLayer) => any) | undefined;
+    onFrame?: ((patch: Partial<LayerFrame>) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/LayersField.d.ts

@@ -0,0 +1,14 @@
+import { BannerLayer } from './layers';
+type __VLS_Props = {
+    modelValue?: BannerLayer[] | null;
+    disabled?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: BannerLayer[]) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:modelValue"?: ((value: BannerLayer[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    canvas: HTMLDivElement;
+    stage: HTMLDivElement;
+}, HTMLDivElement>;
+export default _default;

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { AdminContext } from '@webx-ui/module-admin';
 import { ScreenModel } from '@webx-ui/schema';
-import { BannerDetail, BannerRow, PlaceInput, PlaceRow } from './types';
+import { BannerDetail, BannerRow, BannersTheme, PlaceInput, PlaceRow } from './types';
 export interface BannersApi {
     /** Every place: the declared ones in the config's order, then the own ones by name. */
     places(): Promise<PlaceRow[]>;
@@ -26,6 +26,8 @@ export interface BannersApi {
     restore(id: number): Promise<BannerRow>;
     /** The order of one place, written whole. */
     reorder(place: string, ids: number[]): Promise<void>;
+    /** The site's theme as the layer editor shows it; empty on a site without one. */
+    theme(): Promise<BannersTheme>;
 }
 /** Everything under `/banners`, below the panel's API path (§5.6). */
 export declare function createBannersApi(admin: AdminContext): BannersApi;

package/dist/editor.d.ts

@@ -0,0 +1,14 @@
+import { ComputedRef, Ref } from 'vue';
+import { ScreenModel } from '@webx-ui/schema';
+import { PlaceRow } from './types';
+/**
+ * What the banner's page tells the fields of its screen that need more than their own value: the
+ * layer editor draws the banner's picture, puts in its title and text, and lays out its buttons,
+ * in the frame of the place the banner stands in.
+ */
+export interface BannerEditorContext {
+    values: Ref<ScreenModel>;
+    place: ComputedRef<PlaceRow | null>;
+}
+export declare function provideBannerEditor(context: BannerEditorContext): void;
+export declare function useBannerEditor(): BannerEditorContext | null;

package/dist/index.d.ts

@@ -3,4 +3,6 @@ export { createBannersApi, type BannersApi } from './api';
 export { bannersMessages } from './messages';
 export { default as WxBannersPage } from './BannersPage';
 export { default as WxBannerEditorPage } from './BannerEditorPage';
-export type { BannerButton, BannerDetail, BannerRow, BannerSummary, PlaceInput, PlaceRow, } from './types';
+export { default as WxBannerLayers } from './LayersField';
+export * from './layers';
+export type { BannerButton, BannerDetail, BannerRow, BannerSummary, PlaceInput, PlaceLayers, PlaceRow, BannersTheme, } from './types';