@backstage/plugin-home 0.8.7-next.1 → 0.8.7-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/README.md +0 -4
  3. package/dist/alpha.d.ts +3 -3
  4. package/dist/alpha.esm.js +2 -2
  5. package/dist/alpha.esm.js.map +1 -1
  6. package/dist/assets/TemplateBackstageLogo.esm.js +11 -11
  7. package/dist/assets/TemplateBackstageLogo.esm.js.map +1 -1
  8. package/dist/assets/TemplateBackstageLogoIcon.esm.js +11 -11
  9. package/dist/assets/TemplateBackstageLogoIcon.esm.js.map +1 -1
  10. package/dist/componentRenderers/ComponentAccordion.esm.js +39 -27
  11. package/dist/componentRenderers/ComponentAccordion.esm.js.map +1 -1
  12. package/dist/componentRenderers/ComponentTabs/ComponentTab.esm.js +2 -2
  13. package/dist/componentRenderers/ComponentTabs/ComponentTab.esm.js.map +1 -1
  14. package/dist/componentRenderers/ComponentTabs/ComponentTabs.esm.js +14 -10
  15. package/dist/componentRenderers/ComponentTabs/ComponentTabs.esm.js.map +1 -1
  16. package/dist/components/CustomHomepage/AddWidgetDialog.esm.js +31 -26
  17. package/dist/components/CustomHomepage/AddWidgetDialog.esm.js.map +1 -1
  18. package/dist/components/CustomHomepage/CustomHomepageButtons.esm.js +53 -48
  19. package/dist/components/CustomHomepage/CustomHomepageButtons.esm.js.map +1 -1
  20. package/dist/components/CustomHomepage/CustomHomepageGrid.esm.js +78 -70
  21. package/dist/components/CustomHomepage/CustomHomepageGrid.esm.js.map +1 -1
  22. package/dist/components/CustomHomepage/WidgetSettingsOverlay.esm.js +55 -46
  23. package/dist/components/CustomHomepage/WidgetSettingsOverlay.esm.js.map +1 -1
  24. package/dist/components/CustomHomepage/types.esm.js.map +1 -1
  25. package/dist/components/HomepageCompositionRoot.esm.js +2 -2
  26. package/dist/components/HomepageCompositionRoot.esm.js.map +1 -1
  27. package/dist/components/StarredEntityListItem/StarredEntityListItem.esm.js +30 -28
  28. package/dist/components/StarredEntityListItem/StarredEntityListItem.esm.js.map +1 -1
  29. package/dist/components/VisitList/ItemCategory.esm.js +2 -2
  30. package/dist/components/VisitList/ItemCategory.esm.js.map +1 -1
  31. package/dist/components/VisitList/ItemDetail.esm.js +11 -7
  32. package/dist/components/VisitList/ItemDetail.esm.js.map +1 -1
  33. package/dist/components/VisitList/ItemName.esm.js +5 -5
  34. package/dist/components/VisitList/ItemName.esm.js.map +1 -1
  35. package/dist/components/VisitList/VisitList.esm.js +23 -14
  36. package/dist/components/VisitList/VisitList.esm.js.map +1 -1
  37. package/dist/components/VisitList/VisitListEmpty.esm.js +5 -2
  38. package/dist/components/VisitList/VisitListEmpty.esm.js.map +1 -1
  39. package/dist/components/VisitList/VisitListFew.esm.js +2 -2
  40. package/dist/components/VisitList/VisitListFew.esm.js.map +1 -1
  41. package/dist/components/VisitList/VisitListItem.esm.js +12 -9
  42. package/dist/components/VisitList/VisitListItem.esm.js.map +1 -1
  43. package/dist/components/VisitList/VisitListSkeleton.esm.js +23 -17
  44. package/dist/components/VisitList/VisitListSkeleton.esm.js.map +1 -1
  45. package/dist/components/VisitListener.esm.js +3 -2
  46. package/dist/components/VisitListener.esm.js.map +1 -1
  47. package/dist/homePageComponents/CompanyLogo/CompanyLogo.esm.js +2 -2
  48. package/dist/homePageComponents/CompanyLogo/CompanyLogo.esm.js.map +1 -1
  49. package/dist/homePageComponents/FeaturedDocsCard/Content.esm.js +32 -30
  50. package/dist/homePageComponents/FeaturedDocsCard/Content.esm.js.map +1 -1
  51. package/dist/homePageComponents/HeaderWorldClock/HeaderWorldClock.esm.js +9 -8
  52. package/dist/homePageComponents/HeaderWorldClock/HeaderWorldClock.esm.js.map +1 -1
  53. package/dist/homePageComponents/QuickStart/Content.esm.js +34 -26
  54. package/dist/homePageComponents/QuickStart/Content.esm.js.map +1 -1
  55. package/dist/homePageComponents/QuickStart/ContentModal.esm.js +25 -21
  56. package/dist/homePageComponents/QuickStart/ContentModal.esm.js.map +1 -1
  57. package/dist/homePageComponents/RandomJoke/Actions.esm.js +2 -2
  58. package/dist/homePageComponents/RandomJoke/Actions.esm.js.map +1 -1
  59. package/dist/homePageComponents/RandomJoke/Content.esm.js +6 -3
  60. package/dist/homePageComponents/RandomJoke/Content.esm.js.map +1 -1
  61. package/dist/homePageComponents/RandomJoke/Context.esm.js +10 -9
  62. package/dist/homePageComponents/RandomJoke/Context.esm.js.map +1 -1
  63. package/dist/homePageComponents/RandomJoke/Settings.esm.js +19 -16
  64. package/dist/homePageComponents/RandomJoke/Settings.esm.js.map +1 -1
  65. package/dist/homePageComponents/StarredEntities/Content.esm.js +45 -40
  66. package/dist/homePageComponents/StarredEntities/Content.esm.js.map +1 -1
  67. package/dist/homePageComponents/Toolkit/Content.esm.js +11 -8
  68. package/dist/homePageComponents/Toolkit/Content.esm.js.map +1 -1
  69. package/dist/homePageComponents/Toolkit/Context.esm.js +5 -4
  70. package/dist/homePageComponents/Toolkit/Context.esm.js.map +1 -1
  71. package/dist/homePageComponents/VisitedByType/Actions.esm.js +4 -3
  72. package/dist/homePageComponents/VisitedByType/Actions.esm.js.map +1 -1
  73. package/dist/homePageComponents/VisitedByType/Content.esm.js +3 -2
  74. package/dist/homePageComponents/VisitedByType/Content.esm.js.map +1 -1
  75. package/dist/homePageComponents/VisitedByType/Context.esm.js +5 -4
  76. package/dist/homePageComponents/VisitedByType/Context.esm.js.map +1 -1
  77. package/dist/homePageComponents/VisitedByType/RecentlyVisited.esm.js +2 -2
  78. package/dist/homePageComponents/VisitedByType/RecentlyVisited.esm.js.map +1 -1
  79. package/dist/homePageComponents/VisitedByType/TopVisited.esm.js +2 -2
  80. package/dist/homePageComponents/VisitedByType/TopVisited.esm.js.map +1 -1
  81. package/dist/homePageComponents/VisitedByType/VisitedByType.esm.js +2 -2
  82. package/dist/homePageComponents/VisitedByType/VisitedByType.esm.js.map +1 -1
  83. package/dist/homePageComponents/WelcomeTitle/WelcomeTitle.esm.js +3 -2
  84. package/dist/homePageComponents/WelcomeTitle/WelcomeTitle.esm.js.map +1 -1
  85. package/dist/index.d.ts +33 -34
  86. package/dist/index.esm.js +1 -1
  87. package/package.json +15 -15
