@backstage/plugin-catalog-react 1.19.0-next.2 → 1.19.0

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 (2) hide show
  1. package/CHANGELOG.md +68 -0
  2. package/package.json +20 -20
package/CHANGELOG.md CHANGED
@@ -1,5 +1,73 @@
1
1
  # @backstage/plugin-catalog-react
2
2
 
3
+ ## 1.19.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 406acb6: Introduces a new `EntityIconLinkBlueprint` that customizes the `About` card icon links on the `Catalog` entity page.
8
+
9
+ The blueprint currently accepts a `useProps` hook as `param` and this function returns the following props that will be passed to the icon link component:
10
+
11
+ | Name | Description | Type | Default Value |
12
+ | ---------- | --------------------------------------------------- | ------------- | ------------- |
13
+ | `icon` | The icon to display. | `JSX.Element` | N/A |
14
+ | `label` | The label for the element. | `string` | N/A |
15
+ | `title` | The title for the element. | `string` | N/A |
16
+ | `disabled` | Whether the element is disabled. | `boolean` | `false` |
17
+ | `href` | The URL to navigate to when the element is clicked. | `string` | N/A |
18
+ | `onClick` | A function to call when the element is clicked. | `() => void` | N/A |
19
+
20
+ Here is an usage example:
21
+
22
+ ```tsx
23
+ import { EntityIconLinkBlueprint } from '@backstage/plugin-catalog-react/alpha';
24
+ //...
25
+
26
+ EntityIconLinkBlueprint.make({
27
+ name: 'my-icon-link',
28
+ params: {
29
+ useProps() {
30
+ const { t } = useTranslationRef(myIconLinkTranslationRef);
31
+ return {
32
+ label: t('myIconLink.label'),
33
+ icon: <MyIconLinkIcon />,
34
+ href: '/my-plugin',
35
+ };
36
+ },
37
+ },
38
+ });
39
+ ```
40
+
41
+ Additionally, the `app-config.yaml` file allows you to override some of the default icon link parameters, including `label` and `title` values. Here's how to set them:
42
+
43
+ ```yaml
44
+ app:
45
+ extensions:
46
+ - entity-icon-link:my-plugin/my-icon-link:
47
+ config:
48
+ label: 'My Custom Icon Link label'
49
+ ```
50
+
51
+ Finally, you can disable all links if you want to hide the About card header completely (useful, for example, when links are displayed on separate cards). The header is hidden when no icon links extensions are enabled.
52
+
53
+ ### Patch Changes
54
+
55
+ - Updated dependencies
56
+ - @backstage/core-components@0.17.3
57
+ - @backstage/catalog-client@1.10.1
58
+ - @backstage/core-plugin-api@1.10.8
59
+ - @backstage/frontend-plugin-api@0.10.3
60
+ - @backstage/integration-react@1.2.8
61
+ - @backstage/catalog-model@1.7.4
62
+ - @backstage/core-compat-api@0.4.3
63
+ - @backstage/errors@1.2.7
64
+ - @backstage/frontend-test-utils@0.3.3
65
+ - @backstage/types@1.2.1
66
+ - @backstage/version-bridge@1.0.11
67
+ - @backstage/plugin-catalog-common@1.1.4
68
+ - @backstage/plugin-permission-common@0.9.0
69
+ - @backstage/plugin-permission-react@0.4.35
70
+
3
71
  ## 1.19.0-next.2
4
72
 
5
73
  ### Minor Changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-catalog-react",
3
- "version": "1.19.0-next.2",
3
+ "version": "1.19.0",
4
4
  "description": "A frontend library that helps other Backstage plugins interact with the catalog",
5
5
  "backstage": {
6
6
  "role": "web-library",
@@ -73,20 +73,20 @@
73
73
  "test": "backstage-cli package test"
74
74
  },
75
75
  "dependencies": {
76
- "@backstage/catalog-client": "1.10.1-next.0",
77
- "@backstage/catalog-model": "1.7.4",
78
- "@backstage/core-compat-api": "0.4.3-next.2",
79
- "@backstage/core-components": "0.17.3-next.0",
80
- "@backstage/core-plugin-api": "1.10.7",
81
- "@backstage/errors": "1.2.7",
82
- "@backstage/frontend-plugin-api": "0.10.3-next.1",
83
- "@backstage/frontend-test-utils": "0.3.3-next.1",
84
- "@backstage/integration-react": "1.2.7",
85
- "@backstage/plugin-catalog-common": "1.1.4",
86
- "@backstage/plugin-permission-common": "0.9.0",
87
- "@backstage/plugin-permission-react": "0.4.34",
88
- "@backstage/types": "1.2.1",
89
- "@backstage/version-bridge": "1.0.11",
76
+ "@backstage/catalog-client": "^1.10.1",
77
+ "@backstage/catalog-model": "^1.7.4",
78
+ "@backstage/core-compat-api": "^0.4.3",
79
+ "@backstage/core-components": "^0.17.3",
80
+ "@backstage/core-plugin-api": "^1.10.8",
81
+ "@backstage/errors": "^1.2.7",
82
+ "@backstage/frontend-plugin-api": "^0.10.3",
83
+ "@backstage/frontend-test-utils": "^0.3.3",
84
+ "@backstage/integration-react": "^1.2.8",
85
+ "@backstage/plugin-catalog-common": "^1.1.4",
86
+ "@backstage/plugin-permission-common": "^0.9.0",
87
+ "@backstage/plugin-permission-react": "^0.4.35",
88
+ "@backstage/types": "^1.2.1",
89
+ "@backstage/version-bridge": "^1.0.11",
90
90
  "@material-ui/core": "^4.12.2",
91
91
  "@material-ui/icons": "^4.9.1",
92
92
  "@material-ui/lab": "4.0.0-alpha.61",
@@ -100,11 +100,11 @@
100
100
  "zen-observable": "^0.10.0"
101
101
  },
102
102
  "devDependencies": {
103
- "@backstage/cli": "0.33.0-next.1",
104
- "@backstage/core-app-api": "1.17.0",
105
- "@backstage/plugin-catalog-common": "1.1.4",
106
- "@backstage/plugin-scaffolder-common": "1.5.11",
107
- "@backstage/test-utils": "1.7.8",
103
+ "@backstage/cli": "^0.33.0",
104
+ "@backstage/core-app-api": "^1.17.1",
105
+ "@backstage/plugin-catalog-common": "^1.1.4",
106
+ "@backstage/plugin-scaffolder-common": "^1.5.11",
107
+ "@backstage/test-utils": "^1.7.9",
108
108
  "@testing-library/dom": "^10.0.0",
109
109
  "@testing-library/jest-dom": "^6.0.0",
110
110
  "@testing-library/react": "^16.0.0",