@findkit/ui
v1.5.0
Published
Findkit Search UI
Downloads
767
Readme
Findkit UI package
See documentation at https://docs.findkit.com/ui
Contributing
Get pnpm 7 and clone the repository
git clone https://github.com/findkit/findkit.git
Install node modules
cd findkit/packages/ui
pnpm install
Unit tests with Vitest
Run
pnpm vitest
Manual testing
Start development server and build watcher with
pnpm dev
This will serve the files from the e2e directory.
Try http://localhost:28104/static/single-group?fdk_q=wordpress for example.
E2E Tests with Playwright
While the development server is running you can execute the Playwright tests with:
pnpm playwright-test --headed
pnpm playwright-visual --headed
Updating the visual snapshots
Run
pnpm playwright-update
and review and commit the changes.
Manual packaging
When you want test the changes in your project you must build the package and install it to your project.
Build everything first
pnpm build
and pack to .tgz
file
pnpm pack
This will create a file like findkit-ui-0.0.1.tgz
which can be installed to
your project. When installing it you should use the package manager your project
is using.
cd /path/to/project
npm install /path/to/findkit/clone/findkit-ui-0.0.1.tgz
Because this is a local build you must disable the CDN usage: https://docs.findkit.com/ui/advanced/disable-cdn
Conventions
Privates
This package uses custom convention for private properties and methods. Every
private method and property should have the Typescript private
keyword and
PRIVATE_
prefix. The privates are mangled using esbuild when the package
is published.
The native Javascript privates cannot be used because they produce too much code when transpiled down to legacy Javascript and they are too new ship as is.