package/dist/index.d.ts CHANGED
@@ -1,7 +1,8 @@
1
1
  import * as _backstage_plugin_home_react from '@backstage/plugin-home-react';
2
2
  import { createCardExtension as createCardExtension$1, CardExtensionProps as CardExtensionProps$1, CardLayout as CardLayout$1, CardSettings as CardSettings$1, CardConfig as CardConfig$1, ComponentParts as ComponentParts$1, ComponentRenderer as ComponentRenderer$1, RendererProps as RendererProps$1 } from '@backstage/plugin-home-react';
3
- import * as React$1 from 'react';
4
- import React__default, { ReactNode, ReactElement } from 'react';
3
+ import * as react from 'react';
4
+ import { ReactNode, JSX as JSX$1, CSSProperties, ReactElement } from 'react';
5
+ import * as react_jsx_runtime from 'react/jsx-runtime';
5
6
  import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
6
7
  import { StorageApi, IdentityApi, ErrorApi } from '@backstage/core-plugin-api';
7
8
  import { EntityFilterQuery } from '@backstage/catalog-client';
@@ -10,7 +11,7 @@ import { EntityFilterQuery } from '@backstage/catalog-client';
10
11
  type Tool = {
11
12
  label: string;
12
13
  url: string;
13
- icon: React__default.ReactNode;
14
+ icon: ReactNode;
14
15
  };
