piral-vue 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 Vue@2 components. This is not really
22
22
 
23
23
  ## Usage
24
24
 
25
- ::: summary: For pilet authors
25
+ ::: summary: Modern Use (recommended)
26
26
 
27
- You can use the `fromVue` function from the Pilet API to convert your Vue@2 components to components usable by your Piral instance.
27
+ The recommended way is to use `piral-vue` 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 { fromVue } from 'piral-vue/convert';
33
34
  import VuePage from './Page.vue';
34
35
 
35
36
  export function setup(piral: PiletApi) {
36
- piral.registerPage('/sample', piral.fromVue(VuePage));
37
+ piral.registerPage('/sample', fromVue(VuePage));
37
38
  }
38
39
  ```
39
40
 
@@ -42,22 +43,11 @@ Within Vue@2 components the Piral Vue@2 extension component can be used by refer
42
43
  ```html
43
44
  <extension-component name="name-of-extension"></extension-component>
44
45
  ```
45
-
46
- Alternatively, if `piral-vue` 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 { fromVue } from 'piral-vue/convert';
51
- import VuePage from './Page.vue';
52
-
53
- export function setup(piral: PiletApi) {
54
- piral.registerPage('/sample', fromVue(VuePage));
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-vue` in your Piral instance.
61
51
 
62
52
  Using Vue with Piral is as simple as installing `piral-vue` and `vue@^2`.
63
53
 
@@ -86,7 +76,6 @@ The `vue` package should be shared with the pilets via the *package.json*:
86
76
  }
87
77
  }
88
78
  ```
89
-
90
79
  :::
91
80
 
92
81
  ## Development Setup
@@ -150,4 +139,4 @@ module.exports = extendWebpack({
150
139
 
151
140
  ## License
152
141
 
153
- Piral is released using the MIT license. For more information see the [license file](./LICENSE).
142
+ 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-vue",
3
- "version": "1.9.0-beta.8182",
3
+ "version": "1.9.0-beta.8196",
4
4
  "description": "Plugin for integrating Vue@2 components in Piral.",
5
5
  "keywords": [
6
6
  "piral",
@@ -54,8 +54,8 @@
54
54
  "test": "echo \"Error: run tests from root\" && exit 1"
55
55
  },
56
56
  "devDependencies": {
57
- "piral-core": "1.9.0-beta.8182",
57
+ "piral-core": "1.9.0-beta.8196",
58
58
  "vue": "^2.6.10"
59
59
  },
60
- "gitHead": "495aa779b7e4482a1515f1e5a2a591f907c6a052"
60
+ "gitHead": "73f7d0d90884d0b1dc1cc5ed7965f0cb0bc48a20"
61
61
  }