@nebula.js/sn-nav-menu/README.md

A navigation menu object for Qlik Sense

# sn-nav-menu

## !Experimental

A navigation menu object for Qlik Sense implemented as a nebula.js supernova.

## Developing

- Install with `pnpm install`
- Transpile code: `pnpm build` (or `pnpm build:watch`)
- Run it using nebula serve `pnpm start`

## Testing

Run unit tests with:

`pnpm test:unit`

# Rendering tests

Rendering tests are running playwright. Execute rendering tests with `pnpm test:e2 --headed`.

Rendering test compares a baseline snapshot with a current version of the same object. The output is then stored under `baselines`. It is important to take the baseline from the build in your PR and not your local baselines which is stored under `baselines-local`. The report with baselines can be found under summary and is a zipped file called `playwright-report`. Make sure to unzip it to see the images.

## Linting

Run lint with:

`pnpm lint`

## Releasing

Trigger the github action `Build, validate, (release)` and make sure you tick the `release` checkbox.