15
16
 
16
17
  /**
@@ -207,7 +208,7 @@ type FeaturedDocsCardProps = {
207
208
  /** The entity filter used to display only the intended item/s */
208
209
  filter: EntityFilterQuery;
209
210
  /** An optional ReactNode for empty states */
210
- emptyState?: React__default.JSX.Element;
211
+ emptyState?: JSX$1.Element;
211
212
  /** An optional linkDestination to set for the Featured Doc */
212
213
  linkDestination?: string;
213
214
  /** An optional limit to set for link destination */
@@ -222,7 +223,7 @@ type FeaturedDocsCardProps = {
222
223
  * @public
223
224
  */
224
225
  type StarredEntitiesProps = {
225
- noStarredEntitiesMessage?: React__default.ReactNode | undefined;
226
+ noStarredEntitiesMessage?: ReactNode | undefined;
226
227
  groupByKind?: boolean;
227
228
  };
228
229
 
@@ -233,19 +234,19 @@ type StarredEntitiesProps = {
233
234
  */
234
235
  type QuickStartCardProps = {
235
236
  /** The modal link title */
236
- modalTitle?: string | React__default.JSX.Element;
237
+ modalTitle?: string | JSX$1.Element;
237
238
  /** The link to docs title */
238
239
  docsLinkTitle?: string;
239
240
  /** The link to docs */
240
241
  docsLink?: string;
241
242
  /** The video to play on the card */
242
- video?: React__default.JSX.Element;
243
+ video?: JSX$1.Element;
243
244
  /** A quickstart image to display on the card */
244
- image: React__default.JSX.Element;
245
+ image: JSX$1.Element;
245
246
  /** The card description*/
246
247
  cardDescription?: string;
247
248
  /** A component used to download a quickStart image*/
248
- downloadImage?: React__default.JSX.Element;
249
+ downloadImage?: JSX$1.Element;
249
250
  };
250
251
 
251
252
  /** @public */
@@ -255,19 +256,17 @@ declare const homePlugin: _backstage_core_plugin_api.BackstagePlugin<{
255
256
  /** @public */
256
257
  declare const HomepageCompositionRoot: (props: {
257
258
  title?: string;
258
- children?: React$1.ReactNode;
259
- }) => React$1.JSX.Element;
259
+ children?: react.ReactNode;
260
+ }) => react_jsx_runtime.JSX.Element;
260
261
  /** @public */
261
262
  declare const ComponentAccordion: (props: {
262
263
  title?: string;
263
264
  expanded?: boolean;
264
265
  Content: () => JSX.Element;
265
266
  Actions?: () => JSX.Element;
266
- Settings?: () => JSX.
267
- /** @public */
268
- Element;
267
+ Settings?: () => JSX.Element;
269
268
  ContextProvider?: (props: any) => JSX.Element;
270
- }) => React$1.JSX.Element;
269
+ }) => react_jsx_runtime.JSX.Element;
271
270
  /** @public */
