piral-solid 1.9.0-beta.8182 → 1.9.0-beta.8196

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +8 -19
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -22,18 +22,19 @@ The extension slot component to be used in Solid components.
22
22
 
23
23
  ## Usage
24
24
 
25
- ::: summary: For pilet authors
25
+ ::: summary: Modern Use (recommended)
26
26
 
27
- You can use the `fromSolid` function from the Pilet API to convert your Solid components to components usable by your Piral instance.
27
+ The recommended way is to use `piral-solid` from your pilets. In this case, no registration in the Piral instance is required.
28
28
 
29
29
  Example use:
30
30
 
31
31
  ```ts
32
32
  import { PiletApi } from '<name-of-piral-instance>';
33
+ import { fromSolid } from 'piral-solid/convert';
33
34
  import { SolidPage } from './SolidPage';
34
35
 
35
36
  export function setup(piral: PiletApi) {
36
- piral.registerPage('/sample', piral.fromSolid(SolidPage));
37
+ piral.registerPage('/sample', fromSolid(SolidPage));
37
38
  }
38
39
  ```
39
40
 
@@ -42,22 +43,11 @@ Within Solid components the Piral Solid extension component can be used by refer
42
43
  ```jsx
43
44
  <SolidExtension name="name-of-extension" />
44
45
  ```
45
-
46
- Alternatively, if `piral-solid` has not been added to the Piral instance you can install and use the package also from a pilet directly.
47
-
48
- ```ts
49
- import { PiletApi } from '<name-of-piral-instance>';
50
- import { fromSolid } from 'piral-solid/convert';
51
- import { SolidPage } from './SolidPage';
52
-
53
- export function setup(piral: PiletApi) {
54
- piral.registerPage('/sample', fromSolid(SolidPage));
55
- }
56
- ```
57
-
58
46
  :::
59
47
 
60
- ::: summary: For Piral instance developers
48
+ ::: summary: Legacy Use
49
+
50
+ For backwards compatibility, you can also install `piral-solid` in your Piral instance.
61
51
 
62
52
  Using Solid with Piral is as simple as installing `piral-solid` and `solid-js@^1`.
63
53
 
@@ -87,9 +77,8 @@ The `solid-js` and `solid-js/web` packages should be shared with the pilets via
87
77
  }
88
78
  }
89
79
  ```
90
-
91
80
  :::
92
81
 
93
82
  ## License
94
83
 
95
- Piral is released using the MIT license. For more information see the [license file](./LICENSE).
84
+ Piral is released using the MIT license. For more information see the [license file](./LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "piral-solid",
3
- "version": "1.9.0-beta.8182",
3
+ "version": "1.9.0-beta.8196",
4
4
  "description": "Plugin for integrating Solid components in Piral.",
5
5
  "keywords": [
6
6
  "piral",
@@ -51,8 +51,8 @@
51
51
  "test": "echo \"Error: run tests from root\" && exit 1"
52
52
  },
53
53
  "devDependencies": {
54
- "piral-core": "1.9.0-beta.8182",
54
+ "piral-core": "1.9.0-beta.8196",
55
55
  "solid-js": "^1.7.3"
56
56
  },
57
- "gitHead": "495aa779b7e4482a1515f1e5a2a591f907c6a052"
57
+ "gitHead": "73f7d0d90884d0b1dc1cc5ed7965f0cb0bc48a20"
58
58
  }