From afa4c66c2a0eb87514fd0cffde4a956df5cc5206 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niels=20Lyngs=C3=B8?= Date: Tue, 5 Mar 2024 15:49:56 +0100 Subject: [PATCH] remove stories --- .../storybook/stories/umb-controller.mdx | 20 ----------- .../storybook/stories/umb-element.mdx | 36 ------------------- 2 files changed, 56 deletions(-) delete mode 100644 src/Umbraco.Web.UI.Client/storybook/stories/umb-controller.mdx delete mode 100644 src/Umbraco.Web.UI.Client/storybook/stories/umb-element.mdx diff --git a/src/Umbraco.Web.UI.Client/storybook/stories/umb-controller.mdx b/src/Umbraco.Web.UI.Client/storybook/stories/umb-controller.mdx deleted file mode 100644 index c0787a2a02..0000000000 --- a/src/Umbraco.Web.UI.Client/storybook/stories/umb-controller.mdx +++ /dev/null @@ -1,20 +0,0 @@ -import { Meta } from '@storybook/addon-docs'; - - - -# Umbraco Controller - -This class can be used as the base of any class. -This will enable Controllers to be hosted in this class. Additionally it provides few shortcut methods for initializing core Umbraco Controllers. - -```ts -observe(source: Observable, callback: (_value: T) => void, unique?: string): UmbObserverController - -provideContext(alias: string | UmbContextToken, instance: R): UmbContextProviderController - -consumeContext(alias: string | UmbContextToken, callback: UmbContextCallback): UmbContextConsumerController -``` - -Read about the 'observe' method in the [Store-API](?path=/docs/guides-store--docs). - -Read about the 'provideContext' and 'consumeContext' methods in the [Context-API](?path=/docs/guides-context-api--docs). diff --git a/src/Umbraco.Web.UI.Client/storybook/stories/umb-element.mdx b/src/Umbraco.Web.UI.Client/storybook/stories/umb-element.mdx deleted file mode 100644 index 9798bee7f7..0000000000 --- a/src/Umbraco.Web.UI.Client/storybook/stories/umb-element.mdx +++ /dev/null @@ -1,36 +0,0 @@ -import { Meta } from '@storybook/addon-docs'; - - - -# Umbraco Element - -This element can be used as the base of any element. -This will enable Controllers to be hosted at this element. Additionally it provides few shortcut methods for initializing core Umbraco Controllers. - -```ts -observe(source: Observable, callback: (_value: T) => void, unique?: string): UmbObserverController - -provideContext(alias: string | UmbContextToken, instance: R): UmbContextProviderController - -consumeContext(alias: string | UmbContextToken, callback: UmbContextCallback): UmbContextConsumerController -``` - -Use these for an smooth consumption, like this request for a Context API using a simple string context, where the callback value is of an unknown type: - -```ts -this.consumeContext('requestThisContextAlias', (context) => { - // Notice this is a subscription, as context might change or a new one appears. - console.log("I've got the context", context); -}); -``` - -Or use the a Context Token to get a typed context: - -```ts -import { UMB_NOTIFICATION_CONTEXT } from '@umbraco-cms/backoffice/notification'; - -this.consumeContext(UMB_NOTIFICATION_CONTEXT, (context) => { - // Notice this is a subscription, as context might change or a new one appears, but the value is strongly typed - console.log("I've got the context", context); -}); -```