fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
90 lines
4.6 KiB
Plaintext
90 lines
4.6 KiB
Plaintext
---
|
||
sidebar_position: 2
|
||
description: 'Learn how to use utility features in the Medusa Admin including lists, quick and advanced filters, pagination, and search functionalities. You can also customize quick features.'
|
||
---
|
||
|
||
import UiIcon from '@site/src/components/UiIcon';
|
||
|
||
# Lists Overview
|
||
|
||
In this document, you’ll get an overview of lists in Medusa including filters, searching, and more!
|
||
|
||
## Filter Items
|
||
|
||
You can use filters to retrieve only items in a list matching specific criteria.
|
||
|
||
### Quick Filters
|
||
|
||
On a table with a list of items, you’ll find quick filters at the top of the list.
|
||
|
||
You can click on one of these filters to quickly apply it to the list of items.
|
||
|
||
|
||
|
||
### Advanced Filters
|
||
|
||
You can use advanced filters to furthermore limit the items shown based on specific criteria. For example, on the Orders list, you can filter orders to only show pending orders created in a specific region.
|
||
|
||
To use advanced filters:
|
||
|
||
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon next to Filters. This will toggle a dropdown with categories for different fields.
|
||
2. You can click on a field name to expand it and choose a filter for that field.
|
||
3. Click on the Apply button at the top of the dropdown.
|
||
|
||
This will retrieve the items based on the filters you’ve selected.
|
||
|
||
|
||
|
||
### Save Advanced Filters as Quick Filters
|
||
|
||
If there are filters that you need to use frequently, you can give the set of filters a name and save them to be used later. For example, you can save the filters used in the previous example as “European Orders”.
|
||
|
||
To save an advanced filter:
|
||
|
||
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon next to Filters.
|
||
2. Choose your filters from the dropdown.
|
||
3. Choose a name for the filters in the input at the end of the dropdown.
|
||
4. Click the Save button.
|
||
|
||
|
||
|
||
Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the list.
|
||
|
||
|
||
|
||
To apply a saved quick filter, just click on it.
|
||
|
||
### Delete Saved Quick Filters
|
||
|
||
You can delete any saved filter you’ve created. To do that, simply click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon next to the quick filter’s name, and it will be deleted.
|
||
|
||
### Clear Filters
|
||
|
||
To clear all applied filters:
|
||
|
||
1. Click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.png" alt="plus" /> icon next to Filters.
|
||
2. Click on the Clear button.
|
||
|
||
|
||
|
||
:::info
|
||
|
||
Clearing filters does not delete saved quick filters. You can still apply them by clicking on them.
|
||
|
||
:::
|
||
|
||
---
|
||
|
||
## Search Items
|
||
|
||
You can search for items in a list by clicking the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999227/Medusa%20Docs/UI%20Icons/k0U0wpO_pizpfd.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999249/Medusa%20Docs/UI%20Icons/IdKjFak_ultvmh.png" alt="magnifier" /> icon at the top right of the list.
|
||
|
||
|
||
|
||
---
|
||
|
||
## Multiple Pages
|
||
|
||
Lists in the Medusa admin can span across multiple pages if the number of items in that list are more than 15.
|
||
|
||
In that case, you can navigate between pages by clicking the arrows at the bottom of the list. |