piral-vue-3 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
@@ -65,18 +65,19 @@ Here we integrate the `i18next` plugin using the `i18next-vue` package. By defin
65
65
 
66
66
  ## Usage
67
67
 
68
- ::: summary: For pilet authors
68
+ ::: summary: Modern Use (recommended)
69
69
 
70
- You can use the `fromVue3` function from the Pilet API to convert your Vue@3 components to components usable by your Piral instance.
70
+ The recommended way is to use `piral-vue-3` from your pilets. In this case, no registration in the Piral instance is required.
71
71
 
72
72
  Example use:
73
73
 
74
74
  ```ts
75
75
  import { PiletApi } from '<name-of-piral-instance>';
76
+ import { fromVue3 } from 'piral-vue-3/convert';
76
77
  import VuePage from './Page.vue';
77
78
 
78
79
  export function setup(piral: PiletApi) {
79
- piral.registerPage('/sample', piral.fromVue3(VuePage));
80
+ piral.registerPage('/sample', fromVue3(VuePage));
80
81
  }
81
82
  ```
82
83
 
@@ -85,22 +86,11 @@ Within Vue@3 components the Piral Vue@3 extension component can be used by refer
85
86
  ```html
86
87
  <extension-component name="name-of-extension"></extension-component>
87
88
  ```
88
-
89
- Alternatively, if `piral-vue-3` has not been added to the Piral instance you can install and use the package also from a pilet directly.
90
-
91
- ```ts
92
- import { PiletApi } from '<name-of-piral-instance>';
93
- import { fromVue3 } from 'piral-vue-3/convert';
94
- import VuePage from './Page.vue';
95
-
96
- export function setup(piral: PiletApi) {
97
- piral.registerPage('/sample', fromVue3(VuePage));
98
- }
99
- ```
100
-
101
89
  :::
102
90
 
103
- ::: summary: For Piral instance developers
91
+ ::: summary: Legacy Use
92
+
93
+ For backwards compatibility, you can also install `piral-vue-3` in your Piral instance.
104
94
 
105
95
  Using Vue with Piral is as simple as installing `piral-vue-3` and `vue@3`.
106
96
 
@@ -129,7 +119,6 @@ The `vue` package should be shared with the pilets via the *package.json*:
129
119
  }
130
120
  }
131
121
  ```
132
-
133
122
  :::
134
123
 
135
124
  ## Development Setup
@@ -194,4 +183,4 @@ module.exports = extendWebpack({
194
183
 
195
184
  ## License
196
185
 
197
- Piral is released using the MIT license. For more information see the [license file](./LICENSE).
186
+ 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",
3
- "version": "1.9.0-beta.8182",
3
+ "version": "1.9.0-beta.8196",
4
4
  "description": "Plugin for integrating Vue@3 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": "^3.0.0"
59
59
  },
60
- "gitHead": "495aa779b7e4482a1515f1e5a2a591f907c6a052"
60
+ "gitHead": "73f7d0d90884d0b1dc1cc5ed7965f0cb0bc48a20"
61
61
  }