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

Update README with tsx code block

Browse Source 
Signed-off-by: Marcus Eide <eide@spotify.com>
This commit is contained in:
Marcus Eide
2021-05-07 16:01:34 +02:00
parent bcf4c2f91d
commit 3b269181b6
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/shortcuts/README.md
+9 -7
View File
@@ -19,16 +19,18 @@ export { shortcutsPlugin } from '@backstage/plugin-shortcuts';
Add the `<Shortcuts />` component within your `<Sidebar>`:
```ts
```tsx
import { Sidebar, SidebarDivider, SidebarSpace } from '@backstage/core';
import { Shortcuts } from '@backstage/plugin-shortcuts';
<Sidebar>
{/* ... */}
<SidebarDivider />
<Shortcuts />
<SidebarSpace />
</Sidebar>;
export const SidebarComponent = () => (
<Sidebar>
{/* ... */}
<SidebarDivider />
<Shortcuts />
<SidebarSpace />
</Sidebar>
);
```
The plugin exports a `shortcutApiRef` but the plugin includes a default implementation of the `ShortcutApi` that uses `localStorage` to store each user's shortcuts.