Skip to content

Add text-based filter in members page for Member names #1427

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 6 commits into from
Sep 6, 2023
Merged

Add text-based filter in members page for Member names #1427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1cfca44
Add text-based filter in members page for Member names
peoray Sep 5, 2023
88b17d6
Merge branch 'main' into member-name-filter-list
peoray Sep 5, 2023
1b520cb
Change memberName to displayName to align with API property
peoray Sep 5, 2023
7caed9f
Merge branch 'main' into member-name-filter-list
peoray Sep 5, 2023
6ba791d
Fix member name filter include option
peoray Sep 6, 2023
ecf744a
Merge branch 'main' into member-name-filter-list
peoray Sep 6, 2023
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
2 changes: 2 additions & 0 deletions frontend/src/modules/member/config/filters/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ import joinedDate from './joinedDate/config';
import lastActivityDate from './lastActivityDate/config';
import reach from './reach/config';
import tags from './tags/config';
import memberName from './memberName/config';

export const memberFilters: Record<string, FilterConfig> = {
memberName,
noOfActivities,
noOfOSSContributions,
activeOn,
Expand Down
31 changes: 31 additions & 0 deletions frontend/src/modules/member/config/filters/memberName/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import { FilterConfigType } from '@/shared/modules/filters/types/FilterConfig';
import {
StringFilterConfig,
StringFilterOptions,
StringFilterValue,
} from '@/shared/modules/filters/types/filterTypes/StringFilterConfig';
import { itemLabelRendererByType } from '@/shared/modules/filters/config/itemLabelRendererByType';
import { apiFilterRendererByType } from '@/shared/modules/filters/config/apiFilterRendererByType';

const memberName: StringFilterConfig = {
id: 'memberName',
label: 'Member name',
iconClass: 'ri-account-circle-line',
type: FilterConfigType.STRING,
options: {},
itemLabelRenderer(
value: StringFilterValue,
options: StringFilterOptions,
): string {
return itemLabelRendererByType[FilterConfigType.STRING](
'Member name',
value,
options,
);
},
apiFilterRenderer(value: StringFilterValue): any[] {
return apiFilterRendererByType[FilterConfigType.STRING]('displayName', value);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also if you notice on string.label.renderer.ts file we do this:
const excludeText = !include ? ' (exclude)' : '';

And since we are not passing any include value, the filter is getting updated like this:
Screenshot 2023-09-06 at 13 56 40

Can you also update the following:

  1. On frontend/src/shared/modules/filters/types/filterTypes/StringFilterConfig.ts add include: boolean to StringFilterValue
  2. Then on frontend/src/shared/modules/filters/components/filterTypes/StringFilter.vue update defaultForm to
const defaultForm: StringFilterValue = {
  value: '',
  include: true,
  operator: FilterStringOperator.LIKE,
};

This won't render the Include Checkbox. It's just a fix to make sure that we don't render (exclude) when we are actually including.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alright, changes made :)

},
};

export default memberName;
1 change: 1 addition & 0 deletions frontend/src/shared/modules/filters/components/filterTypes/StringFilter.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ const form = computed<StringFilterValue>({

const defaultForm: StringFilterValue = {
value: '',
include: true,
operator: FilterStringOperator.LIKE,
};

Expand Down
1 change: 1 addition & 0 deletions frontend/src/shared/modules/filters/types/filterTypes/StringFilterConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export interface StringFilterOptions {}
export interface StringFilterValue {
operator: FilterStringOperator,
value: string,
include: boolean
}

export interface StringFilterConfig extends BaseFilterConfig {
Expand Down