Strelit UI Kit では、型定義された LayoutConfig
インターフェースを通じてレイアウトを定義します。この構成は、構造階層 (root)
を動作設定 (settings)、ヘッダーコントロール (header)、および視覚的寸法 (
dimensions) から明確に分離します。
import { LayoutConfig, StrelitLayout } from 'strelit-ui-kit';
const config: LayoutConfig = {
root: {
type: 'row',
content: [
{
type: 'component',
componentType: 'explorer',
title: 'ファイルエクスプローラー',
size: '25%',
},
{
type: 'column',
size: '75%',
content: [
{
type: 'component',
componentType: 'editor',
title: 'ワークスペースエディター',
},
{
type: 'component',
componentType: 'terminal',
title: 'ターミナルログ',
size: '35%',
},
],
},
],
},
header: {
show: 'top',
popout: '新しいウィンドウで開く',
maximise: '最大化',
minimise: '元のサイズに戻す',
close: '閉じる',
tabDropdown: 'その他のタブ',
},
dimensions: {
borderWidth: 5,
borderGrabWidth: 5,
defaultMinItemHeight: '0px',
defaultMinItemWidth: '10px',
headerHeight: 20,
dragProxyWidth: 300,
dragProxyHeight: 200,
},
settings: {
constrainDragToContainer: true,
reorderEnabled: true,
popoutWholeStack: false,
blockedPopoutsThrowError: true,
closePopoutsOnUnload: true,
responsiveMode: 'none',
tabOverlapAllowance: 0,
reorderOnTabMenuClick: true,
tabControlOffset: 10,
popInOnClose: false,
},
};
const layout = new StrelitLayout(document.getElementById('layoutContainer'));
layout.loadLayout(config);
root (RootItemConfig)
レイアウト階層のルート要素。RowOrColumnItemConfig(タイプ ‘row’ または ‘column’)、StackItemConfig(タイプ ‘stack’)、または単一の ComponentItemConfig(タイプ ‘component’)のいずれかを指定できます。詳細なアイテムオプションは、アイテム構成 (Item Configuration) を参照してください。
settings (LayoutConfigSettings)
| 引数 | 型 | 省略可能 | デフォルト値 | 説明 |
|---|---|---|---|---|
| constrainDragToContainer | boolean | true | true | 内部アイテムのドラッグ可能領域を、レイアウトコンテナの境界内に制限します。 |
| reorderEnabled | boolean | true | true | true の場合、ユーザーはスタック間でタブをドラッグしてレイアウトを並べ替えることができます。 |
| popoutWholeStack | boolean | true | false | true の場合、ポップアウトボタンをクリックするとアクティブなスタック全体が分離されます。false の場合、アクティブなコンポーネントアイテムのみがポップアウトされます。 |
| blockedPopoutsThrowError | boolean | true | true | ブラウザのポップアップブロッカーによってポップアウトウィンドウが開けない場合に、例外(
|
| closePopoutsOnUnload | boolean | true | true | 親ウィンドウがリロードまたは閉じられたときに、すべての子ポップアウトウィンドウを自動的に閉じるかどうか。 |
| responsiveMode | ‘none’ | ‘always’ | ‘onload’ | true | ‘none’ | 小型画面またはモバイルビューポート向けのリフロー動作。 |
| tabOverlapAllowance | number | true | 0 | タブのオーバーフロー ドロップダウンメニューをトリガーする前に許容されるピクセル重複量。 |
| reorderOnTabMenuClick | boolean | true | true | オーバードロップダウンからタブを選択したときに、そのタブを前面の可視タブ領域に移動させるかどうか。 |
| tabControlOffset | number | true | 10 | タブとヘッダーアクションボタン(閉じる、ポップアウト、最大化)の間のピクセル間隔。 |
| popInOnClose | boolean | true | false | true の場合、ポップアウトウィンドウを閉じた際にメインレイアウトの元の位置に自動的に再ドッキングされます。 |
header (LayoutConfigHeader)
| 引数 | 型 | 省略可能 | デフォルト値 | 説明 |
|---|---|---|---|---|
| show | false | ‘top’ | ‘left’ | ‘right’ | ‘bottom’ | true | ‘top’ | スタック上のタブストリップヘッダーバーの位置。 |
| popout | false | string | true | ‘新しいウィンドウで開く’ | ポップアウトアイコンのツールチップラベル。 |
| dock | string | true | ‘ドッキング’ | ポップアウト子ウィンドウ内に表示される再ドッキングボタンのツールチップラベル。 |
| maximise | false | string | true | ‘最大化’ | 最大化アイコンのツールチップラベル。 |
| minimise | string | true | ‘元のサイズに戻す’ | スタックが現在最大化されているときに表示される最小化アイコンのツールチップラベル。 |
| close | false | string | true | ‘閉じる’ | 閉じるアイコンのツールチップラベル。 |
| tabDropdown | false | string | true | ‘その他のタブ’ | オーバーフロータブ ドロップダウンボタンのツールチップラベル。 |
dimensions (LayoutConfigDimensions)
| 引数 | 型 | 省略可能 | デフォルト値 | 説明 |
|---|---|---|---|---|
| borderWidth | number | true | 5 | レイアウトアイテム間のスプリッター境界線の可視太さ(ピクセル単位)。 |
| borderGrabWidth | number | true | 5 | マウスやタッチでのグラブ操作を容易にするための境界線周辺の不可視ヒットテスト領域。 |
| defaultMinItemHeight | string | true | ‘0px’ | アイテムをリサイズできるデフォルトの最小高さ(例: |
| defaultMinItemWidth | string | true | ‘10px’ | アイテムをリサイズできるデフォルトの最小幅(例: |
| headerHeight | number | true | 20 | タブヘッダーバーの高さ(ピクセル単位)。 |
| dragProxyWidth | number | true | 300 | タブ/パネルのドラッグ操作中に表示されるフローティングプロキシ要素の幅。 |
| dragProxyHeight | number | true | 200 | タブ/パネルのドラッグ操作中に表示されるフローティングプロキシ要素の高さ。 |
openPopouts (PopoutLayoutConfig[])
layout.saveLayout() によって永続化される、ポップアウトウィンドウ構成の省略可能な配列。
layout.loadLayout() に渡すと、Strelit UI Kit
は分離された補助ウィンドウを以前のモニター座標とサイズに自動的に復元します。