piral-blazor - npm Package Compare versions

Comparing version 0.11.2-pre.1094 to 0.11.2-pre.1095

lib/create.js

@@ -65,3 +65,3 @@ "use strict";
                     };
-                    var result = !lazy && load();
+                    var result = !lazy && loader.then(load);
                     dependency = function () { return result || (result = load()); };
@@ -68,0 +68,0 @@ },

package.json

 {
   "name": "piral-blazor",
-  "version": "0.11.2-pre.1094",
+  "version": "0.11.2-pre.1095",
   "description": "Plugin for integrating Blazor components in Piral.",
@@ -25,2 +25,3 @@ "keywords": [
   "files": [
+    "infra.codegen",
     "lib",
@@ -48,3 +49,3 @@ "src"
     "@types/emscripten": "0.0.34",
-    "piral-core": "^0.11.2-pre.1094"
+    "piral-core": "^0.11.2-pre.1095"
   },
@@ -54,3 +55,3 @@ "peerDependencies": {
   },
-  "gitHead": "0a1d1ab093ee653fb6ab59bf518c7c977a1eec0e"
+  "gitHead": "4dce013bafc1d17b04fb01b04f5fc4785ee22b15"
 }

README.md

@@ -7,3 +7,3 @@ [![Piral Logo](https://github.com/smapiot/piral/raw/master/docs/assets/logo.png)](https://piral.io)
 
-The set includes an Blazor loader and converter for any component registration, as well as a `fromBlazor` shortcut together with a `blazor-extension` web component.
+The set includes an Blazor loader and converter for any component registration, as well as a `fromBlazor` shortcut together with some Blazor component coming in the `Piral.Blazor.Utils` NuGet package.
 
@@ -16,2 +16,6 @@ By default, these API extensions are not integrated in `piral`, so you'd need to add them to your Piral instance.
 
+### `defineBlazorReferences()`
+
+Adds the URLs to additional DLLs that need to be referenced for obtaining the Blazor components. At best this uses `require.resolve` to get the URL from the bundler.
+
 ### `fromBlazor()`
@@ -27,2 +31,22 @@
 
+Example use:
+
+```ts
+import { PiletApi } from '<name-of-piral-instance>';
+
+export function setup(piral: PiletApi) {
+  piral.defineBlazorReferences([
+    require.resolve('./My.Components.dll'),
+    require.resolve('./My.Dependency.dll'),
+  ])
+  piral.registerPage('/sample', piral.fromBlazor('sample-page'));
+}
+```
+
+Within Blazor components the `Extension` component referenced from `Piral.Blazor.Utils`, e.g.,
+
+```jsx
+<Extension name="name-of-extension" />
+```
+
 ## Setup and Bootstrapping
@@ -48,4 +72,8 @@
 
+This will automatically download and include the necessary binary files for providing Blazor WASM support. The binary files will be taken from the `Piral.Blazor.Core` NuGet package.
+
+By default, the latest version of the `Piral.Blazor.Core` NuGet package is downloaded. To change this set the `PIRAL_BLAZOR_VERSION` environment variable to the desired version.
+
 ## License
 
 Piral is released using the MIT license. For more information see the [license file](./LICENSE).

src/create.ts

@@ -88,3 +88,3 @@ import { Extend } from 'piral-core';
             );
-          let result = !lazy && load();
+          let result = !lazy && loader.then(load);
           dependency = () => result || (result = load());
@@ -91,0 +91,0 @@ },

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

387850

increased by0.85%

Number of package files

109

increased by0.93%

Number of lines in readme file

76

increased by58.33%

No dependency changes