willypelz / wikimedia-search-component

Wikimedia JS Search component Library that interfaces with the Wikimedia API. client-side search library for JavaScript https://willypelz.github.io/wikimedia-search-component/

Wikimedia Js Search Component

Js Search enables efficient client-side searches of JavaScript. It is ES5 compatible and does not require jQuery or any other third-party libraries.

Implementation

You can implement this component by importing the wikimedia css into you application. Copy the wikimedia.css in the css folder of this project to the path of you application having;

    <link rel="stylesheet" href="./your-path/wikimedia.css">

Copy the wikimedia.js in the js folder of this project to the path of you application having;

For example, a simple use of JS Search would be as follows: Add script type module to allow import

<script type="module">
        import { wikiSearchComponent } from './your-path/wikimedia.js';
        wikiSearchComponent();
</script>

Copy this tag into you application where you want to put the search component

   <div class="search-container">
        <div id="search-result"></div>
    </div>

Installation for development

You can install using either Bower or NPM like so:

git clone https://github.com/willypelz/wikimedia-search-component.git
cd wikimedia-search-component
npm install 
bower install 

Running the application

   index.html