@kong-ui-public/expressions 0.3.14-pr.1497.fec06f76.0 → 0.3.14
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.
- package/README.md +2 -6
- package/dist/expressions.es.js +2 -2
- package/dist/style.css +1 -1
- package/dist/types/index.d.ts +1 -2
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/schema.d.ts +0 -2
- package/dist/types/schema.d.ts.map +1 -1
- package/package.json +8 -13
- package/dist/types/components/MonacoEditor.vue.d.ts +0 -46
- package/dist/types/components/MonacoEditor.vue.d.ts.map +0 -1
- package/dist/types/components/PageHeader.vue.d.ts +0 -31
- package/dist/types/components/PageHeader.vue.d.ts.map +0 -1
- package/dist/types/components/RequestCard.vue.d.ts +0 -38
- package/dist/types/components/RequestCard.vue.d.ts.map +0 -1
- package/dist/types/components/RequestImportModal.vue.d.ts +0 -23
- package/dist/types/components/RequestImportModal.vue.d.ts.map +0 -1
- package/dist/types/components/RequestModal.vue.d.ts +0 -24
- package/dist/types/components/RequestModal.vue.d.ts.map +0 -1
- package/dist/types/components/RouterPlayground.vue.d.ts +0 -42
- package/dist/types/components/RouterPlayground.vue.d.ts.map +0 -1
- package/dist/types/components/RouterPlaygroundModal.vue.d.ts +0 -33
- package/dist/types/components/RouterPlaygroundModal.vue.d.ts.map +0 -1
- package/dist/types/components/SupportText.vue.d.ts +0 -10
- package/dist/types/components/SupportText.vue.d.ts.map +0 -1
- package/dist/types/composables/index.d.ts +0 -6
- package/dist/types/composables/index.d.ts.map +0 -1
- package/dist/types/composables/useI18n.d.ts +0 -286
- package/dist/types/composables/useI18n.d.ts.map +0 -1
- package/dist/types/definitions.d.ts +0 -24
- package/dist/types/definitions.d.ts.map +0 -1
- package/dist/types/external-links.d.ts +0 -5
- package/dist/types/external-links.d.ts.map +0 -1
- package/dist/types/utils.d.ts +0 -9
- package/dist/types/utils.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -18,7 +18,6 @@ Reusable components to support [Kong's expressions language](https://docs.konghq
|
|
|
18
18
|
- `vue` must be initialized in the host application
|
|
19
19
|
- [`monaco-editor`](https://www.npmjs.com/package/monaco-editor) is required as a dependency in the host application
|
|
20
20
|
- [`vite-plugin-monaco-editor`](https://www.npmjs.com/package/vite-plugin-monaco-editor) is a required Vite plugin to bundle the Monaco Editor and its web workers
|
|
21
|
-
- [`@kong-ui-public/forms`](https://www.npmjs.com/package/@kong-ui-public/forms) is an optional dependency required for the `RouterPlaygroundModal` component
|
|
22
21
|
|
|
23
22
|
## Usage
|
|
24
23
|
|
|
@@ -28,7 +27,6 @@ Install required `dependencies` in your host application:
|
|
|
28
27
|
|
|
29
28
|
```sh
|
|
30
29
|
yarn add monaco-editor
|
|
31
|
-
yarn add @kong-ui-public/forms # optional: required for `RouterPlaygroundModal` component
|
|
32
30
|
```
|
|
33
31
|
|
|
34
32
|
Install required `devDependencies` in your host application:
|
|
@@ -60,10 +58,9 @@ Import the component(s) in your host application as well as the package styles:
|
|
|
60
58
|
```ts
|
|
61
59
|
import { asyncInit, ExpressionsEditor } from '@kong-ui-public/expressions'
|
|
62
60
|
import '@kong-ui-public/expressions/dist/style.css'
|
|
63
|
-
import '@kong-ui-public/forms/dist/style.css' // optional: required for `RouterPlaygroundModal` component
|
|
64
61
|
```
|
|
65
62
|
|
|
66
|
-
This package utilizes [vite-plugin-top-level-await](https://github.com/Menci/vite-plugin-top-level-await) to transform code in order to use top-level await on older browsers. To load the WASM correctly, you must use `await` or `Promise.then` to wait the imported `asyncInit` before using any other imported values.
|
|
63
|
+
This package utilizes [vite-plugin-top-level-await](https://github.com/Menci/vite-plugin-top-level-await) to transform code in order to use top-level await on older browsers. To load the WASM correctly, you must use `await` or `Promise.then` to wait the imported `asyncInit` before using any other imported values.
|
|
67
64
|
|
|
68
65
|
For example:
|
|
69
66
|
|
|
@@ -80,5 +77,4 @@ You can also make use of Vue's experimental [Suspense](https://vuejs.org/guide/b
|
|
|
80
77
|
|
|
81
78
|
## Individual component documentation
|
|
82
79
|
|
|
83
|
-
- [`<ExpressionsEditor />`](docs/expressions-editor.md)
|
|
84
|
-
- [`<RouterPlaygroundModal />`](docs/router-playground-modal.md)
|
|
80
|
+
- [`<ExpressionsEditor.vue />`](docs/expressions-editor.md)
|