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

Add code sample for ConfigApi access in frontend

Browse Source 
Per https://discord.com/channels/687207715902193673/687235481154617364/885085310101377034

Signed-off-by: Julio Zynger <julio.zynger@soundcloud.com>
This commit is contained in:
Júlio Zynger
2021-09-08 13:20:56 +02:00
committed by Julio Zynger
parent c4087c2bd5
commit 6548b9e23f
1 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/conf/reading.md
+10 -1
View File
@@ -112,7 +112,16 @@ example `getString`. These will throw an error if there is no value available.
The [ConfigApi](../reference/utility-apis/Config.md) in the frontend is a
[UtilityApi](../api/utility-apis.md). It's accessible as usual via the
`configApiRef` exported from `@backstage/core-plugin-api`.
`configApiRef` exported from `@backstage/core-plugin-api`:
```
import { useApi, configApiRef } from '@backstage/core-plugin-api';
...
const MyReactComponent = (...) => {
const config = useApi(configApiRef);
...
}
```
Depending on the config api in another API is slightly different though, as the
`ConfigApi` implementation is supplied via the App itself and not instantiated