Skip to content

Commit

Permalink
docs(Results): update for index
Browse files Browse the repository at this point in the history
  • Loading branch information
@Haroenv
Haroenv committed Jan 24, 2018
1 parent 16c2c64 commit c0dacfa
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/src/components/results.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,27 +42,27 @@ Render results in a table:
</table>
</ais-results>
```

**Hint:** In this case, you actually need to use a [special Vue `inline-template` attribute](https://vuejs.org/v2/guide/components.html#Inline-Templates).
This will totally replace the existing default template and give you access to the `Results` component instance.

## Props

| Name | Type | Default | Description |
|------------------|---------|---------|--------------------------------------------------------------------------------|
| stack | Boolean | `false` | If true, will append results of next page to current results when page changes |
| results-per-page | Number | `` | The number of results to display |

| Name | Type | Default | Description |
| ---------------- | ------- | ------------------------------------- | ------------------------------------------------------------------------------ |
| stack | Boolean | `false` | If true, will append results of next page to current results when page changes |
| results-per-page | Number | `` | The number of results to display |

## Slots

| Name | Props | Default | Description |
|---------|--------|-------------------------------------------------------------------------------------------------|-----------------|
| default | result | Displays the objectID | First page text |
| header | | Add content to the top of the component, which will be hidden when the component is hidden | |
| footer | | Add content to the bottom of the component, which will be hidden when the component is hidden | |
| Name | Props | Default | Description |
| ------- | ------------- | --------------------------------------------------------------------------------------------- | --------------- |
| default | result, index | Displays the objectID | First page text |
| header | | Add content to the top of the component, which will be hidden when the component is hidden | |
| footer | | Add content to the bottom of the component, which will be hidden when the component is hidden | |

## CSS Classes

| ClassName | Description |
|---------------|-----------------|
| ------------- | --------------- |
| `ais-results` | Container class |

0 comments on commit c0dacfa

Please sign in to comment.