paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 31 Packages Projects Releases Wiki Activity
Files
41ced545f38eaa9bca1745bc4ea8c1924798eb1b
backstage/plugins/search/CHANGELOG.md
T
github-actions[bot] 3d68c45ef7 Version Packages
2021-12-23 12:23:34 +00:00

18 KiB
Raw Blame History

@backstage/plugin-search

0.5.2

Patch Changes

  • 3d98955c8a: Add Optional Props to Override Icon for SidebarSearch and SidebarSearchModal Component

  • 49a696d720: Standardizes the component used as a search box in the search modal and in the composable home page.

    After these changes, all search boxes exported by the search plugin are based on the <SearchBarBase /> component, and this one is based on the <InputBase /> component of the Material UI. This means that when you use SearchBarBase or one of its derived components (like SearchBar and HomePageSearchBar) you can pass all properties accepted by InputBase that have not been replaced by the props type of those components.

    For example:

    <SearchInputBase color="secondary" debouceTime={500} />

    The color property is inherited from InputBaseProps type and debouceTime defined by SearchBarBaseProps.

  • 7a4bd2ceac: Prefer using Link from @backstage/core-components rather than material-UI.

  • Updated dependencies

    • @backstage/core-plugin-api@0.4.0
    • @backstage/plugin-catalog-react@0.6.8
    • @backstage/core-components@0.8.2

0.5.1

Patch Changes

  • cd450844f6: Moved React dependencies to peerDependencies and allow both React v16 and v17 to be used.
  • 382e3a94b3: Export SearchApi interface from plugin
  • Updated dependencies
    • @backstage/core-components@0.8.0
    • @backstage/core-plugin-api@0.3.0
    • @backstage/plugin-catalog-react@0.6.5

0.5.0

