- Getting started
- Installation
- Available themes
- Browser support
- Implemented versions
- Contributing
- License
InstantSearch.css is a CSS library to style InstantSearch-powered search experiences.
Using InstantSearch.css is as simple as adding this CSS code to your existing InstantSearch app:
// Include only the reset
import 'instantsearch.css/themes/reset.css';
// Or include the full Satellite theme
import 'instantsearch.css/themes/satellite.css';To learn more about the library, follow the guide on how to style your InstantSearch widgets:
npm install instantsearch.css
# or
yarn add instantsearch.cssInstantSearch.css exposes two themes:
If you don't need a theme, you can still use the reset styles to start from a clean slate.
The reset styles are included in all the provided themes. You don't need to import them if you use a theme.
We support the last two versions of major browsers (Chrome, Edge, Firefox, Safari).
InstantSearch.css is a living standard. This table tracks down the version implemented in each InstantSearch flavor.
| Project | Version |
|---|---|
| InstantSearch.js | 7 |
| React InstantSearch | 7 |
| Vue InstantSearch | 7 |
| Angular InstantSearch | 7 |
We welcome all contributors, from casual to regular 💙
- Bug report. Is something not working as expected? Send a bug report.
- Feature request. Would you like to add something to the library? Send a feature request.
- Documentation. Did you find a typo in the doc? Open an issue and we'll take care of it.
- Development. If you don't know where to start, you can check the open issues that are tagged easy, the bugs or chores.
To start contributing to code, you need to:
- Fork the project
- Clone the repository
- Install the dependencies:
yarn
Please read our contribution process to learn more.
InstantSearch.css is MIT licensed.