Skip to content

fix(compass-web): make banners dismissible COMPASS-8967 #6764

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 8 commits into from
Mar 7, 2025
Merged

fix(compass-web): make banners dismissible COMPASS-8967 #6764

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c3ae95e
two dismissible banners
djechlin-mongodb Mar 1, 2025
5481015
changes
djechlin-mongodb Mar 1, 2025
02578e8
use persisted storage
djechlin-mongodb Mar 5, 2025
4fba9f5
fix
djechlin-mongodb Mar 6, 2025
2508869
return <></>
djechlin-mongodb Mar 6, 2025
9f8953c
Update packages/compass-indexes/src/components/indexes/indexes.tsx
djechlin-mongodb Mar 6, 2025
b79864f
empty
djechlin-mongodb Mar 7, 2025
686f725
prettier
djechlin-mongodb Mar 7, 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
16 changes: 15 additions & 1 deletion packages/compass-indexes/src/components/indexes/indexes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
WorkspaceContainer,
css,
spacing,
usePersistedState,
} from '@mongodb-js/compass-components';

import IndexesToolbar from '../indexes-toolbar/indexes-toolbar';
Expand Down Expand Up @@ -49,13 +50,26 @@ const containerStyles = css({

const linkTitle = 'Atlas Search.';

const DISMISSED_SEARCH_INDEXES_BANNER_LOCAL_STORAGE_KEY =
'mongodb_compass_dismissedSearchIndexesBanner' as const;

const AtlasIndexesBanner = ({ namespace }: { namespace: string }) => {
const { atlasMetadata } = useConnectionInfo();
if (!atlasMetadata) {
return null;
}

const [dismissed, setDismissed] = usePersistedState(
DISMISSED_SEARCH_INDEXES_BANNER_LOCAL_STORAGE_KEY,
false
);

if (dismissed) {
return <></>;
}

return (
<Banner variant="info">
<Banner variant="info" dismissible onClose={() => setDismissed(true)}>
<Body weight="medium">Looking for search indexes?</Body>
These indexes can be created and viewed under{' '}
{atlasMetadata ? (
Expand Down
16 changes: 15 additions & 1 deletion packages/compass-schema/src/components/compass-schema.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import {
spacing,
useDarkMode,
WorkspaceContainer,
usePersistedState,
lighten,
Banner,
Body,
Expand Down Expand Up @@ -298,6 +299,9 @@ const AnalyzingScreen: React.FunctionComponent<{
);
};

const DISMISSED_SEARCH_INDEXES_BANNER_LOCAL_STORAGE_KEY =
'mongodb_compass_dismissedSearchIndexesBanner' as const;

const FieldList: React.FunctionComponent<{
schema: MongodbSchema | null;
analysisState: AnalysisState;
Expand Down Expand Up @@ -341,8 +345,18 @@ const title = 'Atlas’ Performance Advisor.';
const PerformanceAdvisorBanner = () => {
const connectionInfo = useConnectionInfo();
const track = useTelemetry();

const [dismissed, setDismissed] = usePersistedState(
DISMISSED_SEARCH_INDEXES_BANNER_LOCAL_STORAGE_KEY,
false
);

if (dismissed) {
return <></>;
}

return (
<Banner variant="info">
<Banner variant="info" dismissible onClose={() => setDismissed(true)}>
<Body weight="medium">Looking for schema anti-patterns?</Body>
In its place, you may refer to Data Explorer’s performance insights{' '}
<Badge className={insightsBadgeStyles} variant="blue">
Expand Down
Loading