From 13d8c6c94b49a8b366e0d170c8831f36c132e9c7 Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Fri, 10 Dec 2021 10:53:46 +0700 Subject: [PATCH 1/8] Export icon props in SidebarSearch component Signed-off-by: Dede Hamzah --- .../components/SidebarSearch/SidebarSearch.tsx | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/plugins/search/src/components/SidebarSearch/SidebarSearch.tsx b/plugins/search/src/components/SidebarSearch/SidebarSearch.tsx index 883829d44e..1060e7ad11 100644 --- a/plugins/search/src/components/SidebarSearch/SidebarSearch.tsx +++ b/plugins/search/src/components/SidebarSearch/SidebarSearch.tsx @@ -19,9 +19,13 @@ import { useNavigate } from 'react-router-dom'; import { rootRouteRef } from '../../plugin'; import { SidebarSearchField } from '@backstage/core-components'; -import { useRouteRef } from '@backstage/core-plugin-api'; +import { useRouteRef, IconComponent } from '@backstage/core-plugin-api'; -export const SidebarSearch = () => { +type SidebarSearchProps = { + icon?: IconComponent; +}; + +export const SidebarSearch = (props: SidebarSearchProps) => { const searchRoute = useRouteRef(rootRouteRef); const navigate = useNavigate(); const handleSearch = useCallback( @@ -33,5 +37,11 @@ export const SidebarSearch = () => { [navigate, searchRoute], ); - return ; + return ( + + ); }; From 3d98955c8a9bfc35ec340f70e1cda450e3b4596a Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Fri, 10 Dec 2021 11:00:01 +0700 Subject: [PATCH 2/8] Add changeset Signed-off-by: Dede Hamzah --- .changeset/afraid-carpets-know.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/afraid-carpets-know.md diff --git a/.changeset/afraid-carpets-know.md b/.changeset/afraid-carpets-know.md new file mode 100644 index 0000000000..141cf02d44 --- /dev/null +++ b/.changeset/afraid-carpets-know.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-search': patch +--- + +Added Overridable Icon for SidebarSearch Component From e30420a125005ff1ea8dbf3fc3fa4e4e851e8b90 Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Fri, 10 Dec 2021 13:38:58 +0700 Subject: [PATCH 3/8] Update changeset Signed-off-by: Dede Hamzah --- .changeset/afraid-carpets-know.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/afraid-carpets-know.md b/.changeset/afraid-carpets-know.md index 141cf02d44..131181ace6 100644 --- a/.changeset/afraid-carpets-know.md +++ b/.changeset/afraid-carpets-know.md @@ -2,4 +2,4 @@ '@backstage/plugin-search': patch --- -Added Overridable Icon for SidebarSearch Component +Add Optional Props to Override Icon for SidebarSearch Component From 71dc1bba1c0f50a561b06e78c10cfde01a4525eb Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Fri, 10 Dec 2021 17:36:17 +0700 Subject: [PATCH 4/8] export SidebarSearchProps Signed-off-by: Dede Hamzah --- plugins/search/api-report.md | 4 +++- plugins/search/src/components/SidebarSearch/SidebarSearch.tsx | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/plugins/search/api-report.md b/plugins/search/api-report.md index 3db26579e3..4141465766 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.md @@ -8,6 +8,7 @@ import { ApiRef } from '@backstage/core-plugin-api'; import { AsyncState } from 'react-use/lib/useAsync'; import { BackstagePlugin } from '@backstage/core-plugin-api'; +import { IconComponent } from '@backstage/core-plugin-api'; import { IndexableDocument } from '@backstage/search-common'; import { JsonObject } from '@backstage/types'; import { default as React_2 } from 'react'; @@ -210,10 +211,11 @@ export const SearchType: ({ defaultValue, }: SearchTypeProps) => JSX.Element; +// Warning: (ae-forgotten-export) The symbol "SidebarSearchProps" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "SidebarSearch" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const SidebarSearch: () => JSX.Element; +export const SidebarSearch: (props: SidebarSearchProps) => JSX.Element; // Warning: (ae-missing-release-tag) "SidebarSearchModal" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // diff --git a/plugins/search/src/components/SidebarSearch/SidebarSearch.tsx b/plugins/search/src/components/SidebarSearch/SidebarSearch.tsx index 1060e7ad11..9f6be2333f 100644 --- a/plugins/search/src/components/SidebarSearch/SidebarSearch.tsx +++ b/plugins/search/src/components/SidebarSearch/SidebarSearch.tsx @@ -21,7 +21,7 @@ import { rootRouteRef } from '../../plugin'; import { SidebarSearchField } from '@backstage/core-components'; import { useRouteRef, IconComponent } from '@backstage/core-plugin-api'; -type SidebarSearchProps = { +export type SidebarSearchProps = { icon?: IconComponent; }; From dd480029ecfcf0ad08b7949ed735f0e70842da7a Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Fri, 10 Dec 2021 17:55:18 +0700 Subject: [PATCH 5/8] Export icon props for SidebarSearchModal Component Signed-off-by: Dede Hamzah --- plugins/search/api-report.md | 5 ++++- .../SidebarSearchModal/SidebarSearchModal.tsx | 10 ++++++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/plugins/search/api-report.md b/plugins/search/api-report.md index 4141465766..151b160367 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.md @@ -217,10 +217,13 @@ export const SearchType: ({ // @public (undocumented) export const SidebarSearch: (props: SidebarSearchProps) => JSX.Element; +// Warning: (ae-forgotten-export) The symbol "SidebarSearchModalProps" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "SidebarSearchModal" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const SidebarSearchModal: () => JSX.Element; +export const SidebarSearchModal: ( + props: SidebarSearchModalProps, +) => JSX.Element; // Warning: (ae-forgotten-export) The symbol "SearchContextValue" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "useSearch" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/plugins/search/src/components/SidebarSearchModal/SidebarSearchModal.tsx b/plugins/search/src/components/SidebarSearchModal/SidebarSearchModal.tsx index ae38526c9d..b8f20de67d 100644 --- a/plugins/search/src/components/SidebarSearchModal/SidebarSearchModal.tsx +++ b/plugins/search/src/components/SidebarSearchModal/SidebarSearchModal.tsx @@ -16,17 +16,23 @@ import React from 'react'; import SearchIcon from '@material-ui/icons/Search'; import { SidebarItem } from '@backstage/core-components'; +import { IconComponent } from '@backstage/core-plugin-api'; import { SearchModal } from '../SearchModal'; import { useSearch } from '../SearchContext'; -export const SidebarSearchModal = () => { +export type SidebarSearchModalProps = { + icon?: IconComponent; +}; + +export const SidebarSearchModal = (props: SidebarSearchModalProps) => { const { open, toggleModal } = useSearch(); + const Icon = props.icon ? props.icon : SearchIcon; return ( <> From 5bfb6827523a20c75c65c1a5d439e8d6eaf46167 Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Fri, 10 Dec 2021 17:58:08 +0700 Subject: [PATCH 6/8] Update changeset Signed-off-by: Dede Hamzah --- .changeset/afraid-carpets-know.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/afraid-carpets-know.md b/.changeset/afraid-carpets-know.md index 131181ace6..94a5452606 100644 --- a/.changeset/afraid-carpets-know.md +++ b/.changeset/afraid-carpets-know.md @@ -2,4 +2,4 @@ '@backstage/plugin-search': patch --- -Add Optional Props to Override Icon for SidebarSearch Component +Add Optional Props to Override Icon for SidebarSearch and SidebarSearchModal Component From 8e9d7e92009fd69b96dfd5d6b9f0a6ac3ca49c76 Mon Sep 17 00:00:00 2001 From: Dede Hamzah Date: Thu, 16 Dec 2021 16:31:54 +0700 Subject: [PATCH 7/8] Exporting the type Signed-off-by: Dede Hamzah --- plugins/search/src/components/SidebarSearch/index.ts | 1 + plugins/search/src/components/SidebarSearchModal/index.ts | 1 + 2 files changed, 2 insertions(+) diff --git a/plugins/search/src/components/SidebarSearch/index.ts b/plugins/search/src/components/SidebarSearch/index.ts index 437234c5b4..1340bfaa9a 100644 --- a/plugins/search/src/components/SidebarSearch/index.ts +++ b/plugins/search/src/components/SidebarSearch/index.ts @@ -14,3 +14,4 @@ * limitations under the License. */ export { SidebarSearch } from './SidebarSearch'; +export type { SidebarSearchProps } from './SidebarSearch'; diff --git a/plugins/search/src/components/SidebarSearchModal/index.ts b/plugins/search/src/components/SidebarSearchModal/index.ts index 849180878d..f667f20da2 100644 --- a/plugins/search/src/components/SidebarSearchModal/index.ts +++ b/plugins/search/src/components/SidebarSearchModal/index.ts @@ -14,3 +14,4 @@ * limitations under the License. */ export { SidebarSearchModal } from './SidebarSearchModal'; +export type { SidebarSearchModalProps } from './SidebarSearchModal'; From 7eeb65fd77053fb2ce9dfa1df3bab426215bfc39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Mon, 20 Dec 2021 16:06:16 +0100 Subject: [PATCH 8/8] fix review comments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- plugins/search/api-report.md | 16 ++++++++++++++-- plugins/search/src/index.ts | 6 +++++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/plugins/search/api-report.md b/plugins/search/api-report.md index 151b160367..13a9b15ea1 100644 --- a/plugins/search/api-report.md +++ b/plugins/search/api-report.md @@ -211,13 +211,11 @@ export const SearchType: ({ defaultValue, }: SearchTypeProps) => JSX.Element; -// Warning: (ae-forgotten-export) The symbol "SidebarSearchProps" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "SidebarSearch" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) export const SidebarSearch: (props: SidebarSearchProps) => JSX.Element; -// Warning: (ae-forgotten-export) The symbol "SidebarSearchModalProps" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "SidebarSearchModal" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -225,6 +223,20 @@ export const SidebarSearchModal: ( props: SidebarSearchModalProps, ) => JSX.Element; +// Warning: (ae-missing-release-tag) "SidebarSearchModalProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type SidebarSearchModalProps = { + icon?: IconComponent; +}; + +// Warning: (ae-missing-release-tag) "SidebarSearchProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export type SidebarSearchProps = { + icon?: IconComponent; +}; + // Warning: (ae-forgotten-export) The symbol "SearchContextValue" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "useSearch" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // diff --git a/plugins/search/src/index.ts b/plugins/search/src/index.ts index f5c58450fc..bfc9c52b74 100644 --- a/plugins/search/src/index.ts +++ b/plugins/search/src/index.ts @@ -36,7 +36,11 @@ export { SidebarSearch, useSearch, } from './components'; -export type { SearchModalProps } from './components'; +export type { + SearchModalProps, + SidebarSearchModalProps, + SidebarSearchProps, +} from './components'; export type { FiltersState } from './components'; export { DefaultResultListItem,