umbraco-global-context

Umbraco グローバルコンテキスト

これは何ですか？

グローバルコンテキストは、バックオフィス全体でアクセス可能な、共有された型安全なデータと関数のレイヤーを作成します。スコープ付きコンテキスト（Workspace Context など）とは異なり、グローバルコンテキストはバックオフィスセッション全体にわたって持続します。拡張機能間で状態を共有したり、集中管理されたサービスを管理したり、通信を調整したりするために使用します。注: 可能な場合は、より具体的なコンテキストタイプを優先してください。Umbraco はグローバルコンテキストを控えめに使用しています。

ドキュメント

実装する前に、常に最新のドキュメントを取得してください:

• メインドキュメント: https://docs.umbraco.com/umbraco-cms/extend-your-project/backoffice-extensions/extending-overview/extension-types/global-context
• Context API: https://docs.umbraco.com/umbraco-cms/extend-your-project/backoffice-extensions/foundation/context-api
• Foundation: https://docs.umbraco.com/umbraco-cms/extend-your-project/backoffice-extensions/foundation
• Extension Registry: https://docs.umbraco.com/umbraco-cms/extend-your-project/backoffice-extensions/extending-overview/extension-registry

関連する Foundation スキル

• Context API: コンテキストの消費パターンを理解するため

  • 参照スキル: umbraco-context-api

• State Management: コンテキスト内のリアクティブな状態のため

  • 参照スキル: umbraco-state-management

ワークフロー

1. ドキュメントを取得 - 上記の URL に対して WebFetch を使用します
2. 質問する - どの状態を共有しますか？どのようなサービスが必要ですか？代わりに workspace context で対応できますか？
3. ファイルを生成 - 最新のドキュメントに基づいてコンテキストトークン + 実装 + マニフェストを作成します
4. 説明 - 作成した内容とコンテキストの消費方法を示します

最小限の例

コンテキストトークン (my-global-context.token.ts)

import { UmbContextToken } from '@umbraco-cms/backoffice/context-api';
import type { MyGlobalContext } from './my-global-context.js';

export const MY_GLOBAL_CONTEXT = new UmbContextToken<MyGlobalContext>(
  'My.GlobalContext'
);

コンテキストの実装 (my-global-context.ts)

import { UmbContextBase } from '@umbraco-cms/backoffice/class-api';
import type { UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
import { MY_GLOBAL_CONTEXT } from './my-global-context.token.js';

export class MyGlobalContext extends UmbContextBase {
  #currentValue = '';

  constructor(host: UmbControllerHost) {
    super(host, MY_GLOBAL_CONTEXT);
  }

  getValue(): string {
    return this.#currentValue;
  }

  setValue(value: string): void {
    this.#currentValue = value;
  }
}

マニフェスト (umbraco-package.json)

{
  "name": "My Global Context Package",
  "extensions": [
    {
      "type": "globalContext",
      "alias": "My.GlobalContext",
      "name": "My Global Context",
      "js": "/App_Plugins/MyPackage/my-global-context.js"
    }
  ]
}

コンテキストの消費

import { UmbElementMixin } from '@umbraco-cms/backoffice/element-api';
import { MY_GLOBAL_CONTEXT } from './my-global-context.token.js';

class MyElement extends UmbElementMixin(LitElement) {
  #myContext?: MyGlobalContext;

  constructor() {
    super();
    this.consumeContext(MY_GLOBAL_CONTEXT, (instance) => {
      this.#myContext = instance;
    });
  }
}

以上です！常に最新のドキュメントを取得し、例は最小限に保ち、完全に動作するコードを生成してください。