# rr-api-explorer

> Angular project showcasing a public api explorer for the Retsrabbit API

Latest version **1.2.27** (published 2017-05-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install rr-api-explorer
pnpm add rr-api-explorer
yarn add rr-api-explorer
bun add rr-api-explorer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.27 |
| Published | 2017-05-02 |
| First published | 2016-09-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andrew Clinton |
| Maintainers | aclinton19 |

## Links

- npm: https://www.npmjs.com/package/rr-api-explorer
- npm.io page: https://npm.io/package/rr-api-explorer

## Dependencies (1)

- [rets-rabbit-angular](https://npm.io/package/rets-rabbit-angular.md) ^1.1.2

## Recent versions

- 1.2.27 (latest) — 2017-05-02
- 1.2.26 — 2017-05-02
- 1.2.25 — 2017-05-02
- 1.2.24 — 2017-05-02
- 1.2.23 — 2016-10-20
- 1.2.22 — 2016-10-20
- 1.2.21 — 2016-10-20
- 1.2.20 — 2016-10-20
- 1.2.19 — 2016-10-20
- 1.2.18 — 2016-10-20
- 1.2.17 — 2016-10-20
- 1.2.16 — 2016-10-20
- 1.2.15 — 2016-10-20
- 1.2.14 — 2016-10-20
- 1.2.13 — 2016-10-20
- … 18 more at https://npm.io/package/rr-api-explorer/versions

## README

# Rets-Rabbit-Api-Explorer
This is an angular module which acts as a drop in directive for an API explorer for Retsrabbit

##Installation
You can either clone/download this repo or install the package via bower.

```bash
$ bower install rr-api-explorer
```

##Usage
Make sure to import the module

```javascript
app.module('app', ['rr.api.v2.explorer']);

or

app.module('app', [require('rr.api.v2.explorer')];
```

This directive can either be used as an element or an attribute

```html
<api-explorer></api-explorer>
```

```html
<div api-explorer></div>
```

You may also pass in a search parameter which the directive will use to bind values to the search parameters. The parameter must match the following format where the key values follow the RESO spec. See the Rets Rabbit [docs](https://retsrabbit.com/docs) for help.

The directive will watch for changes on the query variable and update the explorer inputs if it detects a change.

```javascript
$scope.query = {
	select: 'ListingId, ListPrice, ListingContractDate',
    filter: [
        {value: 'year(ListingContractDate) eq 2016', join: 'and'},
        {value: 'month(ListingContractDate) eq 6', join: ''}
    ],
    orderby: [{value: 'ListPrice', direction: 'asc'}],
    top: '10',
    skip: '11'
};
```

```html
<api-explorer search="query"></api-explorer>
```

When a search is being performed, the directive will display a loading image/gif where the results are if you supply the loader parameter with a valid path.

```html
<api-explorer search="query" loader="'public/img/loader.gif'"></api-explorer>
```

###Customization
Currently there are no customization options. The directive is built with Bootstrap classes, so it will work best when that framework is present. In the future we hope to provide

1. Framework specific templating
2. Customization attributes

---
_Source: https://npm.io/package/rr-api-explorer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._