@backstage/plugin-mui-to-bui 0.2.5-next.2 → 0.2.6-next.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.
- package/CHANGELOG.md +21 -0
- package/README.md +12 -32
- package/package.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @backstage/plugin-mui-to-bui
|
|
2
2
|
|
|
3
|
+
## 0.2.6-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies
|
|
8
|
+
- @backstage/ui@0.14.0-next.0
|
|
9
|
+
- @backstage/frontend-plugin-api@0.15.2-next.0
|
|
10
|
+
- @backstage/core-plugin-api@1.12.5-next.0
|
|
11
|
+
- @backstage/theme@0.7.2
|
|
12
|
+
|
|
13
|
+
## 0.2.5
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- 538c985: Updated installation documentation to use feature discovery as the default.
|
|
18
|
+
- ad7c883: Updated the MUI to BUI theme converter page to use the renamed `Header` component from `@backstage/ui`.
|
|
19
|
+
- Updated dependencies
|
|
20
|
+
- @backstage/ui@0.13.0
|
|
21
|
+
- @backstage/core-plugin-api@1.12.4
|
|
22
|
+
- @backstage/frontend-plugin-api@0.15.0
|
|
23
|
+
|
|
3
24
|
## 0.2.5-next.2
|
|
4
25
|
|
|
5
26
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -6,17 +6,24 @@ The Backstage UI Themer helps you convert an existing MUI v5 theme into Backstag
|
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
Run this from your Backstage repo root:
|
|
9
|
+
Add the dependency to your app:
|
|
12
10
|
|
|
13
11
|
```bash
|
|
14
12
|
yarn --cwd packages/app add @backstage/plugin-mui-to-bui
|
|
15
13
|
```
|
|
16
14
|
|
|
17
|
-
|
|
15
|
+
Once installed, the plugin is automatically available in your app through the default feature discovery. For more details and alternative installation methods, see [installing plugins](https://backstage.io/docs/frontend-system/building-apps/installing-plugins).
|
|
16
|
+
|
|
17
|
+
## Accessing the Themer page
|
|
18
|
+
|
|
19
|
+
- Navigate to `/mui-to-bui` in your Backstage app (for example `http://localhost:3000/mui-to-bui`).
|
|
20
|
+
- Optional: Add a sidebar/link in your app that points to `/mui-to-bui` if you want a permanent navigation entry.
|
|
18
21
|
|
|
19
|
-
|
|
22
|
+
## Old Frontend System
|
|
23
|
+
|
|
24
|
+
If your Backstage app uses the old frontend system, you need to manually wire the
|
|
25
|
+
plugin into your app as outlined in this section. If you are on the new frontend
|
|
26
|
+
system, you can skip this.
|
|
20
27
|
|
|
21
28
|
Add a route for the page in your app:
|
|
22
29
|
|
|
@@ -34,30 +41,3 @@ export const App = () => (
|
|
|
34
41
|
</FlatRoutes>
|
|
35
42
|
);
|
|
36
43
|
```
|
|
37
|
-
|
|
38
|
-
#### New frontend system
|
|
39
|
-
|
|
40
|
-
If package discovery is enabled in your app, this plugin is picked up automatically after installation — no code changes required. Just navigate to `/mui-to-bui`.
|
|
41
|
-
|
|
42
|
-
If you prefer explicit registration (or don't use discovery), register the plugin as a feature. The page route (`/mui-to-bui`) is provided by the plugin.
|
|
43
|
-
|
|
44
|
-
```tsx
|
|
45
|
-
// packages/app/src/App.tsx (or your app entry where you call createApp)
|
|
46
|
-
import React from 'react';
|
|
47
|
-
import { createApp } from '@backstage/frontend-defaults';
|
|
48
|
-
import buiThemerPlugin from '@backstage/plugin-mui-to-bui';
|
|
49
|
-
|
|
50
|
-
const app = createApp({
|
|
51
|
-
features: [
|
|
52
|
-
// ...other features
|
|
53
|
-
buiThemerPlugin,
|
|
54
|
-
],
|
|
55
|
-
});
|
|
56
|
-
|
|
57
|
-
export default app.createRoot();
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
## Accessing the Themer page
|
|
61
|
-
|
|
62
|
-
- Navigate to `/mui-to-bui` in your Backstage app (for example `http://localhost:3000/mui-to-bui`).
|
|
63
|
-
- Optional: Add a sidebar/link in your app that points to `/mui-to-bui` if you want a permanent navigation entry.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-mui-to-bui",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.6-next.0",
|
|
4
4
|
"backstage": {
|
|
5
5
|
"role": "frontend-plugin",
|
|
6
6
|
"pluginId": "mui-to-bui",
|
|
@@ -38,17 +38,17 @@
|
|
|
38
38
|
"test": "backstage-cli package test"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@backstage/core-plugin-api": "1.12.
|
|
42
|
-
"@backstage/frontend-plugin-api": "0.15.
|
|
41
|
+
"@backstage/core-plugin-api": "1.12.5-next.0",
|
|
42
|
+
"@backstage/frontend-plugin-api": "0.15.2-next.0",
|
|
43
43
|
"@backstage/theme": "0.7.2",
|
|
44
|
-
"@backstage/ui": "0.
|
|
44
|
+
"@backstage/ui": "0.14.0-next.0",
|
|
45
45
|
"@mui/material": "^5.12.2",
|
|
46
46
|
"@mui/system": "^5.16.14"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@backstage/cli": "0.36.
|
|
50
|
-
"@backstage/dev-utils": "1.1.
|
|
51
|
-
"@backstage/test-utils": "1.7.
|
|
49
|
+
"@backstage/cli": "0.36.1-next.0",
|
|
50
|
+
"@backstage/dev-utils": "1.1.22-next.0",
|
|
51
|
+
"@backstage/test-utils": "1.7.17-next.0",
|
|
52
52
|
"@testing-library/jest-dom": "^6.0.0",
|
|
53
53
|
"@testing-library/react": "^16.0.0",
|
|
54
54
|
"@types/react": "^18.0.0",
|