272
271
  declare const ComponentTabs: (props: {
273
272
  title: string;
@@ -275,44 +274,44 @@ declare const ComponentTabs: (props: {
275
274
  label: string;
276
275
  Component: () => JSX.Element;
277
276
  }[];
278
- }) => React$1.JSX.Element;
277
+ }) => react_jsx_runtime.JSX.Element;
279
278
  /** @public */
280
279
  declare const ComponentTab: (props: {
281
280
  title: string;
282
281
  Content: () => JSX.Element;
283
282
  ContextProvider?: (props: any) => JSX.Element;
284
- }) => React$1.JSX.Element;
283
+ }) => react_jsx_runtime.JSX.Element;
285
284
  /**
286
285
  * A component to display a playful greeting for the user.
287
286
  *
288
287
  * @public
289
288
  */
290
- declare const WelcomeTitle: ({ language }: WelcomeTitleLanguageProps) => React$1.JSX.Element;
289
+ declare const WelcomeTitle: ({ language }: WelcomeTitleLanguageProps) => react_jsx_runtime.JSX.Element;
291
290
  /**
292
291
  * A component to display a company logo for the user.
293
292
  *
294
293
  * @public
295
294
  */
296
295
  declare const HomePageCompanyLogo: (props: {
297
- logo?: React.ReactNode;
296
+ logo?: react.ReactNode;
298
297
  className?: string;
299
- }) => React$1.JSX.Element;
298
+ }) => react_jsx_runtime.JSX.Element;
300
299
  /** @public */
301
300
  declare const HomePageRandomJoke: (props: _backstage_plugin_home_react.CardExtensionProps<{
302
301
  defaultCategory?: "any" | "programming";
303
- }>) => React$1.JSX.Element;
302
+ }>) => react_jsx_runtime.JSX.Element;
304
303
  /**
305
304
  * A component to display a list of tools for the user.
306
305
  *
307
306
  * @public
308
307
  */
309
- declare const HomePageToolkit: (props: _backstage_plugin_home_react.CardExtensionProps<ToolkitContentProps>) => React$1.JSX.Element;
308
+ declare const HomePageToolkit: (props: _backstage_plugin_home_react.CardExtensionProps<ToolkitContentProps>) => react_jsx_runtime.JSX.Element;
310
309
  /**
311
310
  * A component to display a list of starred entities for the user.
312
311
  *
313
312
  * @public
314
313
  */
315
- declare const HomePageStarredEntities: (props: _backstage_plugin_home_react.CardExtensionProps<Partial<StarredEntitiesProps>>) => React$1.JSX.Element;
314
+ declare const HomePageStarredEntities: (props: _backstage_plugin_home_react.CardExtensionProps<Partial<StarredEntitiesProps>>) => react_jsx_runtime.JSX.Element;
316
315
  /**
317
316
  * A component to display a configurable list of clocks for various time zones.
318
317
  *
@@ -321,29 +320,29 @@ declare const HomePageStarredEntities: (props: _backstage_plugin_home_react.Card
321
320
  declare const HeaderWorldClock: (props: {
322
321
  clockConfigs: ClockConfig[];
323
322
  customTimeFormat?: Intl.DateTimeFormatOptions;
324
- }) => React$1.JSX.Element | null;
323
+ }) => react_jsx_runtime.JSX.Element | null;
325
324
  /**
326
325
  * Display top visited pages for the homepage
327
326
  * @public
328
327
  */
329
- declare const HomePageTopVisited: (props: _backstage_plugin_home_react.CardExtensionProps<Partial<VisitedByTypeProps>>) => React$1.JSX.Element;
328
+ declare const HomePageTopVisited: (props: _backstage_plugin_home_react.CardExtensionProps<Partial<VisitedByTypeProps>>) => react_jsx_runtime.JSX.Element;
330
329
  /**
331
330
  * Display recently visited pages for the homepage
332
331
  * @public
333
332
  */
334
- declare const HomePageRecentlyVisited: (props: _backstage_plugin_home_react.CardExtensionProps<Partial<VisitedByTypeProps>>) => React$1.JSX.Element;
333
+ declare const HomePageRecentlyVisited: (props: _backstage_plugin_home_react.CardExtensionProps<Partial<VisitedByTypeProps>>) => react_jsx_runtime.JSX.Element;
335
334
  /**
336
335
  * A component to display specific Featured Docs.
337
336
  *
338
337
  * @public
339
338
  */
