InstantSearch

By Algolia.

Warning

This repo is a WIP. Do not use it in production as the APIs can still change. Stay tuned for a beta release soon :)

Introduction

InstantSearch iOS is a library providing widgets and helpers to help you build the best instant-search experience on iOS with Algolia. It is built on top of Algolia's Swift API Client to provide you a high-level solution to quickly build various search interfaces. For

Usage

import InstantSearch

// Configure InstantSearch AppDelegate 
InstantSearch.reference.configure(appID: APP_ID, apiKey: API_KEY, index: INDEX)

// Declare your widgets (IB or programatically) in your ViewController
let searchBar = SearchBarWidget(frame: CGRect(...))
let statsWidget = StatsLabelWidget(frame: CGRect(...))
self.view.addSubview(searchBar)
self.view.addSubview(statsWidget)

// Add all widgets in view to InstantSearch in your ViewController
InstantSearch.reference.addAllWidgets(in: self.view)

// Run your app and write a query in the searchBar.

Demo

You can see InstantSearch iOS in action in our Examples repository, in which we published example apps built with InstantSearch and written in Swift:

Requirements

• iOS 9.0+
• Xcode 8.0+

Getting involved

• If you want to contribute please feel free to submit pull requests.
• If you have a feature request please open an issue.
• If you found a bug or need help please check older issues, FAQ and threads on StackOverflow (Tag 'Algolia') before submitting an issue..

Before contribute check the CONTRIBUTING file for more info.

If you use InstantSearch in your app, we would love to hear about it! Drop us a line on discourse or twitter.

Examples

Follow these 3 steps to run Example project: Clone InstantSearch repository, open InstantSearch workspace and run the Example project.

You can also experiment and learn with the InstantSearch Playground which is contained in InstantSearch.workspace.

Author

• Algolia (@algolia)

FAQ

Where can I search for general questions about Algolia?

You can search our FAQ in our website.

Change Log

This can be found in the CHANGELOG.md file.