nhsuk-header-search
v0.3.0
Published
Accessibile autocomplete implementation for NHS.UK search
Downloads
184
Readme
nhsuk-header-search
This component can be used to add a search box to an HTML page. The primary use of this is to provide a search box to use with nhsuk.site-search
Quickstart
Install Locally
To install this component locally
npm i nhsuk-header-search
Usage
An example of how the JavaScript and CSS for this control can be used, look at nhsuk-header-search/app/index.html
Dependencies
The dependencies for this component are listed in the package.json
file
Contributing
Development
Clone this repository
git clone https://github.com/nhsuk/nhsuk-header-search.git nhsuk-header-search
Change directory in to the folder where the repository has just been cloned.
cd nhsuk-header-search
Install all of the dependencies
npm install
Run the development server
npm start
A test site for local development will be available at http://localhost:3000.
Tests
The test suite currently consists only of unit tests, and the tests are written using Jest. The test and relevant setup files can be found in the tests folder.
To run the unit tests (with a code coverage report),
npm run test
Lint
To perform linting,
npm run lint
Publication
Publication of the npm package is preformed by a GitHub action. Details of this action can be found in the release.yml.