優れたアプリケーションを構築し、レイアウトを設定して、ユーザーが好みの配置に整えました。素晴らしいことです!
しかし次にアプリを開いたとき、ユーザーは前回終了したときと全く同じ状態で作業を再開したいはずです。あるいは、複数の保存済みレイアウトプリセットから選択させたい場合もあるでしょう。
Strelit Layout はそのための強力な永続化機構を備えています。レイアウトの構造だけでなく、内部コンポーネントの状態もシリアライズ可能なオブジェクトに変換し、データベース、LocalStorage、その他任意のストレージに保存できます。
具体的な仕組みは以下のとおりです:
レイアウトの作成
このチュートリアルでは、はじめに で作成したレイアウトを使用します。
const config = {
root: {
type: 'row',
content: [
{
type: 'component',
componentType: 'testComponent',
componentState: { label: 'A' },
},
{
type: 'column',
content: [
{
type: 'component',
componentType: 'testComponent',
componentState: { label: 'B' },
},
{
type: 'component',
componentType: 'testComponent',
componentState: { label: 'C' },
},
],
},
],
},
};
対象の要素でレイアウトを初期化します:
const containerEl = document.getElementById('layoutContainer');
const myLayout = new StrelitLayout(containerEl);
状態変更の監視
レイアウトインスタンスとその内部のすべてのアイテムはイベントを発行します。ここで利用するイベントは
stateChanged
です。ペインのリサイズやタブのドッキング、クローズなど、保存対象となるレイアウト状態が変更されるたびに発行されます。
myLayout.on('stateChanged', () => {
// シリアライズされたレイアウト状態を保存
const state = myLayout.saveLayout();
localStorage.setItem('savedState', JSON.stringify(state));
});
myLayout.saveLayout() を呼び出すことで、レイアウト状態がクリーンで JSON
互換のオブジェクトにシリアライズされます(互換性のため toConfig()
もエイリアスとして維持されています)。
スプリッターの高速ドラッグ中にレイアウト全体をシリアライズすると負荷が高くなる場合があります。本番環境では、
stateChanged
リスナーをデバウンス(間引き)するか、ユーザーの明示的な保存操作をトリガーにすることをお勧めします。
保存された状態からのレイアウト復元
ユーザーが次回アプリケーションを開いた際、LocalStorage に以前保存した設定があるかを確認します。
saveLayout() は計算済みの数値サイズを含む ResolvedLayoutConfig
を出力するため、組み込みヘルパー createLayoutConfigFromResolved() を使用して有効な
LayoutConfig に変換してから loadLayout() に渡します:
import { StrelitLayout, createLayoutConfigFromResolved } from 'strelit-ui-kit';
const savedState = localStorage.getItem('savedState');
const initialConfig = savedState
? createLayoutConfigFromResolved(JSON.parse(savedState))
: defaultConfig;
// レイアウトインスタンスに設定を読み込む
myLayout.loadLayout(initialConfig);
stateRequestEvent によるコンポーネント状態の保存
Strelit
はツリー構造、寸法、アクティブタブを自動的にシリアライズしますが、フォーム入力値やフィルター条件などのコンポーネント固有データは、
saveLayout() 実行時に動的に要求されます。
命令的なステート取得ではなく、container.stateRequestEvent
にコールバック関数を割り当てます。Strelit
がレイアウトツリーをシリアライズする際、このコールバックを実行してコンポーネントの最新状態を取得します:
myLayout.registerComponentFactoryFunction('testComponent', (container, itemConfig) => {
// 初期状態の読み込み(デフォルト設定または復元されたセッション)
const state = itemConfig.componentState || { label: '' };
// ネイティブ入力要素の作成
const input = document.createElement('input');
input.type = 'text';
input.value = state.label || '';
input.placeholder = '永続化する文字列を入力...';
// コンテナ要素にマウント
container.element.appendChild(input);
// 状態シリアライズプロバイダーの登録
container.stateRequestEvent = () => {
return {
label: input.value,
};
};
// 任意: 入力時に stateChanged を発火させる
input.addEventListener('input', () => {
myLayout.emitBaseBubblingEvent('stateChanged');
});
});
実行結果
インタラクティブな例: 状態の保存
CodePen 上で完全なレイアウト実装を確認、フォーク、テストできます: