Skip to content

docs(FilterGroupItem): improve description of required prop #7373

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

Merged
merged 2 commits into from
May 22, 2025
Merged

docs(FilterGroupItem): improve description of required prop #7373

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14ed8fc
docs(FilterGroupItem): improve `required` description
Lukas742 May 22, 2025
b900e35
Update types.ts
Lukas742 May 22, 2025
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
12 changes: 6 additions & 6 deletions packages/main/src/components/FilterGroupItem/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ export interface FilterGroupItemPropTypes extends CommonProps {
/**
* The mandatory key each `FilterGroupItem` needs to implement.
*
* __Note:__ `filterKey` needs to be unique for each `FilterGroupItem` per `FilterBar`.
*
* __Note:__ Whitespaces are not supported!
* __Note:__
* - `filterKey` needs to be unique for each `FilterGroupItem` per `FilterBar`.
* - Whitespace characters are not supported.
*/
filterKey: string | number;
/**
Expand All @@ -27,7 +27,6 @@ export interface FilterGroupItemPropTypes extends CommonProps {
/**
* Defines the group name of the filter.
*
*
* @default "Basic"
*/
groupName?: string;
Expand All @@ -44,12 +43,13 @@ export interface FilterGroupItemPropTypes extends CommonProps {
/**
* Defines whether the filter is required.
*
* __Note:__ Required filters cannot be removed from the `FilterBar`.
* __Note:__
* - Required filters cannot be removed from the `FilterBar`.
* - If `required` is set to `true`, the corresponding input component should also receive the `required` prop explicitly.
*/
required?: boolean;
/**
* Defines whether the filter is hidden.
*
*/
hidden?: boolean;
/**
Expand Down
Loading