YouTrack および Hub ヘルプの開発者ポータル

拡張ポイント

YouTrack は、アプリ開発者が UI にウィジェットを埋め込むことができる拡張ポイントのコレクションを提供します。これらのウィジェットは、ユーザーがアプリをインストールしてアクティブ化しない限り利用できない特定の操作をサポートします。このページでは、これらの拡張ポイントに関する情報を確認できます。

ここでは、すべての可能な拡張ポイントとそのスコープの概要を示します。ウィジェットのスコープの詳細については、スコープを参照してください。

拡張ポイント

スコープ

説明

ADMINISTRATION_MENU_ITEM

グローバル

管理メニューに独自の項目を持つページ。

ARTICLE_ABOVE_ACTIVITY_STREAM

論文

アクティビティストリームの上にある記事内の領域。

ARTICLE_BELOW_SUMMARY

論文

記事内のタイトルの領域。

ARTICLE_OPTIONS_MENU_ITEM

論文

ウィジェットを呼び出す記事ツールバーの項目。

DASHBOARD_WIDGET

グローバル

ダッシュボード。

HELPDESK_CHANNEL

プロジェクト

チケット用の追加チャネル。この拡張ポイントは、ヘルプデスクプロジェクトでのみ使用できます。

ISSUE_ABOVE_ACTIVITY_STREAM

課題

アクティビティストリームの上にある課題内の領域。

ISSUE_BELOW_SUMMARY

課題

課題の概要にある課題内の領域。

ISSUE_FIELD_PANEL_FIRST

課題

カスタムフィールドパネルの上にある課題内の領域。

ISSUE_FIELD_PANEL_LAST

課題

カスタムフィールドパネルの課題の領域。

ISSUE_OPTIONS_MENU_ITEM

課題

ウィジェットを呼び出す課題ツールバーの項目。

MAIN_MENU_ITEM

グローバル

ヘッダーにメニュー項目がある別のアプリケーションページ。

MARKDOWN

グローバル

Markdown 形式のテキスト内の領域。

PROJECT_SETTINGS

プロジェクト

プロジェクト設定内の別のタブ。

USER_CARD

ユーザー

課題または記事内のユーザー名にマウスを移動したときに表示されるユーザーカードの領域。

USER_PROFILE_SETTINGS

ユーザー

ユーザープロファイル内の別のタブ。

ホスト API でウィジェットを登録する

ウィジェットが YouTrack に HTTP リクエストを送信したり、YouTrack API のいずれかを使用して YouTrack と通信したりする場合は、ウィジェットの HTML コードに、ウィジェットを YouTrack に登録するスクリプトを追加します。

たとえば、ウィジェットから YouTrack にアラートを送信する場合は、アプリを YouTrack に登録する必要があります。アプリを登録したら、ホスト API を使用して YouTrack でアラートを送信したり、カスタム HTTP ハンドラーとして実装された関数を呼び出したりすることができます。

登録スクリプトの例を次に示します。

<script type="module"> const host = await YTApp.register(); host.alert('Hello world'); </script>

ホスト API の詳細については、ホスト API を参照してください。

管理メニュー項目

名前

説明

スコープ

ADMINISTRATION_MENU_ITEM

この拡張ポイントを使用すると、管理メニューに独自の項目を持つページを作成できます。

グローバル

A menu item for a widget that adds an administration page.
An example of a widget that adds a page to the administration section of YouTrack.

アクティビティストリーム上の記事

名前

説明

スコープ

ARTICLE_ABOVE_ACTIVITY_STREAM

この拡張ポイントを使用すると、アクティビティストリームの上にある記事の領域にカスタムウィジェットを追加できます。

論文

An example of a widget that appears above the activity stream in an article.

記事タイトルの下

名前

説明

スコープ

ARTICLE_BELOW_SUMMARY

この拡張ポイントを使用すると、記事のタイトルの領域にカスタムウィジェットを追加できます。

論文

An example of a widget that appears below the article title.

記事オプションメニュー項目

名前

説明

スコープ

ARTICLE_OPTIONS_MENU_ITEM

この拡張ポイントを使用すると、記事のオプションメニューに項目を追加できます。ユーザーがこのオプションを選択すると、カスタムウィジェットが表示されます。

論文

An example of an app that adds a custom item to the option menu in an article.

