Skip to content

gi-nx


gi-nx / SdkUiLayout

ts
type SdkUiLayout = {
  activeOverlay?: GiraffeOverLays;
  bottomBarIframe?:   | {
     height: number;
     url: string;
   }
     | null;
  disableLensSelectionDrawer?: boolean;
  lensTableHeight?: number;
  lensTableMode?: "default" | "collapsed" | "fullscreen";
  sdkPopupOpen?: boolean;
};

Options for updateUiLayout. All fields are optional — only those provided are applied.

Properties ​

PropertyTypeDescription
activeOverlay?GiraffeOverLaysActive full-screen overlay (e.g. 'AllLayers', 'Screenshot')
bottomBarIframe?| { height: number; url: string; } | nullConfiguration for an iframe rendered in the bottom bar of the Giraffe UI
disableLensSelectionDrawer?booleanOnly relevant in a space, not a project. Prevents project or feature details from showing over the top of the app
lensTableHeight?numberHeight of the lens (selected layer) table in pixels
lensTableMode?"default" | "collapsed" | "fullscreen"Display mode of the lens (selected layer) table
sdkPopupOpen?booleanWhether an SDK-owned popup is currently open