From 031028c2ac225d51278b3dd5885f4255f6e8ae89 Mon Sep 17 00:00:00 2001 From: Nikita Karpukhin Date: Fri, 4 Nov 2022 18:18:29 +0100 Subject: [PATCH] Revert changes in README.md Signed-off-by: Nikita Karpukhin --- plugins/user-settings/README.md | 37 ++++++++++++++++----------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/plugins/user-settings/README.md b/plugins/user-settings/README.md index c1b50710f4..1d15c404e5 100644 --- a/plugins/user-settings/README.md +++ b/plugins/user-settings/README.md @@ -4,14 +4,12 @@ Welcome to the user-settings plugin! ## About the plugin -This plugin provides two components, `` is intended to be used within -the [``](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, `` is intended to be used within the [``](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>; +; ``` 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 = () => ( - {someAction} + {someAction} ); @@ -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 { ; ``` -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,