@genesislcap/foundation-layout 14.395.0 → 14.396.1-TPD-4971.1

package/POPOUT_TODO.md

@@ -0,0 +1,46 @@
+# Foundation Layout TODOs
+
+## Multi-Instance Popouts
+Currently, the popout system keys windows and state by their `registration` ID. This limits the layout to having only one instance of a specific component type (e.g., `rapid-grid-pro`) popped out at a time.
+
+### Proposed Improvement
+Support multiple popouts of the same registration by introducing a unique `instanceId` (UUID).
+
+- **URL Parameters**: Add a unique instance ID to the popout URL (e.g., `?layout-popout-control-key=my-grid&layout-popout-instance-id=uuid-123`).
+- **Registry**: Update `FoundationLayoutPopoutController` to key the `popoutRegistry` by the unique `instanceId` rather than the `registration` name.
+- **State Persistence**: Ensure the serialized layout stores the `registration` name alongside the state for each `instanceId` so they can be recreated correctly on restoration.
+- **Communication**: Update the broadcast channel messages (`popout-update`, `popout-sync`, etc.) to use the `instanceId` for targeting and identification.
+
+## Configurable Popout Headers
+A client has requested the ability to see the component header (title and custom buttons) inside the popout window, while still hiding the standard Golden Layout controls (Close, Maximise, and Popout-in-Popout).
+
+### Proposed Improvement
+1. **Update Configuration**: Add `showHeaders?: boolean` to the `LayoutPopoutConfig` interface (defaulting to `false`).
+2. **Update Activation Logic**:
+   - In `tryActivatePopoutMode`, pass the `showHeaders` value to the Golden Layout `settings.hasHeaders` property.
+   - Configure the root component item to disable standard buttons while allowing the header to render:
+     ```typescript
+     header: {
+       maximise: false,
+       close: false,
+       popout: false,
+     }
+     ```
+3. **Custom Buttons**: Ensure that the `setupCustomButtons` logic continues to run in the popout window so that the user's custom tools are injected into the newly visible header.
+
+## Restore on Manual Close
+Currently, when a user manually closes a popout window, the component is removed from the layout entirely. We want to restore it to the main layout automatically.
+
+### Proposed Solution
+1. **Detect Manual Close**:
+   - In `FoundationLayoutPopoutController`, add a flag `isClosingAll` (boolean).
+   - Set `isClosingAll = true` at the start of `closeAllPopouts()` and `false` at the end.
+   - In the `popout-closed` event handler, check if `!isClosingAll`. If true, this is a manual user action.
+
+2. **Trigger Restoration**:
+   - If manual close is detected, call a restoration method on the parent `FoundationLayout` (e.g., `restoreItem`).
+   - Pass the `registration` ID and the final `state` (captured from the registry before deletion).
+
+3. **Implement `restoreItem`**:
+   - Update `FoundationLayout` to support restoring an item with its state preserved.
+   - This likely requires updating `addItem` or creating a new method that accepts `initialState` (or `componentState`) in the configuration, so the component re-initializes with its previous data (filters, scroll position, etc.).