Minor Changes

  • c5b6045f36: Search Modal now relies on the Search Context to access state and state setter. If you use the SidebarSearchModal as described in the getting started documentation, make sure to update your code with the SearchContextProvider.

    export const Root = ({ children }: PropsWithChildren<{}>) => (
  <SidebarPage>
    <Sidebar>
      <SidebarLogo />
-     <SidebarSearchModal />
+     <SearchContextProvider>
+       <SidebarSearchModal />
+     </SearchContextProvider>
      <SidebarDivider />
    ...

Patch Changes

  • f06ecd09a7: Add optional icon and secondaryAction properties for DefaultResultListItem component
  • c5941d5c30: Add a new optional clearButton property to the SearchBar component. The default value for this new property is true.
  • Updated dependencies
    • @backstage/core-components@0.7.6
    • @backstage/theme@0.2.14
    • @backstage/core-plugin-api@0.2.2

0.4.18

Patch Changes

  • a125278b81: Refactor out the deprecated path and icon from RouteRefs
  • 704b267e1c: Smaller UX improvements to search components such as optional autoFocus prop to SearchBar components, decreased debounce value and closing modal on link click of SearchModal, terminology updates of SearchResultPager.
  • Updated dependencies
    • @backstage/catalog-model@0.9.7
    • @backstage/plugin-catalog-react@0.6.4
    • @backstage/core-components@0.7.4
    • @backstage/core-plugin-api@0.2.0

0.4.17

Patch Changes

  • 5dcea2586c: Added SearchModal component.

    Now you can import SearchModal in your apps:

    import { SearchModal } from '@backstage/plugin-search';

    You can also use the SidebarSearchModal component to integrate it into the sidebar of your sample apps:

    import { SidebarSearchModal } from '@backstage/plugin-search';

  • Updated dependencies

    • @backstage/core-components@0.7.3
    • @backstage/theme@0.2.13
    • @backstage/core-plugin-api@0.1.13
    • @backstage/plugin-catalog-react@0.6.3

0.4.16

Patch Changes

  • 10615525f3: Switch to use the json and observable types from @backstage/types
  • Updated dependencies
    • @backstage/config@0.1.11
    • @backstage/theme@0.2.12
    • @backstage/errors@0.1.4
    • @backstage/core-components@0.7.2
    • @backstage/plugin-catalog-react@0.6.2
    • @backstage/catalog-model@0.9.6
    • @backstage/search-common@0.2.1
    • @backstage/core-plugin-api@0.1.12

0.4.15

Patch Changes

  • 56bd537256: SearchBar component to accept optional placeholder prop
  • Updated dependencies
    • @backstage/plugin-catalog-react@0.6.0
    • @backstage/core-components@0.7.0
    • @backstage/theme@0.2.11

0.4.14

Patch Changes

  • ca0559444c: Avoid usage of .to*Case(), preferring .toLocale*Case('en-US') instead.
  • 81a41ec249: Added a name key to all extensions in order to improve Analytics API metadata.
  • Updated dependencies
    • @backstage/core-components@0.6.1
    • @backstage/core-plugin-api@0.1.10
    • @backstage/plugin-catalog-react@0.5.2
    • @backstage/catalog-model@0.9.4

0.4.13

Patch Changes

  • Updated dependencies
    • @backstage/core-plugin-api@0.1.9
    • @backstage/core-components@0.6.0
    • @backstage/plugin-catalog-react@0.5.1

0.4.12

Patch Changes

  • Updated dependencies
    • @backstage/core-components@0.5.0
    • @backstage/plugin-catalog-react@0.5.0
    • @backstage/catalog-model@0.9.3
    • @backstage/config@0.1.10

0.4.11

Patch Changes

  • 9f1362dcc1: Upgrade @material-ui/lab to 4.0.0-alpha.57.
  • Updated dependencies
    • @backstage/core-components@0.4.2
    • @backstage/plugin-catalog-react@0.4.6
    • @backstage/core-plugin-api@0.1.8

0.4.10

Patch Changes

  • 7f00902d9: Add Home Page Search Bar Component, to be included in composable Home Page.
  • Updated dependencies
    • @backstage/core-components@0.4.1
    • @backstage/catalog-model@0.9.2
    • @backstage/errors@0.1.2
    • @backstage/config@0.1.9
    • @backstage/core-plugin-api@0.1.7

0.4.9

Patch Changes

  • a13f21cdc: Implement optional pageCursor based paging in search.

    To use paging in your app, add a <SearchResultPager /> to your SearchPage.tsx.

  • Updated dependencies

    • @backstage/plugin-catalog-react@0.4.5
    • @backstage/core-components@0.4.0
    • @backstage/search-common@0.2.0
    • @backstage/catalog-model@0.9.1

0.4.8

Patch Changes

  • 16ec8381a: Fix search page to respond to searches made from sidebar search
  • Updated dependencies
    • @backstage/plugin-catalog-react@0.4.4
    • @backstage/core-components@0.3.3
    • @backstage/config@0.1.8

0.4.7

Patch Changes

  • 56c773909: Switched @types/react dependency to request * rather than a specific version.
  • Updated dependencies
    • @backstage/core-components@0.3.1
    • @backstage/core-plugin-api@0.1.6
    • @backstage/plugin-catalog-react@0.4.2

0.4.6

Patch Changes

  • b917365cf: Change <SearchType> design to follow Figma and be similar to existing multi selects in Backstage.
  • Updated dependencies
    • @backstage/core-components@0.3.0
    • @backstage/config@0.1.6
    • @backstage/core-plugin-api@0.1.5
    • @backstage/search-common@0.1.3
    • @backstage/plugin-catalog-react@0.4.1

0.4.5

Patch Changes

  • 9d40fcb1e: - Bumping material-ui/core version to at least 4.12.2 as they made some breaking changes in later versions which broke Pagination of the Table.
    • Switching out material-table to @material-table/core for support for the later versions of material-ui/core
    • This causes a minor API change to @backstage/core-components as the interface for Table re-exports the prop from the underlying Table components.
    • onChangeRowsPerPage has been renamed to onRowsPerPageChange
    • onChangePage has been renamed to onPageChange
    • Migration guide is here: https://material-table-core.com/docs/breaking-changes
  • Updated dependencies
    • @backstage/core-components@0.2.0
    • @backstage/plugin-catalog-react@0.4.0
    • @backstage/core-plugin-api@0.1.4
    • @backstage/theme@0.2.9

0.4.4

Patch Changes

  • 9266b80ab: Adding a type filter to new search
  • Updated dependencies
    • @backstage/core-components@0.1.6
    • @backstage/plugin-catalog-react@0.3.1

0.4.3

Patch Changes

  • 078d4973e: Handle request errors properly and display them in the results list.
  • Updated dependencies
    • @backstage/plugin-catalog-react@0.3.0

0.4.2

Patch Changes

  • Updated dependencies
    • @backstage/core-components@0.1.5
    • @backstage/catalog-model@0.9.0
    • @backstage/plugin-catalog-react@0.2.6

0.4.1

Patch Changes

  • df51a5507: Fix empty state not being displayed on missing results.
  • d5db15efb: Use the identityApi to forward authorization headers to the search-backend
  • 48c9fcd33: Migrated to use the new @backstage/core-* packages rather than @backstage/core.
  • Updated dependencies
    • @backstage/core-plugin-api@0.1.3
    • @backstage/catalog-model@0.8.4
    • @backstage/plugin-catalog-react@0.2.4

0.4.0

Minor Changes

  • 5aff84759: This release represents a move out of a pre-alpha phase of the Backstage Search plugin, into an alpha phase. With this release, you gain more control over the layout of your search page on the frontend, as well as the ability to extend search on the backend to encompass everything Backstage users may want to find.

    If you are updating to this version of @backstage/plugin-search from a prior release, you will need to make the following modifications to your App:

    In your app package, create a new searchPage component at, for example, packages/app/src/components/search/SearchPage.tsx with contents like the following:

    import React from 'react';
import { makeStyles, Theme, Grid, List, Paper } from '@material-ui/core';

import { Content, Header, Lifecycle, Page } from '@backstage/core';
import { CatalogResultListItem } from '@backstage/plugin-catalog';
import {
  SearchBar,
  SearchFilter,
  SearchResult,
  DefaultResultListItem,
} from '@backstage/plugin-search';

const useStyles = makeStyles((theme: Theme) => ({
  bar: {
    padding: theme.spacing(1, 0),
  },
  filters: {
    padding: theme.spacing(2),
  },
  filter: {
    '& + &': {
      marginTop: theme.spacing(2.5),
    },
  },
}));

const SearchPage = () => {
  const classes = useStyles();

  return (
    <Page themeId="home">
      <Header title="Search" subtitle={<Lifecycle alpha />} />
      <Content>
        <Grid container direction="row">
          <Grid item xs={12}>
            <Paper className={classes.bar}>
              <SearchBar debounceTime={100} />
            </Paper>
          </Grid>
          <Grid item xs={3}>
            <Paper className={classes.filters}>
              <SearchFilter.Select
                className={classes.filter}
                name="kind"
                values={['Component', 'Template']}
              />
              <SearchFilter.Checkbox
                className={classes.filter}
                name="lifecycle"
                values={['experimental', 'production']}
              />
            </Paper>
          </Grid>
          <Grid item xs={9}>
            <SearchResult>
              {({ results }) => (
                <List>
                  {results.map(({ type, document }) => {
                    switch (type) {
                      case 'software-catalog':
                        return (
                          <CatalogResultListItem
                            key={document.location}
                            result={document}
                          />
                        );
                      default:
                        return (
                          <DefaultResultListItem
                            key={document.location}
                            result={document}
                          />
                        );
                    }
                  })}
                </List>
              )}
            </SearchResult>
          </Grid>
        </Grid>
      </Content>
    </Page>
  );
};

export const searchPage = <SearchPage />;

    Then in App.tsx, import this new searchPage component, and set it as a child of the existing <SearchPage /> route so that it looks like this:

    import { searchPage } from './components/search/SearchPage';
// ...
<Route path="/search" element={<SearchPage />}>
  {searchPage}
</Route>;

    You will also need to update your backend. For details, check the changeset for v0.2.0 of @backstage/plugin-search-backend.

Patch Changes

  • db1c8f93b: The `<Search...Next /> set of components exported by the Search Plugin are now updated to use the Search Backend API. These will be made available as the default non-"next" versions in a follow-up release.

    The interfaces for decorators and collators in the Search Backend have also seen minor, breaking revisions ahead of a general release. If you happen to be building on top of these interfaces, check and update your implementations accordingly. The APIs will be considered more stable in a follow-up release.

  • Updated dependencies [27a9b503a]

  • Updated dependencies [7028ee1ca]

  • Updated dependencies [db1c8f93b]

    • @backstage/catalog-model@0.8.2
    • @backstage/plugin-catalog-react@0.2.2
    • @backstage/search-common@0.1.2

0.3.7

Patch Changes

  • Updated dependencies [add62a455]
  • Updated dependencies [cc592248b]
  • Updated dependencies [17c497b81]
  • Updated dependencies [704875e26]
    • @backstage/catalog-model@0.8.0
    • @backstage/core@0.7.11
    • @backstage/plugin-catalog-react@0.2.0

0.3.6

Patch Changes

  • 062bbf90f: chore: bump @testing-library/user-event from 12.8.3 to 13.1.8
  • 675a569a9: chore: bump react-use dependency in all packages
  • Updated dependencies [062bbf90f]
  • Updated dependencies [10c008a3a]
  • Updated dependencies [889d89b6e]
  • Updated dependencies [16be1d093]
  • Updated dependencies [3f988cb63]
  • Updated dependencies [675a569a9]
    • @backstage/core@0.7.9
    • @backstage/plugin-catalog-react@0.1.6
    • @backstage/catalog-model@0.7.9

0.3.5

Patch Changes

0.3.4

Patch Changes

  • 9ca0e4009: use local version of lowerCase and upperCase methods
  • Updated dependencies [8686eb38c]
  • Updated dependencies [9ca0e4009]
  • Updated dependencies [34ff49b0f]
    • @backstage/core@0.7.2
    • @backstage/plugin-catalog-react@0.1.2

0.3.3

Patch Changes

0.3.2

Patch Changes

0.3.1

Patch Changes

0.3.0

Minor Changes

  • b3f0c3811: Migrated to new composability API, exporting the plugin instance as searchPlugin, and page as SearchPage. Due to the old router component also being called SearchPage, this is a breaking change. The old page component is now exported as Router, which can be used to maintain the old behavior.

Patch Changes

  • Updated dependencies [19d354c78]
  • Updated dependencies [b51ee6ece]
    • @backstage/plugin-catalog-react@0.0.3
    • @backstage/core@0.6.1

0.2.7

Patch Changes

  • 019fe39a0: Switch dependency from @backstage/plugin-catalog to @backstage/plugin-catalog-react.
  • Updated dependencies [12ece98cd]
  • Updated dependencies [d82246867]
  • Updated dependencies [7fc89bae2]
  • Updated dependencies [c810082ae]
  • Updated dependencies [5fa3bdb55]
  • Updated dependencies [6e612ce25]
  • Updated dependencies [025e122c3]
  • Updated dependencies [21e624ba9]
  • Updated dependencies [da9f53c60]
  • Updated dependencies [32c95605f]
  • Updated dependencies [7881f2117]
  • Updated dependencies [54c7d02f7]
  • Updated dependencies [11cb5ef94]
    • @backstage/core@0.6.0
    • @backstage/plugin-catalog-react@0.0.2
    • @backstage/theme@0.2.3
    • @backstage/catalog-model@0.7.1

0.2.6

Patch Changes

  • Updated dependencies [def2307f3]
  • Updated dependencies [efd6ef753]
  • Updated dependencies [593632f07]
  • Updated dependencies [33846acfc]
  • Updated dependencies [a187b8ad0]
  • Updated dependencies [f04db53d7]
  • Updated dependencies [a93f42213]
    • @backstage/catalog-model@0.7.0
    • @backstage/core@0.5.0
    • @backstage/plugin-catalog@0.2.12

0.2.5

Patch Changes

  • 01707438b: Fix Material-UI warning for search filtering
  • Updated dependencies [9c09a364f]
    • @backstage/plugin-catalog@0.2.10

0.2.4

Patch Changes

  • Updated dependencies [c911061b7]
  • Updated dependencies [8ef71ed32]
  • Updated dependencies [0e6298f7e]
  • Updated dependencies [ac3560b42]
    • @backstage/catalog-model@0.6.0
    • @backstage/core@0.4.1
    • @backstage/plugin-catalog@0.2.7

0.2.3

Patch Changes

  • 6a0d7a9fb: change default size for pageSize in search result view
  • Updated dependencies [2527628e1]
  • Updated dependencies [6011b7d3e]
  • Updated dependencies [1c69d4716]
  • Updated dependencies [83b6e0c1f]
  • Updated dependencies [1665ae8bb]
  • Updated dependencies [04f26f88d]
  • Updated dependencies [ff243ce96]
    • @backstage/core@0.4.0
    • @backstage/plugin-catalog@0.2.6
    • @backstage/catalog-model@0.5.0
    • @backstage/theme@0.2.2

0.2.2

Patch Changes

  • Updated dependencies [08835a61d]
  • Updated dependencies [a9fd599f7]
  • Updated dependencies [bcc211a08]
  • Updated dependencies [ebf37bbae]
    • @backstage/catalog-model@0.4.0
    • @backstage/plugin-catalog@0.2.5

0.2.1

Patch Changes

  • 475fc0aaa: Using the search field in the sidebar now navigates to the search result page.
  • Updated dependencies [475fc0aaa]
  • Updated dependencies [1166fcc36]
  • Updated dependencies [1185919f3]
    • @backstage/core@0.3.2
    • @backstage/catalog-model@0.3.0
    • @backstage/plugin-catalog@0.2.3
Reference in New Issue View Git Blame Copy Permalink