|
1 | 1 | --- |
2 | 2 | sidebar_position: 3 |
| 3 | +sidebar_label: "Lists" |
3 | 4 | --- |
4 | 5 |
|
5 | | -import { XMark } from "@medusajs/icons" |
| 6 | +import { BarsArrowDown } from "@medusajs/icons" |
6 | 7 |
|
7 | 8 | export const metadata = { |
8 | | - title: `Lists`, |
| 9 | + title: `Lists Tips`, |
9 | 10 | } |
10 | 11 |
|
11 | 12 | # {metadata.title} |
12 | 13 |
|
13 | | -In this document, you’ll get an overview of lists in Medusa including filters, searching, and more! |
| 14 | +In this guide, you’ll get an overview of lists in Medusa including filters, searching, and more. Each domain in the Medusa Admin, such as products or orders, has a list view displaying the items in that domain. Generally, you can apply advanced filters, search for items, and sort items. |
| 15 | + |
| 16 | + |
14 | 17 |
|
15 | 18 | ## Filter Items |
16 | 19 |
|
17 | 20 | Use filters to retrieve items in a list matching specific criteria. |
18 | 21 |
|
19 | | -{/* TODO check if the next section still applies */} |
20 | | - |
21 | | -{/* ### Quick Filters |
22 | | -
|
23 | | -On a table with a list of items, you’ll find quick filters at the top of the list. |
24 | | -
|
25 | | -You can click on one of these filters to quickly apply it to the list of items. |
26 | | -
|
27 | | - */} |
28 | | - |
29 | 22 | To do that: |
30 | 23 |
|
31 | 24 | 1. Click on the "Add filter" button at the top of the list. |
32 | | -2. From the dropdown, choose the criteria you want to filter. |
33 | | -3. This shows a new set of values to filter the list by. |
34 | | -4. After selecting the value, the list only includes the items matching your filters. You can also apply multiple filters. |
| 25 | +2. From the dropdown, choose the criteria you want to filter by, such as Tag. |
| 26 | +3. This shows a new set of values to filter the list by. Select the value(s) you want to filter by. |
35 | 27 |
|
36 | | - |
| 28 | +After selecting the value(s), the list only includes the items matching your filters. You can also apply multiple filters. |
37 | 29 |
|
38 | | -The filters you create are saved and are applied everytime you view the same list. |
| 30 | + |
39 | 31 |
|
40 | | -### Edit Saved Filters |
| 32 | +### Clear Filters |
41 | 33 |
|
42 | | -To edit a saved filter: |
| 34 | +To clear all applied filters, click on the "Clear all" link at the end of the list of filters. |
43 | 35 |
|
44 | | -1. Click on the filter. |
45 | | -2. Choose the new value of the filter. |
| 36 | +--- |
46 | 37 |
|
47 | | -### Delete Saved Filters |
| 38 | +## Search Items |
48 | 39 |
|
49 | | -To delete any saved filter you’ve created, click the <InlineIcon Icon={XMark} alt="X" /> icon next to the filter. |
| 40 | +To search for items in a list: |
50 | 41 |
|
51 | | -### Clear Filters |
| 42 | +1. Click the search input at the top right of the list. |
| 43 | +2. Enter your search term. The list is updated in real-time with items matching the search query. |
52 | 44 |
|
53 | | -To clear all applied filters, click on the "Clear all" link at the end of the list of filters. |
| 45 | + |
54 | 46 |
|
55 | 47 | --- |
56 | 48 |
|
57 | | -## Search Items |
| 49 | +## Sort Items |
58 | 50 |
|
59 | | -To search for items in a list: |
| 51 | +To configure the sorting of items in the list: |
| 52 | + |
| 53 | +1. Click on the <InlineIcon Icon={BarsArrowDown} alt="sort" /> button. |
| 54 | +2. Choose the field to filter by (for example, Created date) and the direction of filter (ascending or descending). |
60 | 55 |
|
61 | | -1. Click the search bar at the top right of the list. |
62 | | -2. Enter your search term. The list is updated in real-time. |
| 56 | +On clicking the new configuration, the list will be updated with the new sorting. |
63 | 57 |
|
64 | | - |
| 58 | + |
65 | 59 |
|
66 | 60 | --- |
67 | 61 |
|
68 | 62 | ## Multiple Pages |
69 | 63 |
|
70 | 64 | Lists in the Medusa Admin span across multiple pages if the number of items in that list are more than twenty. |
71 | 65 |
|
72 | | -Navigate between pages using the "Prev" and "Next" buttons at the bottom of the list. |
| 66 | +You can navigate between pages using the "Prev" and "Next" buttons at the bottom of the list. |
0 commit comments