📖ドキュメント一覧▼

アイテム構成 (Item Configuration)

Strelit UI Kit のレイアウトツリーは、4つのノードタイプ(‘row’、‘column’ 、‘stack’、‘component’)で構成されます。

import { LayoutConfig, ComponentItemConfig, StackItemConfig } from 'strelit-ui-kit';

const config: LayoutConfig = {
  root: {
    type: 'row',
    content: [
      {
        type: 'component',
        componentType: 'sourceViewer',
        title: 'ソースコード',
        size: '60%',
        componentState: { filePath: '/src/main.ts' },
      } as ComponentItemConfig,
      {
        type: 'stack',
        size: '40%',
        activeItemIndex: 0,
        content: [
          {
            type: 'component',
            componentType: 'terminal',
            title: 'ビルドターミナル',
          },
          {
            type: 'component',
            componentType: 'telemetry',
            title: 'パフォーマンス',
          },
        ],
      } as StackItemConfig,
    ],
  },
};

共通アイテムプロパティ (ItemConfig)

引数型省略可能デフォルト値説明
type‘row’ | ‘column’ | ‘stack’ | ‘component’false-アイテムの構造タイプ。
idstringtrue‘’

layout.findFirstComponentItemById(id) や item.getItemsById(id) を使用してアイテムを取得するための一意の識別子。

sizestringtrue-

兄弟アイテム間におけるこのアイテムの相対的または固定のサイズ。パーセンテージ(例: ‘40%’)、ピクセル(例:‘250px’)、または比率単位(例: ‘2fr’)をサポートします。

minSizestringtrue-

これ以上小さくリサイズできない最小サイズ(例:‘120px’)。

isClosablebooleantruetrue

false の場合、タブ/ヘッダーの閉じるボタンが省略され、ユーザーによって閉じることができなくなります。

titlestringtrue‘’コンポーネントアイテムのタブヘッダーに表示されるラベル。

コンポーネントアイテム (ComponentItemConfig)

引数型省略可能デフォルト値説明
componentTypeComponentType (string)false-

layout.registerComponentFactoryFunction() で登録されたファクトリ関数と一致するコンポーネント識別子。

componentStateSerializableValuetrueundefined

マウント時にコンポーネントコンテナに渡される任意のシリアライズ可能なオブジェクト、文字列、数値、または配列。

reorderEnabledbooleantruetrue

このコンポーネントタブをドラッグして、スタック内またはスタック間で並べ替えできるかどうか。

headerHeaderedItemConfigHeadertrueundefined

ヘッダーコントロール(閉じる、ポップアウト、最小化、最大化)のアイテム単位のカスタムオーバーライド。

スタックアイテム (StackItemConfig)

引数型省略可能デフォルト値説明
contentComponentItemConfig[]false[]

このタブ付きスタック内でホストされるコンポーネントアイテムの配列。注意:スタック内に他のスタックや行/列を含めることはできません。

activeItemIndexnumbertrue0

初期状態でアクティブかつ可視となるコンポーネントタブの 0 から始まるインデックス。

maximisedbooleantruefalse

このスタックがレイアウトビューポート全体を満たす最大化状態で開始するかどうか。

行および列アイテム (RowOrColumnItemConfig)

引数型省略可能デフォルト値説明
type‘row’ | ‘column’false-

‘row’ はアイテムを水平方向(左右)に分割します。‘column’ はアイテムを垂直方向(上下)に分割します。

contentItemConfig[]false[]

子アイテムの配列(行、列、スタック、またはコンポーネントを指定可能)。

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

GitHub で Issue を作成 →