element-vir 13.0.2 → 13.0.3

package/README.md

@@ -517,7 +517,7 @@ The following custom [`lit` directives](https://lit.dev/docs/templates/custom-di
 
 All [built-in `lit` directives](https://lit.dev/docs/templates/directives/) are also exported by `element-vir`.
 
-### onDomCreated
+### `onDomCreated`
 
 This triggers only once when the element it's attached to has actually been created in the DOM. If the attached element changes, the callback will be triggered again.
 
@@ -543,7 +543,7 @@ export const MyWithOnDomCreated = defineElementNoInputs({
 });
 ```
 
-### onResize
+### `onResize`
 
 This directive fires its callback whenever the element it's attached to resizes. The callback is passed an object with a portion of the [`ResizeObserverEntry`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry) properties.
 
@@ -570,15 +570,15 @@ export const MyWithOnResize = defineElementNoInputs({
 });
 ```
 
-### assign
+### `assign`
 
 Assign a value to one of a custom element's properties. This is explained in the **Assigning to inputs** section earlier.
 
-### listen
+### `listen`
 
 Listen to a specific event. This is explained in the **Listening to element events (outputs)** section earlier.
 
-### assignWithCleanup
+### `assignWithCleanup`
 
 This directive is the same as the `assign` directive but it accepts an additional `cleanupCallback` input. Use this directive to assign values which need some kind of cleanup when they're overwritten. For example, a 3D rendering engine which uses the canvas that should free up memory when it's swapped out.
 
@@ -613,7 +613,7 @@ export const MyWithCleanup = defineElementNoInputs({
 });
 ```
 
-### renderIf
+### `renderIf`
 
 Use the `renderIf` directive to easily render a template if a given condition is true.
 
@@ -637,9 +637,9 @@ export const MyWithRenderIf = defineElement<{shouldRender: boolean}>()({
 });
 ```
 
-### asyncState
+### `asyncProp`
 
-Use the `renderAsyncState` directive in conjunction with the `asyncState` property definer to seamlessly render and update element state based on async values:
+Use `renderAsyncProp` or `isRenderReady` in conjunction with `asyncProp` to seamlessly render and update element state based on async values:
 
 <!-- example-link: src/readme-examples/my-with-async-prop.element.ts -->
 

package/dist/declarative-element/directives/render-async.directive.d.ts

@@ -1,6 +1,6 @@
 import { UnPromise } from '@augment-vir/common';
 import { AsyncProp } from './async-prop';
-export declare function renderAsync<T, FallbackResult, ResolutionRenderResult = never, ErrorRenderResult = never>(asyncState: AsyncProp<T>, fallback: FallbackResult, resolutionRender: (resolved: UnPromise<T>) => ResolutionRenderResult, errorRender: (error: Error) => ErrorRenderResult): FallbackResult | ResolutionRenderResult | ErrorRenderResult;
-export declare function renderAsync<T, FallbackResult, ResolutionRenderResult = never, ErrorRenderResult = never>(asyncState: AsyncProp<T>, fallback: FallbackResult, resolutionRender: (resolved: UnPromise<T>) => ResolutionRenderResult, errorRender?: undefined): FallbackResult | ResolutionRenderResult | string;
-export declare function renderAsync<T, FallbackResult, ResolutionRenderResult = never, ErrorRenderResult = never>(asyncState: AsyncProp<T>, fallback: FallbackResult, resolutionRender: undefined, errorRender: (error: Error) => ErrorRenderResult): FallbackResult | UnPromise<T> | ErrorRenderResult;
-export declare function renderAsync<T, FallbackResult, ResolutionRenderResult = never, ErrorRenderResult = never>(asyncState: AsyncProp<T>, fallback: FallbackResult, resolutionRender?: undefined, errorRender?: undefined): FallbackResult | UnPromise<T> | string;
+export declare function renderAsync<T, FallbackResult, ResolutionRenderResult = never, ErrorRenderResult = never>(asyncProp: AsyncProp<T>, fallback: FallbackResult, resolutionRender: (resolved: UnPromise<T>) => ResolutionRenderResult, errorRender: (error: Error) => ErrorRenderResult): FallbackResult | ResolutionRenderResult | ErrorRenderResult;
+export declare function renderAsync<T, FallbackResult, ResolutionRenderResult = never, ErrorRenderResult = never>(asyncProp: AsyncProp<T>, fallback: FallbackResult, resolutionRender: (resolved: UnPromise<T>) => ResolutionRenderResult, errorRender?: undefined): FallbackResult | ResolutionRenderResult | string;
+export declare function renderAsync<T, FallbackResult, ResolutionRenderResult = never, ErrorRenderResult = never>(asyncProp: AsyncProp<T>, fallback: FallbackResult, resolutionRender: undefined, errorRender: (error: Error) => ErrorRenderResult): FallbackResult | UnPromise<T> | ErrorRenderResult;
+export declare function renderAsync<T, FallbackResult, ResolutionRenderResult = never, ErrorRenderResult = never>(asyncProp: AsyncProp<T>, fallback: FallbackResult, resolutionRender?: undefined, errorRender?: undefined): FallbackResult | UnPromise<T> | string;

package/dist/declarative-element/directives/render-async.directive.js

@@ -1,22 +1,22 @@
 import { extractErrorMessage, isPromiseLike } from '@augment-vir/common';
 // full function type
-export function renderAsync(asyncState, 
+export function renderAsync(asyncProp, 
 /** This value will be rendered if the async prop has not settled yet. */
 fallback, resolutionRender, errorRender) {
-    if (asyncState instanceof Error) {
+    if (asyncProp instanceof Error) {
         const errorResult = errorRender
-            ? errorRender(asyncState)
-            : extractErrorMessage(asyncState);
+            ? errorRender(asyncProp)
+            : extractErrorMessage(asyncProp);
         return errorResult;
     }
-    else if (isPromiseLike(asyncState)) {
+    else if (isPromiseLike(asyncProp)) {
         const fallbackResult = fallback;
         return fallbackResult;
     }
     else {
         const resolutionResult = resolutionRender
-            ? resolutionRender(asyncState)
-            : asyncState;
+            ? resolutionRender(asyncProp)
+            : asyncProp;
         return resolutionResult;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "element-vir",
-    "version": "13.0.2",
+    "version": "13.0.3",
     "keywords": [
         "custom",
         "web",
@@ -31,7 +31,7 @@
         "publish": "virmator publish \"npm run compile && npm run test:all\"",
         "start": "npm install && virmator frontend",
         "test": "virmator test-web",
-        "test:all": "concurrently -c auto --kill-others-on-fail --colors \"npm run test:types\" \"npm run test:coverage\" \"npm run test:spelling\" \"npm run test:format\" \"npm run test:docs\"",
+        "test:all": "concurrently -c auto --kill-others-on-fail --colors --names types,tests,spelling,format,docs \"npm run test:types\" \"npm run test:coverage\" \"npm run test:spelling\" \"npm run test:format\" \"npm run test:docs\"",
         "test:coverage": "virmator test-web coverage",
         "test:docs": "virmator code-in-markdown check",
         "test:format": "virmator format check",