340
- declare const FeaturedDocsCard: (props: _backstage_plugin_home_react.CardExtensionProps<FeaturedDocsCardProps>) => React$1.JSX.Element;
339
+ declare const FeaturedDocsCard: (props: _backstage_plugin_home_react.CardExtensionProps<FeaturedDocsCardProps>) => react_jsx_runtime.JSX.Element;
341
340
  /**
342
341
  * A component to display Quick Start information.
343
342
  *
344
343
  * @public
345
344
  */
346
- declare const QuickStartCard: (props: _backstage_plugin_home_react.CardExtensionProps<QuickStartCardProps>) => React$1.JSX.Element;
345
+ declare const QuickStartCard: (props: _backstage_plugin_home_react.CardExtensionProps<QuickStartCardProps>) => react_jsx_runtime.JSX.Element;
347
346
 
348
347
  /**
349
348
  * Breakpoint options for <CustomHomepageGridProps/>
@@ -402,7 +401,7 @@ type CustomHomepageGridProps = {
402
401
  /**
403
402
  * Custom style for grid.
404
403
  */
405
- style?: React__default.CSSProperties;
404
+ style?: CSSProperties;
406
405
  /**
407
406
  * Compaction type of widgets in the grid. This controls where widgets are moved in case
408
407
  * they are overlapping in the grid.
@@ -440,7 +439,7 @@ type LayoutConfiguration = {
440
439
  *
441
440
  * @public
442
441
  */
443
- declare const CustomHomepageGrid: (props: CustomHomepageGridProps) => React__default.JSX.Element;
442
+ declare const CustomHomepageGrid: (props: CustomHomepageGridProps) => react_jsx_runtime.JSX.Element;
444
443
 
445
444
  /**
446
445
  * @public
@@ -448,7 +447,7 @@ declare const CustomHomepageGrid: (props: CustomHomepageGridProps) => React__def
448
447
  * the visitsApi to save visits.
449
448
  */
450
449
  declare const VisitListener: ({ children, toEntityRef, visitName, }: {
451
- children?: React__default.ReactNode;
450
+ children?: ReactNode;
452
451
  toEntityRef?: ({ pathname }: {
453
452
  pathname: string;
454
453
  }) => string | undefined;
@@ -463,10 +462,10 @@ declare const TemplateBackstageLogo: (props: {
463
462
  svg: string;
464
463
  path: string;
465
464
  };
466
- }) => React__default.JSX.Element;
465
+ }) => react_jsx_runtime.JSX.Element;
467
466
 
468
467
  /** @public */
469
- declare const TemplateBackstageLogoIcon: () => React__default.JSX.Element;
468
+ declare const TemplateBackstageLogoIcon: () => react_jsx_runtime.JSX.Element;
470
469
 
