Skip to content
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.

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

[navigation-next]feat: add description field in App. #7152

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 changelogs/fragments/7152.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
feat:
- Add description field in App. ([#7152](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/7152))
2 changes: 2 additions & 0 deletions src/core/public/application/application_service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ const createApp = (props: Partial<App>): App => {
return {
id: 'some-id',
title: 'some-title',
description: 'some-description',
mount: () => () => undefined,
...props,
};
Expand Down Expand Up @@ -153,6 +154,7 @@ describe('#setup()', () => {
id: 'app2',
navLinkStatus: AppNavLinkStatus.visible,
status: AppStatus.accessible,
description: 'some-description',
})
);
});
Expand Down
6 changes: 6 additions & 0 deletions src/core/public/application/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,12 @@ export interface App<HistoryLocationState = unknown> {
* indicating the application is available within or out of workspace.
*/
workspaceAvailability?: WorkspaceAvailability;

/**
* The description of the application.
* Will be displayed in landing page or getting started cards to give more information about the feature.
*/
description?: string;
}

/**
Expand Down
2 changes: 2 additions & 0 deletions src/core/public/chrome/nav_links/to_nav_link.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ describe('toNavLink', () => {
title: 'title',
order: 12,
tooltip: 'tooltip',
description: 'some-description',
euiIconType: 'my-icon' as EuiIconType,
}),
basePath
Expand All @@ -69,6 +70,7 @@ describe('toNavLink', () => {
order: 12,
tooltip: 'tooltip',
euiIconType: 'my-icon',
description: 'some-description',
})
);
});
Expand Down
Loading