Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document search CT - INNO-1952 #1401

Merged
merged 2 commits into from Nov 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 0 additions & 6 deletions src/website/src/pages/ec/content-types/search/docs/usage.md

This file was deleted.

60 changes: 60 additions & 0 deletions src/website/src/pages/ec/content-types/search/docs/usage.mdx
@@ -0,0 +1,60 @@
---
title: Usage
order: 1
---

import { Paragraph, Anatomy } from '@ecl/website-components';

<Paragraph size="lead">
The search pool page is a content type used to display and refine content
associated with a particular search query through the use of filters.
</Paragraph>

## Anatomy

<Anatomy
image="https://inno-ecl.s3.amazonaws.com/media/images/EC/SearchPage/search-page.png"
alt="Anatomy of a search page"
legend={{
items: [
{
color: '#404040',
label: 'Mandatory',
},
{
color: '#004494',
label: 'Optional',
},
],
}}
/>

### Default

| Elements | Mandatory | Description |
| ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Filters | Yes | Filters are composed of input types (text field, checkbox, radio button, dropdown select, etc.) |
| List items | Yes | List items make up the results of any given search query |
| Pagination | Yes | The pagination component is used at the bottom of the list to indicate the number of pages, the current page and to allow users to navigate to the different pages |

### Conditional

| Elements | Mandatory | Description |
| -------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Tags | Yes | Tags represent the applied filters, through which the list items making up the results are being refined if a search query was performed |

## Do's

- Use the appropriate filters based on the users’ possible end goals (e.g. location filter for events, associated meta tags for content, file formats, etc.)

## Don'ts

- Don’t use without filters

## When to use

- Whenever you have an extensive list of items that can be curated through filters

## When not to use

- Do not use in conjunction with content - search pool page only displays list items