ダッシュボードウィジェット

名前

説明

スコープ

DASHBOARD_WIDGET

ダッシュボードに表示できるウィジェット。

この拡張ポイントを使用するアプリは、ウィジェットがダッシュボードに表示されるたびに、特別な埋め込みコンポーネントを生成します。このコンポーネントは、ウィジェットがこれらの場所に表示するデータを保存する、より拡張性の高い CustomWidgetAPILayer API によってサポートされています。この API の詳細については、 を参照してください。

グローバル

An example of a widget that can be displayed on a dashboard.

ヘルプデスクチャネル

名前

説明

スコープ

HELPDESK_CHANNEL

この拡張ポイントを使用すると、ヘルプデスクチケットを作成するための追加チャネルを作成できます。これはヘルプデスクプロジェクトでのみ使用できます。

プロジェクト

An example of a widget that creates a custom helpdesk channel.

アクティビティストリーム上の課題

名前

説明

スコープ

ISSUE_ABOVE_ACTIVITY_STREAM

この拡張ポイントを使用すると、アクティビティストリームの上にある課題領域にカスタムウィジェットを追加できます。

課題

An example of a custom widget in an issue above the activity stream.

課題の概要

名前

説明

スコープ

ISSUE_BELOW_SUMMARY

この拡張ポイントを使用すると、課題の概要の課題の領域にカスタムウィジェットを追加できます。

課題

An example of a custom widget in an issue below the summary.

課題フィールドパネルの最初の

名前

説明

スコープ

ISSUE_FIELD_PANEL_FIRST

この拡張ポイントを使用すると、カスタムフィールドパネルの上にある課題内の領域にカスタムウィジェットを追加できます。

課題

An example of a custom widget shown in the area above the custom field panel.

課題フィールドパネル最終

名前

説明

スコープ

ISSUE_FIELD_PANEL_LAST

この拡張ポイントを使用すると、カスタムフィールドパネルの課題の領域にカスタムウィジェットを追加できます。

課題

An example of a custom widget shown in the area below the custom field panel.

課題オプションメニュー項目

名前

説明

スコープ

ISSUE_OPTIONS_MENU_ITEM

この拡張ポイントを使用すると、課題のオプションメニューに項目を追加できます。ユーザーがこのオプションを選択すると、カスタムウィジェットが表示されます。

課題

An example of an app that adds a custom action to the option menu in an issue.

メインメニュー項目

名前

説明

スコープ

MAIN_MENU_ITEM

この拡張ポイントを使用すると、メインメニューからアクセスできる専用ページを YouTrack に追加できます。

グローバル

The header menu item for an app that uses this extension point.
An example of a custom widget that is accessible from the main menu.

Markdown

名前

説明

スコープ

MARKDOWN

リッチテキストをサポートする領域にコンテンツを埋め込むために使用できるカスタムウィジェット。これらのウィジェットは、課題の説明、ナレッジベースの記事、課題、チケット、記事のコメントに埋め込むことができます。

この拡張ポイントの名前にもかかわらず、このウィジェットは、Markdown モードだけでなくビジュアルモードで編集するときにもコンテンツを埋め込むことができます。

この拡張ポイントを使用するアプリは、ウィジェットがテキストフィールドに挿入されるたびに、特別な埋め込みコンポーネントを生成します。このコンポーネントは、ウィジェットがこれらの場所に表示するデータを保存する、より拡張性の高い CustomWidgetAPILayer API によってサポートされています。この API の詳細については、 を参照してください。

グローバル

An example of a custom widget that displays embedded content.

プロジェクト設定

名前

説明

スコープ

PROJECT_SETTINGS

この拡張ポイントを使用すると、プロジェクト設定に別のタブを作成できます。

プロジェクト

An example of a widget that adds a dedicated tab to the project settings.

ユーザーカード

名前

説明

スコープ

USER_CARD

この拡張ポイントを使用すると、課題、チケット、記事内のユーザー名にマウスを移動したときに表示されるユーザーカードの領域をカスタマイズできます。

ユーザー

An example of widget that displays information on user cards.

ユーザープロファイル設定

名前

説明

スコープ

USER_PROFILE_SETTINGS

この拡張ポイントを使用すると、ユーザープロファイルに別のタブを作成できます。

ユーザー

An example of a widget that adds a dedicated tab to the user profile.