📖チュートリアル一覧▼

ヘッダーコントロールの追加 (Header Controls)

Strelit Layout にはネイティブ機能を簡単に拡張できるフックが多数用意されており、例えばすべてのヘッダーに追加のコントロールを挿入することができます。

実装の目的

このチュートリアルでは、すべてのスタックヘッダーに背景色を変更できるドロップダウンを追加します。

満たすべき要件:

  • 色が選択されたときにコンポーネントの背景色を変更する
  • コンポーネントの設定に基づいて初期色を設定する
  • 新しい色が選択されたときに、レイアウトの状態保存用に状態変更を通知する

成果物

対話型サンプル: ヘッダーへのコントロール追加

CodePen 上で完全なレイアウト実装を確認、フォーク、テストできます:

実装のアプローチ

新しい行、列、スタック、またはコンポーネントが作成されるたびに、Strelit Layout は新しいアイテムを引数として渡すイベントを発行します。

myLayout.on('stackCreated', function (stack) {
  // ...スタックを操作
});

myLayout.on('componentCreated', function (component) {
  // ...コンポーネントを操作
});

スタック、行、列、コンポーネントはすべて Item API を公開しています。

注意:すべてのコンポーネントはスタック(ヘッダーとタブを持つアイテム)の子です!コンポーネントがスタックの子として明示的に構成されていない場合でも、暗黙的にスタックが追加されます。

Stack アイテムは、そのヘッダー(stack.header)および子コンポーネントへのアクセスを提供します:

myLayout.on('stackCreated', (stack) => {
  /*
   * ヘッダーコントロールボタン(ポップアウト、最大化、最小化、閉じる)
   * を含むネイティブ DOM 要素へのアクセス:
   */
  const customButton = document.createElement('button');
  customButton.className = 'my-header-btn';
  customButton.textContent = '⚙️';
  stack.header.controlsContainerElement.prepend(customButton);

  /*
   * activeContentItemChanged の監視:
   * 初期化時およびアクティブタブの切り替え時に発行
   */
  stack.on('activeContentItemChanged', (componentItem) => {
    console.log('アクティブタブが切り替わりました:', componentItem.title);
  });

  /*
   * アクティブなコンポーネントコンテナおよび要素へのアクセス:
   */
  const activeItem = stack.getActiveComponentItem();
  if (activeItem) {
    activeItem.container.element.style.borderColor = '#eab308';
  }
});

完全なコード例

myLayout.on('stackCreated', (stack) => {
  // ネイティブドロップダウンコンテナを作成
  const dropdown = document.createElement('select');
  dropdown.className = 'header-color-select';
  dropdown.innerHTML = `
    <option value="#1e293b">スレート</option>
    <option value="#14532d">エメラルド</option>
    <option value="#701a75">フクシア</option>
    <option value="#1e3a5f">ネイビー</option>
  `;

  const setColor = (color) => {
    const activeItem = stack.getActiveComponentItem();
    if (!activeItem) return;

    // コンテナの DOM 要素に色を直接適用
    activeItem.container.element.style.backgroundColor = color;

    // レイアウト永続化用に更新された状態を提供
    activeItem.container.stateRequestEvent = () => ({ color });
  };

  dropdown.addEventListener('change', (e) => {
    setColor(e.target.value);
  });

  // スタックヘッダーコントロールの先頭にドロップダウンを挿入
  stack.header.controlsContainerElement.prepend(dropdown);

  // アクティブタブが切り替わったときにドロップダウンの選択を同期
  stack.on('activeContentItemChanged', (item) => {
    const state = item.container.initialState || {};
    if (state.color) {
      dropdown.value = state.color;
      setColor(state.color);
    }
  });
});

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

GitHub で Issue を作成 →