@ouidesigner/ouiderx
v0.1.10
Published
**OuiderX** allow developers to write OUIDesigner page using xml syntax and transpile it to native view json syntax which will be used by the SDK to generate appropriate views. # Usage ## Installation ### Globally You can install the package globally also
Readme
OUIDesigner Renderer Next generation bundler
OuiderX allow developers to write OUIDesigner page using xml syntax and transpile it to native view json syntax which will be used by the SDK to generate appropriate views.
Usage
Installation
Globally
You can install the package globally also, which allows you to use it as the CLI for OUIDERX projects:
npm install -g @ouidesigner/ouiderx
Install module
To install modules from app.json in a project root, run: ouiderx.
To compile a project without a local install, run: npx @ouidesigner/ouiderx run.
If the CLI is installed globally or locally, ouiderx run also works.
To launch the shared browser preview without the IDE, run:
npx @ouidesigner/ouiderx preview
The first preview run installs the cached Angular/oui-ion preview shell dependencies. Later runs reuse that cache. Use --port <n> when the default 4200 port is busy.
Preview translations are loaded from the project app.json translation file:
{
"entry": "index.omc",
"translation": "translation.json"
}Use --language <locale> to choose the preview locale:
npx @ouidesigner/ouiderx preview --language fr
To install a specific module and update app.json, run: ouiderx install <module>:<location>[:<version>].
Locally
You can install the package from npm:
npm install @ouidesigner/ouiderx
In your code you can import ouiderx function to transpile files
import { build } from '@ouidesigner/ouiderx'
await build({
inputFile, baseDir, outputDir: 'dist', copy: assets
})OUIDERX web preview is owned by the IDE/toolchain. Mini app projects should not need a project-local .testing Angular app; the IDE and ouiderx preview provide and cache their own Angular/oui-ion preview shell.
