@zcomponent/core 1.9.1 → 1.11.0-beta

package/lib/behaviors/ActivateState.d.ts

@@ -38,8 +38,9 @@ export declare class ActivateState extends ActionBehavior {
      */
     easing?: string;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
 }
 export declare enum Pin {

package/lib/behaviors/ActivateState.js

@@ -10,6 +10,7 @@ export class ActivateState extends ActionBehavior {
         super(contextManager, instance, props);
         this.zcomponent = this.getZComponentInstance();
     }
+    /** @zprop */
     perform() {
         if (!this.state)
             return;
@@ -25,7 +26,7 @@ export class ActivateState extends ActionBehavior {
         };
         layerclip.play(opts);
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/CallFunction.d.ts

@@ -0,0 +1,19 @@
+import { ActionBehavior } from "../actionbehavior";
+/**
+ * Calls an exposed function on a context
+ *
+ * @zbehavior
+ * @zicon function
+ * @zgroup Actions
+ */
+export declare class CallFunction extends ActionBehavior {
+    /**
+     * The function and arguments to call
+     * @zprop
+     */
+    function: () => any;
+    /** @zui
+     * @zprop
+     */
+    perform(): void;
+}

package/lib/behaviors/CallFunction.js

@@ -0,0 +1,18 @@
+import { ActionBehavior } from "../actionbehavior";
+import { registerBehaviorRunAtDesignTime } from "../behavior";
+/**
+ * Calls an exposed function on a context
+ *
+ * @zbehavior
+ * @zicon function
+ * @zgroup Actions
+ */
+export class CallFunction extends ActionBehavior {
+    /** @zui
+     * @zprop
+     */
+    perform() {
+        this.function();
+    }
+}
+registerBehaviorRunAtDesignTime(CallFunction);

package/lib/behaviors/ConsoleLog.d.ts

@@ -18,5 +18,6 @@ export declare class ConsoleLog extends ActionBehavior {
      * @zdefault true
      */
     includeEventName: boolean;
+    /** @zprop */
     perform(): void;
 }

package/lib/behaviors/ConsoleLog.js

@@ -8,6 +8,7 @@ import { registerBehaviorRunAtDesignTime } from "../behavior";
  * @zgroup Actions
  */
 export class ConsoleLog extends ActionBehavior {
+    /** @zprop */
     perform() {
         if (this.includeEventName ?? true)
             console.log(this.constructorProps.event, this.text);

package/lib/behaviors/DownloadSnapshot.d.ts

@@ -14,8 +14,9 @@ export declare class DownloadSnapshot extends ActionBehavior<DownloadSnapshotPro
     /** @zui */
     onSave: Event<[]>;
     constructor(contextManager: ContextManager, instance: Component, props: DownloadSnapshotProps);
+    /** @zprop */
     perform(): void;
     private download;
-    /** @zprop */
+    /** @zui */
     preview(): void;
 }

package/lib/behaviors/DownloadSnapshot.js

@@ -31,10 +31,11 @@ export class DownloadSnapshot extends ActionBehavior {
             this.onSave.emit();
         };
     }
+    /** @zprop */
     perform() {
         this.download();
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/LaunchURL.d.ts

@@ -20,5 +20,6 @@ export declare class LaunchURL extends ActionBehavior {
      * @zdefault true
      */
     openInNew: boolean;
+    /** @zprop */
     perform(): void;
 }

package/lib/behaviors/LaunchURL.js

@@ -9,6 +9,7 @@ import { ActionBehavior } from "../actionbehavior";
  * @zgroup Actions
  */
 export class LaunchURL extends ActionBehavior {
+    /** @zprop */
     perform() {
         if (this.openInNew ?? true)
             window.open(this.url, '_blank', 'noopener noreferrer');

package/lib/behaviors/LogAnalyticsEvent.d.ts

@@ -13,5 +13,6 @@ export declare class LogAnalyticsEvent extends ActionBehavior {
     name: string;
     /** @zprop */
     params: any;
+    /** @zprop */
     perform(): void;
 }

package/lib/behaviors/LogAnalyticsEvent.js

@@ -10,6 +10,7 @@ import { logEvent } from "../contexts/analyticscontext";
  * @zgroup Actions
  */
 export class LogAnalyticsEvent extends ActionBehavior {
+    /** @zprop */
     perform() {
         logEvent(this.contextManager, this.name, this.params);
     }

package/lib/behaviors/PauseLayerClip.d.ts

@@ -14,7 +14,8 @@ export declare class PauseLayerClip extends ActionBehavior {
      */
     layerClip: string | undefined;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
 }

package/lib/behaviors/PauseLayerClip.js

@@ -10,6 +10,7 @@ export class PauseLayerClip extends ActionBehavior {
         super(contextManager, instance, props);
         this.zcomponent = this.getZComponentInstance();
     }
+    /** @zprop */
     perform() {
         if (!this.layerClip)
             return;
@@ -18,7 +19,7 @@ export class PauseLayerClip extends ActionBehavior {
             return;
         layerclip.pause();
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/PlayLayerClip.d.ts

@@ -68,8 +68,9 @@ export declare class PlayLayerClip extends ActionBehavior {
      */
     easing?: string;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
 }
 export declare enum Pin {

package/lib/behaviors/PlayLayerClip.js

@@ -26,6 +26,7 @@ export class PlayLayerClip extends ActionBehavior {
          */
         this.fromStart = false;
     }
+    /** @zprop */
     perform() {
         if (!this.layerClip)
             return;
@@ -48,7 +49,7 @@ export class PlayLayerClip extends ActionBehavior {
         else
             layerclip.play(opts);
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/PlaySound.d.ts

@@ -44,8 +44,9 @@ export declare class PlaySound extends ActionBehavior<PlaySoundProps> {
     speed: Observable<number, never>;
     private _component;
     constructor(contextManager: ContextManager, instance: Component, props: PlaySoundProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
     dispose(): never;
 }

package/lib/behaviors/PlaySound.js

@@ -23,11 +23,12 @@ export class PlaySound extends ActionBehavior {
         this.muted = this._component.muted;
         this.volume = this._component.volume;
     }
+    /** @zprop */
     perform() {
         this._component.seek(0);
         this._component.play({ speed: this.speed.value });
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/SetLayerOff.d.ts

@@ -14,7 +14,8 @@ export declare class SetLayerOff extends ActionBehavior {
      */
     layer: string | undefined;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
 }

package/lib/behaviors/SetLayerOff.js

@@ -10,6 +10,7 @@ export class SetLayerOff extends ActionBehavior {
         super(contextManager, instance, props);
         this.zcomponent = this.getZComponentInstance();
     }
+    /** @zprop */
     perform() {
         if (!this.layer)
             return;
@@ -18,7 +19,7 @@ export class SetLayerOff extends ActionBehavior {
             return;
         layer.active = null;
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/ShareSnapshot.d.ts

@@ -14,8 +14,9 @@ export declare class ShareSnapshot extends ActionBehavior<ShareCanvasProps> {
     /** @zui */
     onShare: Event<[]>;
     constructor(contextManager: ContextManager, instance: Component, props: ShareCanvasProps);
+    /** @zprop */
     perform(): void;
     private share;
-    /** @zprop */
+    /** @zui */
     preview(): void;
 }

package/lib/behaviors/ShareSnapshot.js

@@ -33,10 +33,11 @@ export class ShareSnapshot extends ActionBehavior {
             }
         };
     }
+    /** @zprop */
     perform() {
         this.share();
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/ShowTextAlert.d.ts

@@ -56,8 +56,10 @@ export declare class ShowTextAlert extends ActionBehavior {
     classNames: Observable<string[], never>;
     /**
      * How long the alert will apear on the screen
+     *
+     * @zprop
      */
     perform(): void;
-    /** @zprop */
+    /** @zui */
     preview(): void;
 }

package/lib/behaviors/ShowTextAlert.js

@@ -61,6 +61,8 @@ export class ShowTextAlert extends ActionBehavior {
     }
     /**
      * How long the alert will apear on the screen
+     *
+     * @zprop
      */
     perform() {
         showTextAlert(this.contextManager, this.text.value, {
@@ -70,7 +72,7 @@ export class ShowTextAlert extends ActionBehavior {
             timeout: this.timeout.value
         });
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/TakeSnapshot.d.ts

@@ -47,6 +47,7 @@ export declare class TakeSnapshot extends ActionBehavior<ActionBehaviorConstruct
      */
     title: Observable<string, never>;
     private dataUrl;
+    /** @zprop */
     perform(): void;
     private capture;
     preview(): void;

package/lib/behaviors/TakeSnapshot.js

@@ -77,6 +77,7 @@ export class TakeSnapshot extends ActionBehavior {
             snapshotContext.canvasImage.value = this.dataUrl;
         };
     }
+    /** @zprop */
     perform() {
         useOnAfterRender(this.contextManager).next.then(this.capture);
     }

package/lib/behaviors/ToggleLayerClips.d.ts

@@ -90,8 +90,9 @@ export declare class ToggleLayerClips extends ActionBehavior {
     easing?: string;
     isA: boolean;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
 }
 export declare enum Pin {

package/lib/behaviors/ToggleLayerClips.js

@@ -27,6 +27,7 @@ export class ToggleLayerClips extends ActionBehavior {
         this.fromStart = false;
         this.isA = true;
     }
+    /** @zprop */
     perform() {
         this.isA = !this.isA;
         const opts = {
@@ -62,7 +63,7 @@ export class ToggleLayerClips extends ActionBehavior {
                 layerclip.play(opts);
         }
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/stream/PauseStream.d.ts

@@ -17,6 +17,9 @@ export declare class PauseStream extends ActionBehavior {
     stream: string | undefined;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
     perform(): void;
-    /** @zprop */
+    /**
+     * @zprop
+     * @zui
+     */
     preview(): void;
 }

package/lib/behaviors/stream/PauseStream.js

@@ -18,7 +18,10 @@ export class PauseStream extends ActionBehavior {
             return;
         stream.pause();
     }
-    /** @zprop */
+    /**
+     * @zprop
+     * @zui
+     */
     preview() {
         this.perform();
     }

package/lib/behaviors/stream/PlayStream.d.ts

@@ -39,7 +39,8 @@ export declare class PlayStream extends ActionBehavior {
      */
     fromStart: boolean;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
 }

package/lib/behaviors/stream/PlayStream.js

@@ -19,6 +19,7 @@ export class PlayStream extends ActionBehavior {
          */
         this.fromStart = false;
     }
+    /** @zprop */
     perform() {
         if (!this.stream)
             return;
@@ -29,7 +30,7 @@ export class PlayStream extends ActionBehavior {
             stream.seek(0);
         stream.play({ loop: this.loop, speed: this.speed });
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/stream/SeekStream.d.ts

@@ -24,7 +24,8 @@ export declare class SeekStream extends ActionBehavior {
      */
     time: number;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
 }

package/lib/behaviors/stream/SeekStream.js

@@ -18,6 +18,7 @@ export class SeekStream extends ActionBehavior {
          */
         this.time = 0;
     }
+    /** @zprop */
     perform() {
         if (!this.stream)
             return;
@@ -26,7 +27,7 @@ export class SeekStream extends ActionBehavior {
             return;
         stream.seek(this.time ?? 0);
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/behaviors/stream/StopStream.d.ts

@@ -16,7 +16,8 @@ export declare class StopStream extends ActionBehavior {
      */
     stream: string | undefined;
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
-    perform(): void;
     /** @zprop */
+    perform(): void;
+    /** @zui */
     preview(): void;
 }

package/lib/behaviors/stream/StopStream.js

@@ -10,6 +10,7 @@ export class StopStream extends ActionBehavior {
         super(contextManager, instance, props);
         this.zcomponent = this.getZComponentInstance();
     }
+    /** @zprop */
     perform() {
         if (!this.stream)
             return;
@@ -18,7 +19,7 @@ export class StopStream extends ActionBehavior {
             return;
         stream.stop();
     }
-    /** @zprop */
+    /** @zui */
     preview() {
         this.perform();
     }

package/lib/component.d.ts

@@ -65,7 +65,7 @@ export declare class Component<ElementType = any, ConstructorPropsType extends C
      * @group Other
      * @zgrouppriority 0
      */
-    tags: Observable<string[], never>;
+    readonly tags: Observable<string[], never>;
     private _updateEnabledResolved;
     private _updateTags;
     dispose(): never;

package/lib/components/Audio.d.ts

@@ -26,12 +26,12 @@ export interface AudioConstructorProps {
  * @zstream
  */
 export declare class Audio extends Component<undefined, AudioConstructorProps> implements Stream {
-    /** @zui */ onEnded: Event<[Audio]>;
-    /** @zui */ onStop: Event<[Audio]>;
-    /** @zui */ onPause: Event<[Audio]>;
-    /** @zui */ onPlay: Event<[Audio]>;
-    audioContext: AudioContext;
-    destination: AudioNode;
+    /** @zui */ readonly onEnded: Event<[Audio]>;
+    /** @zui */ readonly onStop: Event<[Audio]>;
+    /** @zui */ readonly onPause: Event<[Audio]>;
+    /** @zui */ readonly onPlay: Event<[Audio]>;
+    readonly audioContext: AudioContext;
+    readonly destination: AudioNode;
     audioBuffer?: AudioBuffer;
     private _gain;
     private _reversed?;
@@ -46,7 +46,7 @@ export declare class Audio extends Component<undefined, AudioConstructorProps> i
      * @zgroup Audio
      * @zgrouppriority 20
      */
-    muted: Observable<boolean, never>;
+    readonly muted: Observable<boolean, never>;
     private _getReversed;
     /**
      * @zprop
@@ -55,16 +55,28 @@ export declare class Audio extends Component<undefined, AudioConstructorProps> i
      * @zgrouppriority 20
      * @zdefault 1
      */
-    volume: Observable<number, never>;
-    /** @zprop */
+    readonly volume: Observable<number, never>;
+    /**
+     * @zprop
+     * @zui
+     */
     play(opts?: PlayOptions): void;
     private _pause;
-    /** @zprop */
+    /**
+     * @zprop
+     * @zui
+     */
     pause(): void;
-    /** @zprop */
+    /**
+     * @zprop
+     * @zui
+     */
     stop(): void;
-    /** @zprop */
-    seek(t: number): void;
+    /**
+     * @zprop
+     * @zui
+     */
+    seek(/** @ztype time-milliseconds */ t: number): void;
     length(): number | undefined;
     dispose(): never;
 }

package/lib/components/Audio.js

@@ -68,7 +68,10 @@ export class Audio extends Component {
         }
         return this._reversed;
     }
-    /** @zprop */
+    /**
+     * @zprop
+     * @zui
+     */
     play(opts) {
         if (!this.audioBuffer)
             return;
@@ -105,19 +108,28 @@ export class Audio extends Component {
         this._session.source.disconnect();
         delete this._session;
     }
-    /** @zprop */
+    /**
+     * @zprop
+     * @zui
+     */
     pause() {
         this._pause();
         this.onPause.emit(this);
     }
-    /** @zprop */
+    /**
+     * @zprop
+     * @zui
+     */
     stop() {
         this._pause();
         this._playhead = 0;
         this.onStop.emit(this);
     }
-    /** @zprop */
-    seek(t) {
+    /**
+     * @zprop
+     * @zui
+     */
+    seek(/** @ztype time-milliseconds */ t) {
         let previousSession = this._session;
         if (previousSession)
             this._pause();

package/lib/components/AudioLayerSettings.d.ts

@@ -21,6 +21,6 @@ export declare class AudioLayerSettings extends Component<undefined, AudioLayerS
      * @ztype proportion
      * @zdefault 1
      */
-    volume: Observable<number, never>;
+    readonly volume: Observable<number, never>;
 }
 export {};