/dawa-autocomplete-ts

Primary LanguageTypeScriptMIT LicenseMIT

dawa-autocomplete-ts

DAWA Autocomplete TS is a rewrite of SDFIdk/dawa-autocomplete2 using TypeScript instead of JavaScript.

About

The aim of this project is to create an implementation of the Dawa Autocomplete API written in Typescript. This project uses Vite for the bundler, and Vitest for testing.

Code standards

This project is using an opinionated configuration of eslint and prettier to ensure a high standard of code quality.

Instead of NPM this project uses PNPM

Browser support

This project targets full support for all major browsers; Firefox, Chrome and all Chromium based browsers such as Edge, and Safari.

The project is yet to be tested.

Usage

Install with

npm i @oak-digital/dawa-autocomplete-ts

Development

Run the demo locally

pnpm dev

Building the project:

pnpm build

Roadmap

  • Base implementation
  • Demo
  • Tests
  • Publish as npm package
  • Documentation
  • React component

Contributing

TODO

License

Distributed under the MIT license.