Merge pull request #23986 from marleypowell/patch-1
Update README.md for signals plugin
This commit is contained in:
@@ -0,0 +1,6 @@
|
||||
---
|
||||
'@backstage/plugin-signals-react': patch
|
||||
'@backstage/plugin-signals': patch
|
||||
---
|
||||
|
||||
fixed typo in docs
|
||||
@@ -38,9 +38,9 @@ You can also use the signal API directly. This allows more fine-grained control
|
||||
subscriptions.
|
||||
|
||||
```ts
|
||||
import { signalsApiRef } from '@backstage/plugin-signals-react';
|
||||
import { signalApiRef } from '@backstage/plugin-signals-react';
|
||||
|
||||
const signals = useApi(signalsApiRef);
|
||||
const signals = useApi(signalApiRef);
|
||||
const { unsubscribe } = signals.subscribe(
|
||||
'myplugin:channel',
|
||||
(message: JsonObject) => {
|
||||
|
||||
@@ -30,9 +30,9 @@ const app = createApp({
|
||||
Now you can utilize the API from other plugins using the `@backstage/plugin-signals-react` package or simply by:
|
||||
|
||||
```ts
|
||||
import { signalsApiRef } from '@backstage/plugin-signals-react';
|
||||
import { signalApiRef } from '@backstage/plugin-signals-react';
|
||||
|
||||
const signals = useApi(signalsApiRef);
|
||||
const signals = useApi(signalApiRef);
|
||||
const { unsubscribe } = signals.subscribe(
|
||||
'myplugin:topic',
|
||||
(message: JsonObject) => {
|
||||
|
||||
Reference in New Issue
Block a user