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.

Sign up for GitHub

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

Jump to bottom

fix: Filters: Document requestFilterClearAll and requestFilterValueClear methods #4989

Merged
merged 1 commit into from
Sep 19, 2024
Merged

fix: Filters: Document requestFilterClearAll and requestFilterValueClear methods #4989

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions components/filter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ The `d2l-filter` component allows a user to filter on one or more dimensions of
</d2l-filter>
```

### Methods

- `requestFilterClearAll()`: use to clear all selected filter dimension set values within a filter as well as any performed search
- `requestFilterValueClear(keyObject)`: use to clear a specific filter value in a specific filter dimension. Expected input is the filter value's `keyObject` which contains both the `dimension` key and `value` key.

### Single Vs Multi Dimensional
A filter can be a single dimension (like picking from a list of courses) or offer multiple dimensions (filter by role, or department, or something else). Single-dimension filters can be used side-by-side to promote filters that are more commonly used, while tucking less-used filters into a multi-dimensional filter.

Expand Down
Loading