Configuration

In the root of your project, you can find (or add) a file tikuiconfig.json.

If the project is generated using tikui-cli, the file may looks like:

{
  "documentation": "tikui"
}

documentation

The documentation field is mandatory and load the documentation theme of your Pattern Library.

You also need to install the documentation module (here tikuidoc-tikui) with:

npm i tikuidoc-tikui

To create your own theme module, you need to make a new node package with a name like tikuidoc-{name} where {name} is your theme name.

Then publish it, add to your dependencies and put the {name} as a value in the documentation field.

The cache directory used for Tikui when you launch it with npm run serve.

Default: ".tikui-cache"

{
  "cache": ".tikui-cache"
}

The generated (dist) folder location.

Default: "dist"

{
  "dist": "dist"
}

This field let you expose something from a directory or a file to a specific route.

The structure:

Record<string, string>;

Example:

{
  "node_modules/some-module/dist": "some-module"
}

node_modules/some-module/dist content will be exposed under some-module path (copied in build mode).

Default: {}

{
  "expose": {}
}

This is the port used for Tikui when you launch it with npm run serve.

Default: 3000

{
  "port": 3000
}

This is the port used for Tikui to reload your page when you launch it with npm run serve.

Default: 3030

{
  "reloadPort": 3030
}

The source folder location.

Default: "src"

{
  "src": "src"
}

Enable verbosity to show more messages in the console.

Default: false

{
  "verbose": false
}