bricks/docs/ja/message.md
2025-11-19 12:30:39 +08:00

3.8 KiB
Raw Blame History

メッセージ

コントロール機能、タイプ(通常コントロールまたはコンテナコントロール)、親クラス

  • 機能タイトルとメッセージ内容を含むポップアップ通知を表示する。自動開閉、テキストの折り返し、中央揃え、および多言語対応i18nをサポート。
  • タイプ:コンテナコントロール(テキストやスクロールパネルなどの子コントロールを含め可能)
  • 親クラスbricks.PopupWindow

初期化パラメータ

パラメータ名 必須 説明
title string はい ポップアップのタイトルテキスト
message string はい 表示するメッセージ内容
cheight number いいえ コンテンツ領域の高さデフォルト値は9
cwidth number いいえ コンテンツ領域の幅デフォルト値は16
auto_open boolean 自動的に true に設定 コンストラクタ内で自動的に true に設定され、作成直後にウィンドウを開く

注:auto_open はコンストラクタ内で強制的に true に設定されます。

主なイベント

カスタムイベントは定義されていません。PopupWindow から継承される標準イベント(例:onOpenonClose)が使用可能です。


エラー

コントロール機能、タイプ(通常コントロールまたはコンテナコントロール)、親クラス

  • 機能Message コントロールをベースにしており、エラーメッセージ専用。エラー状態を目立たせるために「error」というCSSクラスがスタイルに追加されている。
  • タイプ:コンテナコントロール
  • 親クラスbricks.Message

初期化パラメータ

Message コントロールから継承されたすべてのパラメータ:

パラメータ名 必須 説明
title string はい エラーポップアップのタイトル
message string はい エラーの詳細内容
cheight number いいえ ウィンドウの高さデフォルトは9
cwidth number いいえ ウィンドウの幅デフォルトは16

注:インスタンス生成時に自動的に 'error' スタイルクラスが適用されます。

主なイベント

Message と同じで、新たにイベントは追加されていません。継承された onOpenonClose などのイベントを使用できます。

実際の利用では、通常 bricks.show_error() 関数を使って呼び出します。


追加ツールメソッドの説明(コントロールではなく、個別ドキュメント化しない)

bricks.show_error(opts)

  • 機能:エラーメッセージのポップアップをすばやく表示
  • パラメータ
    • opts: titlemessage を持つオブジェクト。cheight / cwidth の指定も可能
  • 動作
    • サイズが指定されていない場合、デフォルトで cheight=9cwidth=16 を使用
    • bricks.Error インスタンスを作成し、.open() を呼び出す

bricks.show_message(opts)

  • 機能:通常のメッセージポップアップをすばやく表示
  • パラメータ
    • opts: 上記と同じく、titlemessage を含むオブジェクト
  • 動作
    • デフォルトサイズで Message ポップアップを作成し、開く

上記2つの関数は簡易的な呼び出し方法を提供しており、コンポーネントのライフサイクルを手動で管理する必要がないシナリオに適しています。