32 lines
3.0 KiB
Markdown
32 lines
3.0 KiB
Markdown
# Cols
|
||
|
||
**コントロール機能**:ページネーション付きのスクロール可能な複数列データリストを表示するためのもので、前後ページのデータを動的に読み込むことをサポートしています。コンテンツウォールやカードレイアウトなどのシナリオでよく使用されます。
|
||
**タイプ**:コンテナーコントロール
|
||
**親クラスコントロール**:`bricks.VBox`
|
||
|
||
## 初期化パラメータ
|
||
|
||
| パラメータ名 | 型 | 説明 |
|
||
|------------|----|------|
|
||
| `data_url` | 文字列 (String) | データ取得用のURLアドレス。非同期でデータを読み込むために使用します。 |
|
||
| `data_params` | オブジェクト (Object) | データリクエスト時に送信される初期パラメータオブジェクト。 |
|
||
| `data_method` | 文字列 (String) | リクエストメソッド(例:GET、POST)。デフォルトはGET。 |
|
||
| `page_rows` | 数値 (Number) | 1ページあたりにリクエストするデータ行数。 |
|
||
| `cache_limit` | 数値 (Number) | キャッシュするページ数の上限。メモリ内に保持する履歴データページ数を制御するために使用します。 |
|
||
| `col_cwidth` | 数値 (Number) | 各列の固定幅(ピクセル単位)。動的カラムレイアウト計算に使用されます。 |
|
||
| `mobile_cols` | 数値 (Number) | モバイル端末で表示する列数。デフォルトは2。 |
|
||
| `title` | 文字列 (String) | 任意のタイトルテキスト。指定された場合はタイトルコンポーネントが表示されます。 |
|
||
| `description` | 文字列 (String) | 任意の説明テキスト(Markdown形式対応)。説明内容としてレンダリングされます。 |
|
||
| `toolbar` | オブジェクト (Object) | ツールバー設定オブジェクト。上部の操作ボタンを定義するために使用します。 |
|
||
| `record_view` | オブジェクト (Object) | 単一レコードのビュー(表示)テンプレート定義。各データ項目のレンダリング方法を記述します。 |
|
||
|
||
> 注:`record_view` はコントロール設定オブジェクトであり、`bricks.widgetBuild` によって各データ項目の子コントロールが生成されます。
|
||
|
||
## 主なイベント
|
||
|
||
| イベント名 | 発火条件 | 持たされるデータ |
|
||
|----------|----------|----------------|
|
||
| `record_click` | ユーザーが特定のレコードをクリックしたときに発火 | クリックされたレコードに対応するデータオブジェクト(`user_data`) |
|
||
| `command` | ツールバーボタンがクリックされ、`toolbar_w` 経由で送信されたコマンドイベント。`command_handle` により `dispatch(name)` として転送される | コマンド名(toolbar の `params.name` より取得) |
|
||
|
||
> 説明:`dispatch('record_click', data)` は外部にこのイベントをブロードキャストし、外部での監視・処理を可能にします。 |