ndla-audio-search
A simple library for selecting NDLA audio files.
Installation
$ npm install ndla-audio-search
Usage
Styling
/* Your project's main .scss import file */; // with webpack and sass-loader ; // direct reference
Get audio with the audio selector
To use the AudioSearch
component, some functions for handling search and fetching audios are needed. In addition, some translations are needed.
; const searchAudios = { // Return new Promise of audio objects}; const fetchAudio = { // Return new Promise of a single audio object}; const onError = { // Handle error}; const audioSelect = { // Handle audio selection}; const translations = searchPlaceholder: /* Translated string */ searchButtonTitle: /* Translated string */ useAudio: /* Translated string */ noResults: /* Translated string */; <AudioSearch translations=translations fetchAudio=fetchAudio searchAudios=searchAudios onAudioSelect=audioSelect onError=onError queryObject=defaultQueryObject/>
A queryObject
must look like this:
query: /* Query string */ page: /* Page number */ pageSize: /* Page size (elements per page) */ locale: /* The search language; usually provided by the front-end */