docs: update price list's user guide (#5323)
* docs: update price list's user guide * remove import links * hide import prices docs * add double quotes * fix build error * removed import prices section * remove text about import
This commit is contained in:
Shahed Nasser
GitHub
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"position": 2,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Tips",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
description: "Learn how to use the bulk editor in the Medusa admin and its shortcuts. The bulk editor is available in different areas, including the product details page and the Create Price List form."
|
||||
---
|
||||
|
||||
import getOsShortcut from '@site/src/utils/get-os-shortcut'
|
||||
|
||||
# Bulk Editor
|
||||
|
||||
In this document, you'll learn about different tips and shortcuts to using the bulk editor.
|
||||
|
||||
## Overview
|
||||
|
||||
The bulk editor allows you to edit prices or values using a spreadsheet-interface. It simplifies the editing process when working with a large number of data, and provides you with an intuitive user experience.
|
||||
|
||||
The bulk editor is used in different areas of the Medusa admin, including the [Edit Product Prices](../products/manage.mdx#edit-product-prices) form or the [Create Price List](../price-lists/manage.mdx#step-3-edit-prices) form.
|
||||
|
||||
---
|
||||
|
||||
## Toggle Columns View
|
||||
|
||||
As the bulk editor may include a large number of columns, such as the different currencies supported in your store, you can toggle the columns' visibility to focus on a subset of columns.
|
||||
|
||||
To do that:
|
||||
|
||||
1. Click on the "View" button at the top left.
|
||||
2. Check or uncheck a column by clicking on it in the dropdown.
|
||||
|
||||
---
|
||||
|
||||
## Selecting Cells
|
||||
|
||||
You can select multiple cells to apply an action on them. To do that:
|
||||
|
||||
1. Click and hold the mouse on a cell
|
||||
2. Drag the mouse in the direction of the other cells you want to select.
|
||||
3. Once you're done selecting, release the hold.
|
||||
|
||||
---
|
||||
|
||||
## Editing Cells
|
||||
|
||||
There are multiple ways you can edit cells in a bulk editor:
|
||||
|
||||
1. To edit the value without replacing the existing one, double-click the cell, then enter your new value.
|
||||
2. To edit the value by replacing the existing one, click on the cell and start typing your new value.
|
||||
3. To apply a value of a cell to other adjacent cells:
|
||||
1. Click on a cell
|
||||
2. Hold and Drag the blue dot at the corner of that cell to adjacent cells you want to apply the value to.
|
||||
3. Once you're done, release the hold on the blue dot.
|
||||
|
||||
---
|
||||
|
||||
## Shortcuts
|
||||
|
||||
You can use the following shortcuts while working with the bulk editor:
|
||||
|
||||
- <kbd>tab</kbd>: Persist the current cell's value and move focus to the next cell.
|
||||
- <kbd>backspace</kbd>: Delete the value of the selected cell(s).
|
||||
- <kbd children={getOsShortcut()}></kbd> + <kbd>Z</kbd>: Undo a change you made in the currently selected cell(s).
|
||||
@@ -0,0 +1,89 @@
|
||||
---
|
||||
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.
|
||||
Reference in New Issue
Block a user