@hkdigital/lib-sveltekit 0.1.45 → 0.1.46

package/README.md

@@ -11,6 +11,10 @@ It contains common code and components that we use to create our projects.
 This package is incomplete and not fully tested.
 Do not use in production environments yet.
 
+### TODO
+
+Add information about Skeleton, theming and imagetools
+
 ## A note about tailwindcss
 
 Components in this package use [tailwindcss](https://tailwindcss.com/).
@@ -46,7 +50,7 @@ We use a wildcard to upgrade all installed `node_modules` in the scope `@hkdigit
 You can also add this command to your project. To do so, add the lines to the bottom of the `scripts` section of your `package.json`.
 
 ```bash
-"upgrade:hklib": "ncu '@hkdigital/*' -u && pnpm install",
+"upgrade:hk": "ncu --dep dev,optional,peer,prod '@hkdigital/*' -u && pnpm install",
 "upgrade:all": "ncu -u && pnpm install"
 ```
 
@@ -83,7 +87,7 @@ export default {
     './src/**/*.{html,js,svelte,ts}',
 ```
 
-## Building the showcase app
+## Building the library
 
 To build your library:
 
@@ -91,6 +95,8 @@ To build your library:
 npm run package
 ```
 
+## Building the showcase app
+
 To create a production version of your showcase app:
 
 ```bash

package/dist/widgets/presenter/Presenter.state.svelte.d.ts

@@ -68,6 +68,6 @@ export class PresenterState {
 export type Slide = import("./typedef").Slide;
 export type Transition = import("./typedef").Transition;
 export type Layer = import("./typedef").Layer;
-export type PresenterRef = import("./typedef").Layer;
-export type LoadController = import("./typedef").Layer;
+export type PresenterRef = import("./typedef").PresenterRef;
+export type LoadController = import("./typedef").LoadController;
 import { HkPromise } from '../../classes/promise/index.js';

package/dist/widgets/presenter/Presenter.state.svelte.js

@@ -21,11 +21,11 @@ import { STAGE_BEFORE, STAGE_SHOW } from './constants.js';
  */
 
 /**
- * @typedef {import("./typedef").Layer} PresenterRef
+ * @typedef {import("./typedef").PresenterRef} PresenterRef
  */
 
 /**
- * @typedef {import("./typedef").Layer} LoadController
+ * @typedef {import("./typedef").LoadController} LoadController
  */
 
 const Z_BACK = 0;
@@ -589,7 +589,7 @@ export class PresenterState {
           this.onBeforeListeners.delete(key);
         };
       },
-      onAfter: (callback) => {
+      onShow: (callback) => {
         const key = Symbol();
         this.onShowListeners.set(key, callback);
 

package/dist/widgets/presenter/typedef.d.ts

@@ -25,10 +25,6 @@ export type FadeOutTransition = {
     duration?: number;
     timing?: string;
 };
-export type ListenerParams = {
-    stage: string;
-    slideName: string;
-};
 export type LoadController = {
     /**
      * - Function to call when loading is complete
@@ -39,6 +35,12 @@ export type LoadController = {
      */
     cancel: () => void;
 };
+export type ListenerParams = {
+    stage: string;
+    slideName: string;
+};
+export type ListenerCallback = (params: ListenerParams) => () => void;
+export type UnregisterFn = () => void;
 export type PresenterRef = {
     /**
      * - Navigate to a slide by name
@@ -48,7 +50,14 @@ export type PresenterRef = {
      * - Get the current slide name
      */
     getCurrentSlideName: () => string;
-    onUpdate: (callback: any) => Function;
+    /**
+     *   Register listener that is called when a slide enters state 'before'
+     */
+    onBefore: (callback: ListenerCallback) => UnregisterFn;
+    /**
+     *   Register listener that is called when a slide enters state 'show'
+     */
+    onShow: (callback: ListenerCallback) => UnregisterFn;
 };
 export type Transition = CssTransition | FadeInTransition | FadeOutTransition;
 export type SlideData = {

package/dist/widgets/presenter/typedef.js

@@ -32,6 +32,12 @@
  * }} FadeOutTransition
  */
 
+/**
+ * @typedef {Object} LoadController
+ * @property {() => void} loaded - Function to call when loading is complete
+ * @property {() => void} cancel - Function to return to the previous slide
+ */
+
 /**
  * @typedef {{
  *   stage: string,
@@ -40,16 +46,21 @@
  */
 
 /**
- * @typedef {Object} LoadController
- * @property {() => void} loaded - Function to call when loading is complete
- * @property {() => void} cancel - Function to return to the previous slide
+ * @typedef {( params: ListenerParams) => () => void } ListenerCallback
+ */
+
+/**
+ * @typedef {() => void } UnregisterFn
  */
 
 /**
  * @typedef {Object} PresenterRef
  * @property {(name: string) => void} gotoSlide - Navigate to a slide by name
  * @property {() => string} getCurrentSlideName - Get the current slide name
- * @property {(callback)=>Function} onUpdate
+ * @property {( callback: ListenerCallback ) => UnregisterFn} onBefore
+ *   Register listener that is called when a slide enters state 'before'
+ * @property {( callback: ListenerCallback ) => UnregisterFn} onShow
+ *   Register listener that is called when a slide enters state 'show'
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hkdigital/lib-sveltekit",
-	"version": "0.1.45",
+	"version": "0.1.46",
 	"author": {
 		"name": "HKdigital",
 		"url": "https://hkdigital.nl"