@backstage/plugin-mui-to-bui 0.2.12-next.0 → 0.2.12-next.1
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 +6 -0
- package/README.md +3 -40
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,43 +1,6 @@
|
|
|
1
1
|
# mui-to-bui
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The Backstage UI Themer helps you convert an existing MUI v5 theme into Backstage UI (BUI) CSS custom properties.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## Installation
|
|
8
|
-
|
|
9
|
-
Add the dependency to your app:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
yarn --cwd packages/app add @backstage/plugin-mui-to-bui
|
|
13
|
-
```
|
|
14
|
-
|
|
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.
|
|
21
|
-
|
|
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.
|
|
27
|
-
|
|
28
|
-
Add a route for the page in your app:
|
|
29
|
-
|
|
30
|
-
```tsx
|
|
31
|
-
// packages/app/src/App.tsx
|
|
32
|
-
import React from 'react';
|
|
33
|
-
import { Route } from 'react-router-dom';
|
|
34
|
-
import { FlatRoutes } from '@backstage/core-app-api';
|
|
35
|
-
import { BuiThemerPage } from '@backstage/plugin-mui-to-bui';
|
|
36
|
-
|
|
37
|
-
export const App = () => (
|
|
38
|
-
<FlatRoutes>
|
|
39
|
-
{/* ...your other routes */}
|
|
40
|
-
<Route path="/mui-to-bui" element={<BuiThemerPage />} />
|
|
41
|
-
</FlatRoutes>
|
|
42
|
-
);
|
|
43
|
-
```
|
|
5
|
+
For installation, usage, and integration instructions, see the main documentation:
|
|
6
|
+
[Using the mui-to-bui plugin](https://backstage.io/docs/conf/user-interface#using-the-mui-to-bui-plugin)
|