docs: added new advanced filtering text and images #473
Conversation
|
This pull request is being automatically deployed with ZEIT Now (learn more). 🔍 Inspect: https://zeit.co/carbon-design-system/carbon-website/51tn2tjcb |
|
@connor-leech @Solly2 is part of my wider team so I'd like to be included on the review of this if that's ok? |
|
I will also add to this that the integration dev team are building code for this :) |
|
Here is a link to the relevant component in our Storybook - https://pages.github.ibm.com/cloud-integration-design/ide-components/?path=/story/ide-filter-under-construction-%F0%9F%9A%A7--default-example |
There was a problem hiding this comment.
@connor-leech would this be better placed under an advanced filtering section in Experimental to start with?
Other than that I have no additional comments on this.
| <Row> | ||
| <Column colLg={8}> | ||
|
|
||
|  |
There was a problem hiding this comment.
Same note about alt text.
| <Row> | ||
| <Column colLg={8}> | ||
|
|
||
|  |
There was a problem hiding this comment.
Same note about alt text.
|
@connor-leech is there any progress on this PR? |
|
@vikkipaterson Waiting on Chris' review, but he's out of town until Monday |
|
@chrisconnors-ibm Any chance you can take a look at this this week? |
| @@ -69,6 +69,62 @@ Multiple category selection is most commonly manifested in either a vertical lis | |||
| </Column> | |||
| </Row> | |||
|
|
|||
| ### Advanced filtering | |||
There was a problem hiding this comment.
replace "Advanced filtering" with "Search with filters"
| @@ -69,6 +69,62 @@ Multiple category selection is most commonly manifested in either a vertical lis | |||
| </Column> | |||
| </Row> | |||
|
|
|||
| ### Advanced filtering | |||
|
|
|||
| _Advanced search_ can be used when the user requires to search and filter a list of items by choosing more than one filter from multiple filter categories. This pattern is especially useful when the number of items within each category is dynamic, such as filtering a table by a user or user defined tags. | |||
There was a problem hiding this comment.
replace with:
Search with filters provides users a method to constrain a long list of items by known metadata or dynamic metadata (such as tags) by choosing one or more filter items from multiple filter categories. It should be clear to the user is the filter represents an or relationship (either red cars or yellow cars) or an and relationship (red exterior and leather interior). Terms entered that are not filter choices are treated as search terms within the filtered items.
|
|
||
| _Advanced search_ can be used when the user requires to search and filter a list of items by choosing more than one filter from multiple filter categories. This pattern is especially useful when the number of items within each category is dynamic, such as filtering a table by a user or user defined tags. | ||
|
|
||
| Advanced search is also commonly used when there is not the requried amount of space on the screen to accommodate a vertical list. |
There was a problem hiding this comment.
replace:
"Filtered search is also recommended when there is not enough space to accommodate a vertical list of filters."
| <br /> | ||
| <br /> | ||
|
|
||
| The filtering categories appear as headers within a dropdown space underneath a search field, with the top five items from within each section appearing as defaults within this space, along with the expected number of returns if the user was to select that option. |
There was a problem hiding this comment.
what's the significance of the top 5?
There was a problem hiding this comment.
There is no real significance to the number of items shown, just aware that we need to give an example of the things you can filter by.
If there are a greater number of 'category' of filters then 5 would be quite cumbersome.
Perhaps we can simply change it to "with an example from each section appearing as defaults within this space"
| <br /> | ||
| <br /> | ||
|
|
||
| Entering a search term which exactly matches an item within a drop down enters that filter into the search field as a tag with the appropriate label attached. Alternatively a user can select that item directly from the drop down by clicking on it. If the term entered into the search field doesn't match any values within the filter categories then that term is entered as a free text search. |
There was a problem hiding this comment.
replace with:
Entering a search term which exactly matches an item within a drop down enters that filter into the search field as a tag with the appropriate label attached; a user may also select that item directly from the drop down by clicking on it. If the term entered into the search field doesn't match any values within the filter categories, that term is entered as a free text search, not in a tag.
| <Row> | ||
| <Column colLg={8}> | ||
|
|
||
|  |
There was a problem hiding this comment.
the free text search term should not be in a tag.
|
@connor-leech are you waiting on something from our end on this? |
|
I've made the changes as Chris requested, for some reason the build failed though... All there was were text changes so should be finbe. There is a bit of an unanswered question around what should populate the drop down though... |
|
As all existing production patterns must be reworked and revisited, closing this PR and incorporating relevant content into a new doc. Please continue any discussion here: #712 |
Added new wording and text to the filtering pattern.
This adds the "advanced filtering" section as an extension on the filtering pattern.