📖ドキュメント一覧▼

レイアウト構成 (Layout Configuration)

Essential

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)

引数型省略可能デフォルト値説明
constrainDragToContainerbooleantruetrue

内部アイテムのドラッグ可能領域を、レイアウトコンテナの境界内に制限します。

reorderEnabledbooleantruetrue

true の場合、ユーザーはスタック間でタブをドラッグしてレイアウトを並べ替えることができます。

popoutWholeStackbooleantruefalse

true の場合、ポップアウトボタンをクリックするとアクティブなスタック全体が分離されます。false の場合、アクティブなコンポーネントアイテムのみがポップアウトされます。

blockedPopoutsThrowErrorbooleantruetrue

ブラウザのポップアップブロッカーによってポップアウトウィンドウが開けない場合に、例外( PopoutBlockedError)をスローするかどうか。

closePopoutsOnUnloadbooleantruetrue

親ウィンドウがリロードまたは閉じられたときに、すべての子ポップアウトウィンドウを自動的に閉じるかどうか。

responsiveMode‘none’ | ‘always’ | ‘onload’true‘none’小型画面またはモバイルビューポート向けのリフロー動作。
tabOverlapAllowancenumbertrue0

タブのオーバーフロー ドロップダウンメニューをトリガーする前に許容されるピクセル重複量。

reorderOnTabMenuClickbooleantruetrue

オーバードロップダウンからタブを選択したときに、そのタブを前面の可視タブ領域に移動させるかどうか。

tabControlOffsetnumbertrue10

タブとヘッダーアクションボタン(閉じる、ポップアウト、最大化)の間のピクセル間隔。

popInOnClosebooleantruefalse

true の場合、ポップアウトウィンドウを閉じた際にメインレイアウトの元の位置に自動的に再ドッキングされます。

header (LayoutConfigHeader)

引数型省略可能デフォルト値説明
showfalse | ‘top’ | ‘left’ | ‘right’ | ‘bottom’true‘top’

スタック上のタブストリップヘッダーバーの位置。false に設定すると、ヘッダーが完全に非表示になります(スプリッターモード)。

popoutfalse | stringtrue‘新しいウィンドウで開く’

ポップアウトアイコンのツールチップラベル。false に設定するとポップアウトボタンが無効化されます。

dockstringtrue‘ドッキング’

ポップアウト子ウィンドウ内に表示される再ドッキングボタンのツールチップラベル。

maximisefalse | stringtrue‘最大化’

最大化アイコンのツールチップラベル。false に設定すると最大化ボタンが非表示になります。

minimisestringtrue‘元のサイズに戻す’

スタックが現在最大化されているときに表示される最小化アイコンのツールチップラベル。

closefalse | stringtrue‘閉じる’

閉じるアイコンのツールチップラベル。false に設定するとヘッダーからのアイテムクローズが無効化されます。

tabDropdownfalse | stringtrue‘その他のタブ’オーバーフロータブ ドロップダウンボタンのツールチップラベル。

dimensions (LayoutConfigDimensions)

引数型省略可能デフォルト値説明
borderWidthnumbertrue5

レイアウトアイテム間のスプリッター境界線の可視太さ(ピクセル単位)。

borderGrabWidthnumbertrue5

マウスやタッチでのグラブ操作を容易にするための境界線周辺の不可視ヒットテスト領域。

defaultMinItemHeightstringtrue‘0px’

アイテムをリサイズできるデフォルトの最小高さ(例:‘100px’ をサポート)。

defaultMinItemWidthstringtrue‘10px’

アイテムをリサイズできるデフォルトの最小幅(例:‘150px’ をサポート)。

headerHeightnumbertrue20タブヘッダーバーの高さ(ピクセル単位)。
dragProxyWidthnumbertrue300

タブ/パネルのドラッグ操作中に表示されるフローティングプロキシ要素の幅。

dragProxyHeightnumbertrue200

タブ/パネルのドラッグ操作中に表示されるフローティングプロキシ要素の高さ。

openPopouts (PopoutLayoutConfig[])

layout.saveLayout() によって永続化される、ポップアウトウィンドウ構成の省略可能な配列。 layout.loadLayout() に渡すと、Strelit UI Kit は分離された補助ウィンドウを以前のモニター座標とサイズに自動的に復元します。

マルチ画面トレーディング端末やエンタープライズ分析ダッシュボードの構築、レガシーレイアウトからの移行など、チームとコミュニティがサポートします。

GitHub で Issue を作成 →