JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 317
  • Score
    100M100P100Q92048F
  • License Apache-2.0

Small generic components to extend the functionality of Coveo's Search UI framework.

Package Exports

  • coveo-search-ui-extensions

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (coveo-search-ui-extensions) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

search-ui-extensions

Travis Status NPM Version Coverage Status Known Vulnerabilities

This repository contains additionnal components meant to be used in conjunction with Coveo Javascript Search Framework to provide additionnal functionnalities.

Setup

Requires Node JS >= 8.0.

  1. npm install
  2. npm run build

Structure

The code is written in typescript and compiled using webpack.

  • Under the pages folder, you have a working search page (index.html). At build time, it is copied to the bin folder.

    • It references 2 style sheets (the base one from the Coveo Javascript Search Framework, and the one from the extension).
    • It references 3 javascript file (the extension one built in this project, and the basic templates and library scripts).

  • Under the src folder, you have all the typescript source code for the custom components, with src/Index.ts being the starting point of the application.

  • Under the src/sass folder, you have all the css for the extension.

  • Under the tests folder, you have all the tests for the custom components.

Build tasks

  • npm run setup will copy the needed ressources (index.html, templates, etc.) in the bin folder.
  • npm run css will build the sass files into a css file in the bin folder.
  • npm run build will run the setup, css task, then compile the typescript code.

Dev

npm run dev will start a webpack dev server. After it finishes, load http://localhost:8080/index.html in a browser, and the index.html page should load.

Then, anytime you hit save in a typescript file, the server will reload your application.

Tests

  • npm run test will execute the tests one time and give you the report
  • npm run watchTest will watch changes and reexecute the tests and coverage when saving a file.