Skip to content

feat: Add config to hide non-clickable badges #1943

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 4 commits into from
Aug 9, 2022
Merged

feat: Add config to hide non-clickable badges #1943

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c0db7a6
feat: Add config to hide non-clickable badges
ozandogrultan Jul 27, 2022
7a48728
feat: Add config to hide non-clickable badges
ozandogrultan Jul 27, 2022
dd41b6f
feat: Fix config-custom
ozandogrultan Jul 27, 2022
21ebca6
feat: Add frontend documentation
ozandogrultan Aug 9, 2022
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
8 changes: 6 additions & 2 deletions frontend/amundsen_application/static/js/components/Badges/BadgeList/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import * as React from 'react';

import { getBadgeConfig } from 'config/config-utils';
import { getBadgeConfig, hideNonClickableBadges } from 'config/config-utils';
import { BadgeStyle, BadgeStyleConfig } from 'config/config-types';

import { convertText, CaseType } from 'utils/textUtils';
Expand Down Expand Up @@ -82,7 +82,11 @@ export default class BadgeList extends React.Component<BadgeListProps> {
badgeConfig = getBadgeConfig(badge.badge_name);
}

if (badge.badge_name && badge.category === COLUMN_BADGE_CATEGORY) {
if (
badge.badge_name &&
badge.category === COLUMN_BADGE_CATEGORY &&
!hideNonClickableBadges()
) {
return (
<StaticBadge
style={badgeConfig.style}
Expand Down
1 change: 1 addition & 0 deletions frontend/amundsen_application/static/js/config/config-custom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const configCustom: AppConfigCustom = {
curatedTags: [],
showAllTags: true,
showBadgesInHome: true,
hideNonClickableBadges: false,
},
analytics: {
plugins: [],
Expand Down
1 change: 1 addition & 0 deletions frontend/amundsen_application/static/js/config/config-default.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const configDefault: AppConfig = {
curatedTags: [],
showAllTags: true,
showBadgesInHome: true,
hideNonClickableBadges: false,
},
date: {
default: 'MMM DD, YYYY',
Expand Down
3 changes: 3 additions & 0 deletions frontend/amundsen_application/static/js/config/config-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,14 @@ export interface AnalyticsConfig {
*
* curatedTags - An array of tags to show in a separate section at the top.
* showAllTags - Shows all tags when true, or only curated tags if false
* showBadgesInHome - Shows all badges in the homepage when true
* hideNonClickableBadges - Hides non-clickable badges in the homepage if true
*/
interface BrowseConfig {
curatedTags: Array<string>;
showAllTags: boolean;
showBadgesInHome: boolean;
hideNonClickableBadges: boolean;
}

/**
Expand Down
7 changes: 7 additions & 0 deletions frontend/amundsen_application/static/js/config/config-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,13 @@ export function getBadgeConfig(badgeName: string): BadgeStyleConfig {
};
}

/**
* Returns whether non-clickable badges should be hidden on the homepage
*/
export function hideNonClickableBadges(): boolean {
return AppConfig.browse.hideNonClickableBadges;
}

/**
* Returns whether or not feedback features should be enabled
*/
Expand Down
9 changes: 9 additions & 0 deletions frontend/amundsen_application/static/js/config/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,15 @@ describe('getCuratedTags', () => {
});
});

describe('hideNonClickableBadges', () => {
it('returns whether to hide non-clickable badges', () => {
AppConfig.browse.hideNonClickableBadges = true;
expect(ConfigUtils.hideNonClickableBadges()).toBe(
AppConfig.browse.hideNonClickableBadges
);
});
});

describe('exploreEnabled', () => {
it('returns whether the explore function is enabled', () => {
AppConfig.tableProfile.isExploreEnabled = true;
Expand Down