{"_id":"@acpaas-ui-widgets/ngx-search","_rev":"7-1f6642848da756fd21ba109df1cd0ba9","name":"@acpaas-ui-widgets/ngx-search","dist-tags":{"latest":"2.0.0"},"versions":{"2.0.0":{"name":"@acpaas-ui-widgets/ngx-search","version":"2.0.0","keywords":["angular","library","search","typescript","angular-cli","ng-packagr"],"author":{"name":"Pieter-Jan Sas","email":"pieter-jan.sas@digipolis.be"},"license":"MIT","_id":"@acpaas-ui-widgets/ngx-search@2.0.0","maintainers":[{"name":"lievenvg","email":"lievenvg@gmail.com"},{"name":"tomvandenbroeck","email":"tom.vandenbroeck@digipolis.be"},{"name":"trianglejuice","email":"trianglejuice@mac.com"},{"name":"jsebrech","email":"joeri@sebrechts.net"}],"homepage":"https://github.com/digipolisantwerp/search_widget_angular#readme","bugs":{"url":"https://github.com/digipolisantwerp/search_widget_angular/issues"},"dist":{"shasum":"0caffcd6f5438e22a4feea843da24545b6c143e3","tarball":"https://registry.npmjs.org/@acpaas-ui-widgets/ngx-search/-/ngx-search-2.0.0.tgz","fileCount":30,"integrity":"sha512-bJG3FvxWZ9WDIDwOuKZMwPY1RxHAcAPuhh+mwtN6KtaPeAZDQGwQrPqXxcVFQ7riRrTKFx7ki1dgtXgJNFWs3g==","signatures":[{"sig":"MEUCID3SKziWboljHIFdFCVwKQrQyPwuLMTmjcC1irCIL/QGAiEA2nlmjBWEJQEUC4zBIkvlY2d9x18Lh4WTnVU/5QggSjs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":269074,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb9qGMCRA9TVsSAnZWagAAVIIQAJuN/Lt7Iyf2rUVOxzHk\nWYSt8POykjiq08ZNKkkTOCI2lVjsEIM5OvRIaA8sEVid809XDOVuCQYA14AW\nlVhNUexO+IZ4h0JmuG0hYAcdfpJupIGxWbbdqq4h0C1zbZt8Zw8UT7Phz32V\nJKaDjma0J8lxsMDUG4Hgo7AC4M5xF1qV1ZRKy95JtiOhvvYIaXTCrKK4iNSx\n2Y1xGg/QAjKHYOgeiqFOU/77o8QpDN+iLrgQ/LQN5iS4KDj0QNvEkW3sd9FW\n3Otwop+Mgc1iCHtV+e/tn1J8DAXKFYhU33++NWpuF+rTuDLmLll4iMzIT+0a\nxzVzIVEuRUwgYv00m6DM9JGEXZi09dSxFbD497c/yz1xKAZV4ZqKy6yhZMQX\n0qHKz0j10spmSGOOeENdx7YGI9LR8E1dc+Le3zDR3r69ypCFiG8M8g6qqSzX\nWTxLjn4vgTSZXYrVk/FSrcDn8L8UMALWrQjO2APQWGt1OntoR5Vg4YXw2p5d\njhox5oOJWFQrrAd/i9xZOgVpKgdNgEvAQlbgDz84YjKL8/Wjc+BmDwEOxjyM\nCF6twZtBrvplbQd/WJl8aZ46plHqUHMSvXwyLXWPDxEl9+Pz19kWn73BeBFi\nyC3FSMLhScwfFq+ociHGwAR07NdQ7oCq/eUCwSVYZWfbU5UgNpGIpKwKLE28\nTyqv\r\n=ByLT\r\n-----END PGP SIGNATURE-----\r\n"},"esm5":"esm5/acpaas-ui-widgets-ngx-search.js","main":"bundles/acpaas-ui-widgets-ngx-search.umd.js","fesm5":"fesm5/acpaas-ui-widgets-ngx-search.js","es2015":"fesm2015/acpaas-ui-widgets-ngx-search.js","module":"fesm5/acpaas-ui-widgets-ngx-search.js","esm2015":"esm2015/acpaas-ui-widgets-ngx-search.js","typings":"acpaas-ui-widgets-ngx-search.d.ts","_npmUser":{"name":"lievenvg","email":"lievenvg@gmail.com"},"fesm2015":"fesm2015/acpaas-ui-widgets-ngx-search.js","metadata":"acpaas-ui-widgets-ngx-search.metadata.json","repository":{"url":"git+https://github.com/digipolisantwerp/search_widget_angular.git","type":"git"},"_npmVersion":"6.4.1","description":"Search Smart Widget UI package (Angular)","directories":{},"sideEffects":false,"_nodeVersion":"8.9.4","dependencies":{"tslib":"^1.9.0"},"_hasShrinkwrap":false,"devDependencies":{"hoek":"^6.0.3","rxjs":"^6.3.3","karma":"~3.0.0","watch":"^1.0.2","rimraf":"^2.6.2","tslint":"~5.11.0","core-js":"^2.5.7","ts-node":"~7.0.0","tsickle":"~0.32.1","zone.js":"^0.8.26","codelyzer":"~4.4.4","karma-cli":"~1.0.1","@a-ui/core":"~3.0.3","ng-packagr":"~4.2.0","protractor":"~5.4.0","typescript":"~2.9.2","@types/node":"~8.9.4","rxjs-compat":"^6.3.3","@angular/cli":"^6.2.3","jasmine-core":"~2.99.1","@angular/core":"6.1.9","karma-jasmine":"~1.1.2","@angular/forms":"6.1.9","@types/jasmine":"~2.8.8","@angular/common":"6.1.9","@angular/router":"6.1.9","@angular/compiler":"6.1.9","@types/jasminewd2":"~2.0.4","@angular/animations":"6.1.9","@angular/compiler-cli":"6.1.9","jasmine-spec-reporter":"~4.2.1","karma-chrome-launcher":"~2.2.0","@acpaas-ui/ngx-components":"^1.0.5","@angular/language-service":"6.1.9","@angular/platform-browser":"6.1.9","karma-jasmine-html-reporter":"~0.2.2","@angular-devkit/build-angular":"~0.8.0","karma-coverage-istanbul-reporter":"~2.0.1","@angular/platform-browser-dynamic":"6.1.9"},"peerDependencies":{"@angular/core":"^6.0.0","@angular/forms":"^6.0.0","@angular/common":"^6.0.0","@acpaas-ui/ngx-components":"^1.0.5"},"_npmOperationalInternal":{"tmp":"tmp/ngx-search_2.0.0_1542889867726_0.5326993568732783","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-11-22T12:31:07.565Z","modified":"2025-12-08T09:56:35.902Z","2.0.0":"2018-11-22T12:31:07.863Z"},"bugs":{"url":"https://github.com/digipolisantwerp/search_widget_angular/issues"},"author":{"name":"Pieter-Jan Sas","email":"pieter-jan.sas@digipolis.be"},"license":"MIT","homepage":"https://github.com/digipolisantwerp/search_widget_angular#readme","keywords":["angular","library","search","typescript","angular-cli","ng-packagr"],"repository":{"url":"git+https://github.com/digipolisantwerp/search_widget_angular.git","type":"git"},"description":"Search Smart Widget UI package (Angular)","maintainers":[{"email":"trianglejuice@mac.com","name":"trianglejuice"},{"email":"lievenvg@gmail.com","name":"lievenvg"},{"email":"olivier@vademo.be","name":"vademo"},{"email":"nicolas@yapla.be","name":"yapla"},{"email":"npm@jan-bart.be","name":"jan-bart"}],"readme":"# Search Smart Widget UI (Angular)\n\nThis is the Angular 6+ UI for a Smart Widget implementing a search bar with suggestions. It is matched by a [corresponding back-end service](https://bitbucket.antwerpen.be/projects/ASA/repos/search_api_nodejs/browse) which is needed when running it in remote mode.\n\n\n\nThere is a demo app, see below for instructions on running it.\n\n## How to use\n\n### Installing\n\n```sh\n> npm install @acpaas-ui-widgets/ngx-search\n```\n\n### Using\n\nA BFF service should be running (see demo app instructions below for how to start one).\n\nImport the component in your module:\n\n```ts\n@NgModule({\n imports: [\n ...,\n SearchWidgetModule\n ],\n ...\n})\n```\n\nIn the index.html, include the core branding stylesheet:\n\n```html\n\n```\n\n> For projects that are still using Angular 5, we are [maintaining a v1 branch](https://github.com/digipolisantwerp/search_widget_angular/tree/v1), which will still receive bug fixes if needed.\n\n```sh\n> npm install @acpaas-ui-widgets/ngx-search@\"<2.0.0\"\n```\n\n### In your template:\n\n\n```html\n\n```\n\n(Replace the url of the BFF service.)\n\n### Supported attributes\n\n- **method**: POST or a GET method to get suggestions (default: GET)\n- **language**: Language of the query suggestions\n- **url**: (Api) Url to provide suggestions for a search\n- **placeholder**: Specify the text to show in an empty field (default: empty)\n- **searchValue**: The results comes in an array with type SearchWidgetValue\n- **suggestions**: The full results array of the remote suggestions (default: string[])\n- **searchIncentiveText**: The message shown when the user focuses on the input field\n- **minCharacters**: Minimal characters to search in the results (default: 2)\n- **noResultsText**: Text when the results are empty\n- **loadingText**: Text when loading the results\n- **label**: If SearchWidgetValue is an object add label to show\n- **query**: This is the value of the searchwidget\n- **limit**: Give a limit for suggestions per page\n- **iconLeft**: Change the location of searchbox (default: false)\n\n### Events\n\n- **search**: The event fired when the search is triggered\n\nThe backing service implements the following protocol:\n\n- POST /path/to/endpoint with raw body object:\n- **query**: the value of search\n- **language**: the language of the search\n\nExample: \n```json\n {\n \"query\":\"Aank\",\n \"language\":\"NL\" \n }\n```\n- suggestions = JSON-encoded array of [SearchWidgetValue](src/search-widget/search-widget.types.ts) objects\n\nCSS examples:\n\n```css\n/* Changing the color of the searchbox: */\n.aui-search .aui-search-icon{\n background-color: $green;\n} \n```\n\n## Run the demo app\n\n```sh\n> npm install\n> npm start\n```\n\nBrowse to [localhost:4200](http://localhost:4200)\n\nTo use the example app, you will need to have also started the [corresponding back-end service](https://bitbucket.antwerpen.be/projects/ASA/repos/search_api_nodejs/browse).\n\n## Contributing\n\nWe welcome your bug reports and pull requests.\n\nPlease see our [contribution guide](CONTRIBUTING.md).\n\n## License\n\nThis project is published under the [MIT license](LICENSE.md).\n","readmeFilename":"README.md"}