@backstage/plugin-techdocs 0.12.0 → 0.12.4

package/CHANGELOG.md

@@ -1,5 +1,71 @@
 # @backstage/plugin-techdocs
 
+## 0.12.4
+
+### Patch Changes
+
+- a9a8c6f7c5: Reader will now scroll to the top of the page when navigating between pages
+- 106a5dc3ad: Restore original casing for `kind`, `namespace` and `name` in `DefaultTechDocsCollator`.
+- Updated dependencies
+  - @backstage/config@0.1.11
+  - @backstage/theme@0.2.12
+  - @backstage/errors@0.1.4
+  - @backstage/integration@0.6.9
+  - @backstage/core-components@0.7.2
+  - @backstage/integration-react@0.1.13
+  - @backstage/plugin-catalog-react@0.6.2
+  - @backstage/catalog-model@0.9.6
+  - @backstage/plugin-search@0.4.16
+  - @backstage/core-plugin-api@0.1.12
+
+## 0.12.3
+
+### Patch Changes
+
+- ba5b75ed2f: Add `<EntityListDocsGrid>` as an alternative to `<EntityListDocsTable>` that
+  shows a grid of card instead of table.
+
+  Extend `<DocsCardGrid>` to display the entity title of the entity instead of the
+  name if available.
+
+- 177401b571: Display entity title (if defined) in titles of TechDocs search results
+- cdf8ca6111: Only replace the shadow dom if the content is changed to avoid a flickering UI.
+- Updated dependencies
+  - @backstage/core-components@0.7.1
+  - @backstage/errors@0.1.3
+  - @backstage/core-plugin-api@0.1.11
+  - @backstage/plugin-catalog@0.7.2
+  - @backstage/plugin-catalog-react@0.6.1
+  - @backstage/catalog-model@0.9.5
+
+## 0.12.2
+
+### Patch Changes
+
+- 76fef740fe: Refactored `<Reader />` component internals to support future extensibility.
+- Updated dependencies
+  - @backstage/plugin-catalog-react@0.6.0
+  - @backstage/plugin-catalog@0.7.1
+  - @backstage/integration@0.6.8
+  - @backstage/core-components@0.7.0
+  - @backstage/theme@0.2.11
+  - @backstage/plugin-search@0.4.15
+  - @backstage/integration-react@0.1.12
+
+## 0.12.1
+
+### Patch Changes
+
+- 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@0.7.0
+  - @backstage/plugin-catalog-react@0.5.2
+  - @backstage/catalog-model@0.9.4
+  - @backstage/integration@0.6.7
+  - @backstage/plugin-search@0.4.14
+
 ## 0.12.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -7,8 +7,8 @@ import { Config } from '@backstage/config';
 import * as _backstage_core_components from '@backstage/core-components';
 import { TableColumn, TableProps } from '@backstage/core-components';
 import { UserListFilterKind } from '@backstage/plugin-catalog-react';
-import React from 'react';
 import { CSSProperties } from '@material-ui/styles';
