From e564015a036d3418bbf48f684b546e0b622c6731 Mon Sep 17 00:00:00 2001 From: Marley <55280588+marleypowell@users.noreply.github.com> Date: Thu, 4 Apr 2024 11:54:50 +0100 Subject: [PATCH 1/3] Update README.md for signals plugin Signed-off-by: Marley <55280588+marleypowell@users.noreply.github.com> --- plugins/signals/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/signals/README.md b/plugins/signals/README.md index 7b96da32f1..38dc18808b 100644 --- a/plugins/signals/README.md +++ b/plugins/signals/README.md @@ -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) => { From 7eb4d5739f84127fb68e35b46f94030ae52265d0 Mon Sep 17 00:00:00 2001 From: Marley <55280588+marleypowell@users.noreply.github.com> Date: Thu, 4 Apr 2024 11:56:48 +0100 Subject: [PATCH 2/3] Update README.md Signed-off-by: Marley <55280588+marleypowell@users.noreply.github.com> --- plugins/signals-react/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/signals-react/README.md b/plugins/signals-react/README.md index 4da9338866..df8321db24 100644 --- a/plugins/signals-react/README.md +++ b/plugins/signals-react/README.md @@ -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) => { From f06458c8408aa5300ece91a7bb583403efdff5f6 Mon Sep 17 00:00:00 2001 From: Marley <55280588+marleypowell@users.noreply.github.com> Date: Thu, 4 Apr 2024 14:48:23 +0000 Subject: [PATCH 3/3] added changeset Signed-off-by: Marley <55280588+marleypowell@users.noreply.github.com> --- .changeset/shy-brooms-hide.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/shy-brooms-hide.md diff --git a/.changeset/shy-brooms-hide.md b/.changeset/shy-brooms-hide.md new file mode 100644 index 0000000000..6bbd89e6d6 --- /dev/null +++ b/.changeset/shy-brooms-hide.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-signals-react': patch +'@backstage/plugin-signals': patch +--- + +fixed typo in docs