Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.15 KB

README.md

File metadata and controls

36 lines (28 loc) · 1.15 KB
Raw

nyris-widget

Embed the widget to use nyris search on your website.

Usage

npm install @nyris/nyris-widget

Embed widget.js in your website and provide a nyrisSettings object.

<script>
window.nyrisSettings = {
    // Required
    apiKey: '<YOUR_API_KEY>',

    // Optional
    xOptions: 'default', // See "general request options" https://docs.nyris.io/#general-request-options
    baseUrl: '', // Use different server URL
    jpegQuality: 0.9, // Quality of the scaled image sent to the api
    maxWidth: 500, // Maximal size of the scaled image
    maxHeight: 500,
    responseFormat: 'application/offers.complete+json', // See "response type" https://docs.nyris.io/#response-type
    instantRedirectPatterns: [ 'mysite.com' ] // If exactly one result is returned and it contains `mysite.com`,go directly to the link.
}
</script>
<script src="node_modules/@nyris/nyris-widget/dist/widget.js"></script>

Building a custom version

Follow the steps on main README initialize all packages. Then in this directory, run npm start for a local development server or npm run build to build a minified widget.js.