Skip to content

Commit 2953025

Browse files
authored
docs(FilterGroupItem): improve description of required prop (#7373)
Related to #3573
1 parent 11a9897 commit 2953025

File tree

1 file changed

+6
-6
lines changed
  • packages/main/src/components/FilterGroupItem

1 file changed

+6
-6
lines changed

packages/main/src/components/FilterGroupItem/types.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ export interface FilterGroupItemPropTypes extends CommonProps {
55
/**
66
* The mandatory key each `FilterGroupItem` needs to implement.
77
*
8-
* __Note:__ `filterKey` needs to be unique for each `FilterGroupItem` per `FilterBar`.
9-
*
10-
* __Note:__ Whitespaces are not supported!
8+
* __Note:__
9+
* - `filterKey` needs to be unique for each `FilterGroupItem` per `FilterBar`.
10+
* - Whitespace characters are not supported.
1111
*/
1212
filterKey: string | number;
1313
/**
@@ -27,7 +27,6 @@ export interface FilterGroupItemPropTypes extends CommonProps {
2727
/**
2828
* Defines the group name of the filter.
2929
*
30-
*
3130
* @default "Basic"
3231
*/
3332
groupName?: string;
@@ -44,12 +43,13 @@ export interface FilterGroupItemPropTypes extends CommonProps {
4443
/**
4544
* Defines whether the filter is required.
4645
*
47-
* __Note:__ Required filters cannot be removed from the `FilterBar`.
46+
* __Note:__
47+
* - Required filters cannot be removed from the `FilterBar`.
48+
* - If `required` is set to `true`, the corresponding input component should also receive the `required` prop explicitly.
4849
*/
4950
required?: boolean;
5051
/**
5152
* Defines whether the filter is hidden.
52-
*
5353
*/
5454
hidden?: boolean;
5555
/**

0 commit comments

Comments
 (0)