IContributedButton interface

パッケージ:

azure-devops-extension-api

ファースト パーティまたはサード パーティのコントリビューションからのボタンを定義します

プロパティ

command	ボタンがクリックされたときに実行するコマンドコントリビューションの ID
commandArguments	指定されたコマンドを呼び出すときに渡す省略可能なパラメーター
contributionId	ボタンが定義されたコントリビューションの ID (省略可能、相対アイコン URL の解決に使用)
disabled	true の場合、ボタンを操作できません。
href	ボタンがクリックされたときに移動する Href。 これがリンク ボタンの場合は、渡します。
icon	URL (相対または完全修飾) または IContributedIconDefinition とライト テーマとダーク テーマの URL。 これにより、呼び出し元はテーマの種類に基づいてさまざまなスタイルのアイコンを使用できます。
primary	このボタンを主色でスタイル設定する必要がある場合は true に設定します。
target	省略可能。リンクされたリソースを開くコンテキスト。
text	ボタン内でレンダリングするテキスト。
tooltip	ボタンの aria-label とツールヒントとして使用する省略可能な値。

プロパティの詳細

command

ボタンがクリックされたときに実行するコマンドコントリビューションの ID

command?: string

プロパティ値

string

commandArguments

指定されたコマンドを呼び出すときに渡す省略可能なパラメーター

commandArguments?: any[]

プロパティ値

any[]

contributionId

ボタンが定義されたコントリビューションの ID (省略可能、相対アイコン URL の解決に使用)

contributionId?: string

プロパティ値

string

disabled

true の場合、ボタンを操作できません。

disabled?: boolean

プロパティ値

boolean

href

ボタンがクリックされたときに移動する Href。 これがリンク ボタンの場合は、渡します。

href?: string

プロパティ値

string

icon

URL (相対または完全修飾) または IContributedIconDefinition とライト テーマとダーク テーマの URL。 これにより、呼び出し元はテーマの種類に基づいてさまざまなスタイルのアイコンを使用できます。

icon?: string | IContributedIconDefinition

プロパティ値

string | IContributedIconDefinition

primary

このボタンを主色でスタイル設定する必要がある場合は true に設定します。

primary?: boolean

プロパティ値

boolean

target

省略可能。リンクされたリソースを開くコンテキスト。

target?: string

プロパティ値

string

text

ボタン内でレンダリングするテキスト。

text?: string

プロパティ値

string

tooltip

ボタンの aria-label とツールヒントとして使用する省略可能な値。

tooltip?: string

プロパティ値

string