paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 46 Packages Projects Releases Wiki Activity

Revert changes in README.md

Browse Source 
Signed-off-by: Nikita Karpukhin <nikita.karpukhin@scout24.com>
This commit is contained in:
Nikita Karpukhin
2022-11-04 18:18:29 +01:00
parent 92a0cbb2f0
commit 031028c2ac
1 changed files with 18 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/user-settings/README.md
+18 -19
View File
@@ -4,14 +4,12 @@ Welcome to the user-settings plugin!
## About the plugin
This plugin provides two components, `<UserSettings />` is intended to be used within
the [`<Sidebar>`](https://backstage.io/storybook/?path=/story/sidebar--sample-sidebar) and displays the signed-in users
profile picture and name. The second component is a settings page where the user can control different settings across
the App.
This plugin provides two components, `<UserSettings />` is intended to be used within the [`<Sidebar>`](https://backstage.io/storybook/?path=/story/sidebar--sample-sidebar) and displays the signed-in users profile picture and name. The second component is a settings page where the user can control different settings across the App.
It also provides a `UserSettingsStorage` implementation of the `StorageApi`, to be used in the frontend as a persistent
alternative to the builtin `WebStorage`. Please
see [the backend README](https://github.com/backstage/backstage/tree/master/plugins/user-settings-backend)
It also provides a `UserSettingsStorage` implementation of the `StorageApi`, to
be used in the frontend as a persistent alternative to the builtin `WebStorage`.
Please see [the backend
README](https://github.com/backstage/backstage/tree/master/plugins/user-settings-backend)
for installation instructions.
## Components Usage
@@ -19,13 +17,13 @@ for installation instructions.
Add the item to the Sidebar:
```tsx
import {Settings as SidebarSettings} from '@backstage/plugin-user-settings';
import { Settings as SidebarSettings } from '@backstage/plugin-user-settings';
<SidebarPage>
<Sidebar>
<SidebarSettings/>
<SidebarSettings />
</Sidebar>
< /SidebarPage>;
</SidebarPage>;
```
Add the page to the App routing:
@@ -44,8 +42,7 @@ const AppRoutes = () => (
**Auth Providers**
By default, the plugin provides a list of configured authentication providers fetched from `app-config.yaml` and
displayed in the "Authentication Providers" tab.
By default, the plugin provides a list of configured authentication providers fetched from `app-config.yaml` and displayed in the "Authentication Providers" tab.
If you want to supply your own custom list of Authentication Providers, use the `providerSettings` prop:
@@ -53,7 +50,7 @@ If you want to supply your own custom list of Authentication Providers, use the
const MyAuthProviders = () => (
<ListItem>
<ListItemText primary="example" />
<ListItemSecondaryAction>{someAction} </ListItemSecondaryAction>
<ListItemSecondaryAction>{someAction}</ListItemSecondaryAction>
</ListItem>
);
@@ -73,9 +70,10 @@ const AppRoutes = () => (
By default, the plugin renders 3 tabs of settings; GENERAL, AUTHENTICATION PROVIDERS, and FEATURE FLAGS.
If you want to add more options for your users, just pass the extra tabs using `UserSettingsTab` components as children
of the `UserSettingsPage` route. The path is in this case a child of the settings path, in the example below it would
be `/settings/advanced` so that you can easily link to it.
If you want to add more options for your users,
just pass the extra tabs using `UserSettingsTab` components as children of the `UserSettingsPage` route.
The path is in this case a child of the settings path,
in the example below it would be `/settings/advanced` so that you can easily link to it.
```tsx
import {
@@ -90,14 +88,15 @@ import {
</Route>;
```
To standardize the UI of all setting tabs, make sure you use a similar component structure as the other tabs. You can
take a look at
To standardize the UI of all setting tabs,
make sure you use a similar component structure as the other tabs.
You can take a look at
[the example extra tab](https://github.com/backstage/backstage/blob/master/packages/app/src/components/advancedSettings/AdvancedSettings.tsx)
we have created in Backstage's demo app.
To change the layout altogether, create a custom page in `packages/app/src/components/user-settings/SettingsPage.tsx`:
```typescript jsx
```tsx
import React from 'react';
import {
SettingsLayout,