471
470
  /**
472
471
  * @public
@@ -517,6 +516,6 @@ declare const SettingsModal: (props: {
517
516
  close: Function;
518
517
  componentName?: string;
519
518
  children: JSX.Element;
520
- }) => React$1.JSX.Element;
519
+ }) => react_jsx_runtime.JSX.Element;
521
520
 
522
521
  export { type Breakpoint, type CardConfig, type CardExtensionProps, type CardLayout, type CardSettings, type ClockConfig, ComponentAccordion, type ComponentParts, type ComponentRenderer, ComponentTab, ComponentTabs, CustomHomepageGrid, type CustomHomepageGridProps, FeaturedDocsCard, type FeaturedDocsCardProps, HeaderWorldClock, HomePageCompanyLogo, HomePageRandomJoke, HomePageRecentlyVisited, HomePageStarredEntities, HomePageToolkit, HomePageTopVisited, HomepageCompositionRoot, type LayoutConfiguration, type Operators, QuickStartCard, type QuickStartCardProps, type RendererProps, SettingsModal, type StarredEntitiesProps, TemplateBackstageLogo, TemplateBackstageLogoIcon, type Tool, type ToolkitContentProps, type Visit, VisitListener, type VisitedByTypeKind, type VisitedByTypeProps, type VisitsApi, type VisitsApiQueryParams, type VisitsApiSaveParams, VisitsStorageApi, type VisitsStorageApiOptions, VisitsWebStorageApi, type VisitsWebStorageApiOptions, WelcomeTitle, type WelcomeTitleLanguageProps, createCardExtension, homePlugin, isOperator, visitsApiRef };
package/dist/index.esm.js CHANGED
@@ -1,5 +1,5 @@
1
1
  export { ComponentAccordion, ComponentTab, ComponentTabs, FeaturedDocsCard, HeaderWorldClock, HomePageCompanyLogo, HomePageRandomJoke, HomePageRecentlyVisited, HomePageStarredEntities, HomePageToolkit, HomePageTopVisited, HomepageCompositionRoot, QuickStartCard, WelcomeTitle, homePlugin } from './plugin.esm.js';
2
- import 'react';
2
+ import 'react/jsx-runtime';
3
3
  import 'react-router-dom';
4
4
  export { CustomHomepageGrid } from './components/CustomHomepage/CustomHomepageGrid.esm.js';
5
5
  export { VisitListener } from './components/VisitListener.esm.js';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-home",
3
- "version": "0.8.7-next.1",
3
+ "version": "0.8.7-next.2",
4
4
  "description": "A Backstage plugin that helps you build a home page",
5
5
  "backstage": {
6
6
  "role": "frontend-plugin",
@@ -46,11 +46,11 @@
46
46
  "types": "./dist/index.d.ts",
47
47
  "typesVersions": {
48
48
  "*": {
49
- "*": [
50
- "dist/index.d.ts"
51
- ],
52
49
  "alpha": [
53
50
  "dist/alpha.d.ts"
51
+ ],
52
+ "package.json": [
53
+ "package.json"
54
54
  ]
55
55
  }
56
56
  },
@@ -71,14 +71,14 @@
71
71
  "@backstage/catalog-client": "1.9.1",
72
72
  "@backstage/catalog-model": "1.7.3",
73
73
  "@backstage/config": "1.3.2",
74
- "@backstage/core-app-api": "1.16.0",
75
- "@backstage/core-compat-api": "0.4.1-next.1",
76
- "@backstage/core-components": "0.17.1-next.0",
77
- "@backstage/core-plugin-api": "1.10.5",
78
- "@backstage/frontend-plugin-api": "0.10.1-next.0",
79
- "@backstage/plugin-catalog-react": "1.16.1-next.1",
80
- "@backstage/plugin-home-react": "0.1.25-next.1",
81
- "@backstage/theme": "0.6.4",
74
+ "@backstage/core-app-api": "1.16.1-next.0",
75
+ "@backstage/core-compat-api": "0.4.1-next.2",
76
+ "@backstage/core-components": "0.17.1-next.1",
77
+ "@backstage/core-plugin-api": "1.10.6-next.0",
78
+ "@backstage/frontend-plugin-api": "0.10.1-next.1",
79
+ "@backstage/plugin-catalog-react": "1.17.0-next.2",
80
+ "@backstage/plugin-home-react": "0.1.25-next.2",
81
+ "@backstage/theme": "0.6.5-next.0",
82
82
  "@material-ui/core": "^4.12.2",
83
83
  "@material-ui/icons": "^4.9.1",
84
84
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -94,9 +94,9 @@
94
94
  "zod": "^3.22.4"
95
95
  },
96
96
  "devDependencies": {
97
- "@backstage/cli": "0.32.0-next.1",
98
- "@backstage/dev-utils": "1.1.9-next.1",
99
- "@backstage/test-utils": "1.7.6",
97
+ "@backstage/cli": "0.32.0-next.2",
98
+ "@backstage/dev-utils": "1.1.9-next.2",
99
+ "@backstage/test-utils": "1.7.7-next.0",
100
100
  "@testing-library/dom": "^10.0.0",
101
101
  "@testing-library/jest-dom": "^6.0.0",
102
102
  "@testing-library/react": "^16.0.0",