55 lines
4.1 KiB
Markdown
55 lines
4.1 KiB
Markdown
# VScrollPanel
|
||
|
||
**コンポーネント機能**：垂直スクロールパネル。コンテンツがコンテナの高さを超えた場合に垂直方向のスクロール機能を提供し、スクロールが上端または下端に近づいた際にしきい値イベントを発火させることができます。
|
||
**タイプ**：コンテナーコンポーネント
|
||
**親クラス**：bricks.VBox
|
||
|
||
## 初期化パラメータ
|
||
|
||
| パラメータ名 | 型 | 説明 |
|
||
|--------------|----|------|
|
||
| `min_threshold` | Number (任意) | スクロールバーが上部近くに達したときに `min_threshold` イベントを発火させるしきい値の比率。デフォルトは `0.02`（つまり2％） |
|
||
| `max_threshold` | Number (任意) | スクロールバーが下部近くに達したときに `max_threshold` イベントを発火させるしきい値の比率。デフォルトは `0.95`（つまり95％） |
|
||
| `width` | String | デフォルトは `'100%'`。コンポーネントの幅が親コンテナを満たすように設定されます |
|
||
| `height` | String | デフォルトは `'100%'`。コンポーネントの高さが親コンテナを満たすように設定されます |
|
||
| `css` | String (任意) | カスタムCSSクラス名。自動的に `'scrollpanel'` クラスも追加されます |
|
||
| `overflow` | String | 固定値 `'auto'`。スクロールバーの自動表示を有効にします |
|
||
|
||
> 注意：上記の `width`、`height`、`css`、`overflow` はコンストラクタ内で自動的に設定されます。
|
||
|
||
## 主なイベント
|
||
|
||
- **`min_threshold`**
|
||
垂直スクロール位置が上部に近づいたとき（`min_threshold` の設定に基づく）に発火します。通常、ユーザーが最上部までスクロールしたことを示し、より多くのコンテンツを読み込むなどの操作に使用されます。
|
||
|
||
- **`max_threshold`**
|
||
垂直スクロール位置が下部に近づいたとき（`max_threshold` の設定に基づく）に発火します。一般的に「スクロール到底部時自動読み込み」機能の実装に用いられます。
|
||
|
||
---
|
||
|
||
# HScrollPanel
|
||
|
||
**コンポーネント機能**：水平スクロールパネル。コンテンツがコンテナの幅を超えた場合に水平方向のスクロール機能を提供し、スクロールが最も左または右に近づいた際にしきい値イベントを発火させることができます。
|
||
**タイプ**：コンテナーコンポーネント
|
||
**親クラス**：bricks.HBox
|
||
|
||
## 初期化パラメータ
|
||
|
||
| パラメータ名 | 型 | 説明 |
|
||
|--------------|----|------|
|
||
| `min_threshold` | Number (任意) | 水平スクロールバーが左端近くに達したときに `min_threshold` イベントを発火させるしきい値の比率。デフォルトは `0.01`（つまり1％） |
|
||
| `max_threshold` | Number (任意) | 水平スクロールバーが右端近くに達したときに `max_threshold` イベントを発火させるしきい値の比率。デフォルトは `0.99`（つまり99％） |
|
||
| `width` | String | デフォルトは `'100%'`。コンポーネントの幅が親コンテナを満たすように設定されます |
|
||
| `height` | String | デフォルトは `'100%'`。コンポーネントの高さが親コンテナを満たすように設定されます |
|
||
| `css` | String (任意) | カスタムCSSクラス名。自動的に `'scrollpanel'` クラスも統合されます |
|
||
| `overflow` | String | 固定値 `'auto'`。水平スクロールバーの表示を許可します |
|
||
|
||
> 注意：`width`、`height`、`css`、`overflow` はコンストラクタによって自動的に設定されます。
|
||
|
||
## 主なイベント
|
||
|
||
- **`min_threshold`**
|
||
水平スクロール位置が最も左側に近づいたときに発火します。左側の追加コンテンツの読み込みやその他のロジック実行に使用できます。
|
||
|
||
- **`max_threshold`**
|
||
水平スクロール位置が最も右側に近づいたときに発火します。「横方向スクロールによる追加読み込み」などのシナリオに適しています。 |