+import React from 'react';
 import * as _material_table_core from '@material-table/core';
 
 declare type TechDocsMetadata = {
@@ -109,6 +109,14 @@ declare class TechDocsStorageClient implements TechDocsStorageApi {
     getBaseUrl(oldBaseUrl: string, entityId: EntityName, path: string): Promise<string>;
 }
 
+declare const DocsResultListItem: ({ result, lineClamp, asListItem, asLink, title, }: {
+    result: any;
+    lineClamp?: number | undefined;
+    asListItem?: boolean | undefined;
+    asLink?: boolean | undefined;
+    title?: string | undefined;
+}) => JSX.Element;
+
 declare type DocsTableRow = {
     entity: Entity;
     resolved: {
@@ -118,6 +126,14 @@ declare type DocsTableRow = {
     };
 };
 
+declare const DefaultTechDocsHome: ({ initialFilter, columns, actions, }: {
+    initialFilter?: UserListFilterKind | undefined;
+    columns?: TableColumn<DocsTableRow>[] | undefined;
+    actions?: TableProps<DocsTableRow>['actions'];
+}) => JSX.Element;
+
+declare const EntityListDocsGrid: () => JSX.Element;
+
 declare function createCopyDocsUrlAction(copyToClipboard: Function): (row: DocsTableRow) => {
     icon: () => JSX.Element;
     tooltip: string;
@@ -165,19 +181,6 @@ declare const EntityListDocsTable: {
     actions: typeof actionFactories;
 };
 
-declare const DefaultTechDocsHome: ({ initialFilter, columns, actions, }: {
-    initialFilter?: UserListFilterKind | undefined;
-    columns?: TableColumn<DocsTableRow>[] | undefined;
-    actions?: TableProps<DocsTableRow>['actions'];
-}) => JSX.Element;
-
-declare type Props$2 = {
-    children?: React.ReactNode;
-};
-declare const TechDocsPageWrapper: ({ children }: Props$2) => JSX.Element;
-
-declare const TechDocsPicker: () => null;
-
 declare type PanelType = 'DocsCardGrid' | 'DocsTable';
 interface PanelConfig {
     title: string;
@@ -192,13 +195,12 @@ interface TabConfig {
 }
 declare type TabsConfig = TabConfig[];
 
-declare const DocsResultListItem: ({ result, lineClamp, asListItem, asLink, title, }: {
-    result: any;
-    lineClamp?: number | undefined;
-    asListItem?: boolean | undefined;
-    asLink?: boolean | undefined;
-    title?: string | undefined;
-}) => JSX.Element;
+declare type Props$2 = {
+    children?: React.ReactNode;
+};
+declare const TechDocsPageWrapper: ({ children }: Props$2) => JSX.Element;
+
+declare const TechDocsPicker: () => null;
 
 declare type TechDocsPageRenderFunction = ({ techdocsMetadataValue, entityMetadataValue, entityRef, }: {
     techdocsMetadataValue?: TechDocsMetadata | undefined;
@@ -245,10 +247,10 @@ declare const TechDocsReaderPage: ({ children }: TechDocsPageProps) => JSX.Eleme
 
 declare type Props$1 = {
     entityRef: EntityName;
-    onReady?: () => void;
     withSearch?: boolean;
+    onReady?: () => void;
 };
-declare const Reader: ({ entityRef, onReady, withSearch }: Props$1) => JSX.Element;
+declare const Reader: ({ entityRef, onReady, withSearch, }: Props$1) => JSX.Element;
 
 declare type TechDocsPageHeaderProps = {
     entityRef: EntityName;
@@ -265,4 +267,4 @@ declare type Props = {
 };
 declare const EmbeddedDocsRouter: (_props: Props) => JSX.Element;
 
-export { DefaultTechDocsHome, DocsCardGrid, DocsResultListItem, DocsTable, DocsTableRow, EmbeddedDocsRouter, EntityListDocsTable, EntityTechdocsContent, PanelType, Reader, Router, SyncResult, TechDocsApi, TechDocsClient, TechDocsCustomHome, TechDocsIndexPage, TechDocsPage, TechDocsPageHeader, TechDocsPageHeaderProps, TechDocsPageProps, TechDocsPageRenderFunction, TechDocsPageWrapper, TechDocsPicker, TechDocsReaderPage, TechDocsStorageApi, TechDocsStorageClient, TechdocsPage, isTechDocsAvailable, techdocsPlugin as plugin, techdocsApiRef, techdocsPlugin, techdocsStorageApiRef };
+export { DefaultTechDocsHome, DocsCardGrid, DocsResultListItem, DocsTable, DocsTableRow, EmbeddedDocsRouter, EntityListDocsGrid, EntityListDocsTable, EntityTechdocsContent, PanelType, Reader, Router, SyncResult, TechDocsApi, TechDocsClient, TechDocsCustomHome, TechDocsIndexPage, TechDocsPage, TechDocsPageHeader, TechDocsPageHeaderProps, TechDocsPageProps, TechDocsPageRenderFunction, TechDocsPageWrapper, TechDocsPicker, TechDocsReaderPage, TechDocsStorageApi, TechDocsStorageClient, TechdocsPage, isTechDocsAvailable, techdocsPlugin as plugin, techdocsApiRef, techdocsPlugin, techdocsStorageApiRef };