@itwin/core-react 3.4.0-dev.55 → 3.4.0-dev.57

package/lib/cjs/core-react/settings/SettingsContainer.js.map

@@ -1 +1 @@
-{"version":3,"file":"SettingsContainer.js","sourceRoot":"","sources":["../../../../src/core-react/settings/SettingsContainer.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oCAAkC;AAClC,+BAA+B;AAE/B,uDAAoD;AACpD,0DAAgE;AAEhE;;;;;;;;;;;6GAW6G;AAE7G;;GAEG;AACH,SAAgB,qCAAqC,CAAC,eAAgC,EAAE,YAA2E;IACjK,KAAK,CAAC,SAAS,CAAE,GAAE,EAAE;QACnB,MAAM,mCAAmC,GAAG,CAAC,EAAC,SAAS,EAAE,aAAa,EAAyC,EAAE,EAAE;YACjH,YAAY,CAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF,OAAO,eAAe,CAAC,+BAA+B,CAAC,WAAW,CAAC,mCAAmC,CAAC,CAAC;IAC1G,CAAC,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;AACtC,CAAC;AAPD,sFAOC;AAED;;GAEG;AACH,SAAgB,qCAAqC,CAAC,eAAgC,EAAE,YAA8F;IACpL,KAAK,CAAC,SAAS,CAAE,GAAE,EAAE;QACnB,MAAM,kCAAkC,GAAG,CAAC,EAAC,gBAAgB,EAAE,sBAAsB,EAAwC,EAAE,EAAE;YAC/H,YAAY,CAAE,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;QAC1D,CAAC,CAAC;QACF,OAAO,eAAe,CAAC,8BAA8B,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAAC;IACxG,CAAC,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;AACtC,CAAC;AAPD,sFAOC;AAiBD;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,EAAC,IAAI,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,eAAe,EAAE,UAAU,EAAyB,EAAE,EAAE;IAC1I,sCAAsC;IACtC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC;IAE3D,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAE,EAAE;QAC/C,IAAI,kBAAkB,IAAI,CAAC,wCAAuB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,UAAU,CAAC;YACxF,OAAO,kBAAkB,CAAC;;YAE1B,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,GAAqB,EAAE,EAAE;QACtE,IAAI,wCAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC;YAClD,OAAO;QACT,qBAAqB,IAAI,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACpD,UAAU,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAE5B,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,KAAa,EAAE,EAAE;QAClE,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAC,EAAE,CAAA,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;QAC5D,aAAa,IAAI,mBAAmB,CAAE,aAAa,CAAC,CAAC;IACvD,CAAC,EAAE,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhC,MAAM,aAAa,GAAI,KAAK,CAAC,WAAW,CAAC,CAAC,QAAgB,EAAE,EAAE;QAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;YAC/C,eAAe,CAAC,8BAA8B,CAAC,IAAI,CAAC,EAAE,sBAAsB,EAAC,WAAW,CAAC,KAAK,EAAE,gBAAgB,EAAE,uBAAuB,EAAC,CAAC,CAAC;;YAE5I,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;IAEnF,KAAK,CAAC,SAAS,CAAE,GAAE,EAAE;QACnB,MAAM,yBAAyB,GAAG,CAAC,EAAC,aAAa,EAA+B,EAAE,EAAE;YAClF,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;YAC7C,IAAI,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAC,EAAE,CAAA,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,CAAC;YAC3E,IAAI,CAAC,aAAa;gBAChB,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAC,EAAE,CAAA,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,CAAC;YACzE,uBAAuB;YACvB,IAAI,aAAa,EAAE;gBACjB,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;oBAC/C,eAAe,CAAC,8BAA8B,CAAC,IAAI,CAAC,EAAE,sBAAsB,EAAC,aAAa,CAAC,KAAK,EAAE,gBAAgB,EAAE,uBAAuB,EAAC,CAAC,CAAC;;oBAE9I,mBAAmB,CAAC,aAAa,CAAC,CAAC;aACtC;QACH,CAAC,CAAC;QAEF,OAAO,eAAe,CAAC,qBAAqB,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IACtF,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,eAAe,EAAE,eAAe,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC,CAAC;IAE1H,KAAK,CAAC,SAAS,CAAE,GAAE,EAAE;QACnB,MAAM,4BAA4B,GAAG,CAAC,EAAC,SAAS,EAAE,aAAa,EAAyC,EAAE,EAAE;YAC1G,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;gBAC/C,eAAe,CAAC,+BAA+B,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;;gBAEnF,SAAS,CAAC,aAAa,CAAC,CAAC;QAC7B,CAAC,CAAC;QACF,OAAO,eAAe,CAAC,wBAAwB,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAAC;IAC5F,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,eAAe,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC,CAAC;IAEjG,MAAM,MAAM,GAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAC,EAAE;QAC3B,OAAO,EAAC,KAAK,EAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI;YAC7D,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,wCAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAC,CAAC;IACxG,CAAC,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAC,EAAE,CAAA,GAAG,CAAC,KAAK,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC;IACvE,OAAO,CACL,6BAAK,SAAS,EAAC,yBAAyB;QACtC,6BAAK,SAAS,EAAC,8BAA8B;YAC3C,oBAAC,2BAAY,IAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,GAAI,CACpF;QACN,6BAAK,SAAS,EAAC,+BAA+B;YAC3C,UAAU,IAAI,6BAAK,SAAS,EAAC,sCAAsC;gBAClE,8BAAM,SAAS,EAAC,qCAAqC,IAAE,OAAO,CAAC,KAAK,CAAQ;gBAC3E,OAAO,CAAC,QAAQ,IAAI,8BAAM,SAAS,EAAC,yCAAyC,IAAE,OAAO,CAAC,QAAQ,CAAQ,CACpG;YACN,6BAAK,SAAS,EAAC,wCAAwC,IACpD,OAAO,CAAC,IAAI,CACT,CACF,CACF,CACP,CAAC;AACJ,CAAC,CAAC;AAhFW,QAAA,iBAAiB,qBAgF5B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Settings\r\n */\r\n\r\nimport \"./SettingsContainer.scss\";\r\nimport * as React from \"react\";\r\nimport { ActivateSettingsTabEventArgs, ProcessSettingsContainerCloseEventArgs, ProcessSettingsTabActivationEventArgs, SettingsManager, SettingsTabEntry } from \"./SettingsManager\";\r\nimport { VerticalTabs } from \"../tabs/VerticalTabs\";\r\nimport { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\r\n\r\n/*  ---------------------------------------------------------------------------------------------------\r\n// A typical implementation of a saveFunction callback\r\nconst saveChanges = React.useCallback((afterSaveFunction: (args: any) => void, args?: any) => {\r\n  if (dataIsDirty) {\r\n    // prompt user to save changes passing in function and arguments to call after saving changes.\r\n    ModalDialogManager.openDialog(<CustomSavePromptModalDialog customProps={customProps}\r\n      onDialogCloseArgs={args} onDialogClose={afterSaveFunction} />);\r\n    return;\r\n  }\r\n  afterSaveFunction(args);\r\n}, []);\r\n---------------------------------------------------------------------------------------------------------- */\r\n\r\n/** Hook to use within Settings Page component to allow saving the current page's data before the Setting Container is closed.\r\n * @public\r\n */\r\nexport function useSaveBeforeClosingSettingsContainer(settingsManager: SettingsManager, saveFunction: (closeFunc: (args: any) => void, closeFuncArgs?: any) => void) {\r\n  React.useEffect (()=>{\r\n    const handleProcessSettingsContainerClose = ({closeFunc, closeFuncArgs}: ProcessSettingsContainerCloseEventArgs) => {\r\n      saveFunction (closeFunc, closeFuncArgs);\r\n    };\r\n    return settingsManager.onProcessSettingsContainerClose.addListener(handleProcessSettingsContainerClose);\r\n  }, [saveFunction, settingsManager]);\r\n}\r\n\r\n/** Hook to use within Settings Page component to allow saving the current page's data before loading to the requested Setting Tab's page.\r\n * @public\r\n */\r\nexport function useSaveBeforeActivatingNewSettingsTab(settingsManager: SettingsManager, saveFunction: (tabSelectionFunc: (args: any) => void, requestedSettingsTabId?: string) => void) {\r\n  React.useEffect (()=>{\r\n    const handleProcessSettingsTabActivation = ({tabSelectionFunc, requestedSettingsTabId}: ProcessSettingsTabActivationEventArgs) => {\r\n      saveFunction (tabSelectionFunc, requestedSettingsTabId);\r\n    };\r\n    return settingsManager.onProcessSettingsTabActivation.addListener(handleProcessSettingsTabActivation);\r\n  }, [saveFunction, settingsManager]);\r\n}\r\n\r\n/**\r\n * @public\r\n */\r\nexport interface SettingsContainerProps {\r\n  tabs: SettingsTabEntry[];\r\n  // sets tab to set as active tab\r\n  currentSettingsTab?: SettingsTabEntry;\r\n  // If plugging into a SPA and you need to modify the route, you can pass in additional logic here\r\n  onSettingsTabSelected?: (tab: SettingsTabEntry) => void;\r\n  // The SettingsManager that can have event handlers registered against it so pages can save its settings before the page is closed.\r\n  settingsManager: SettingsManager;\r\n  // if true show tab label as header above page contents.\r\n  showHeader?: boolean;\r\n}\r\n\r\n/**\r\n * SettingsContainer component that displays Setting Tabs on Left and the P\r\n * Note: that SettingsContainer is not rendered if tabs array is empty\r\n * @public\r\n */\r\nexport const SettingsContainer = ({tabs, onSettingsTabSelected, currentSettingsTab, settingsManager, showHeader}: SettingsContainerProps) => {\r\n  // sort the tabs based on itemPriority\r\n  tabs = tabs.sort((a, b)=> a.itemPriority - b.itemPriority);\r\n\r\n  const [openTab, setOpenTab] = React.useState(()=>{\r\n    if (currentSettingsTab && !ConditionalBooleanValue.getValue(currentSettingsTab.isDisabled))\r\n      return currentSettingsTab;\r\n    else\r\n      return tabs[0];\r\n  });\r\n\r\n  const processTabSelection = React.useCallback((tab: SettingsTabEntry) => {\r\n    if (ConditionalBooleanValue.getValue(tab.isDisabled))\r\n      return;\r\n    onSettingsTabSelected && onSettingsTabSelected(tab);\r\n    setOpenTab(tab);\r\n  }, [onSettingsTabSelected]);\r\n\r\n  const processTabSelectionById = React.useCallback((tabId: string) => {\r\n    const tabToActivate = tabs.find((tab)=>tab.tabId === tabId);\r\n    tabToActivate && processTabSelection (tabToActivate);\r\n  }, [processTabSelection, tabs]);\r\n\r\n  const onActivateTab =  React.useCallback((tabIndex: number) => {\r\n    const selectedTab = tabs[tabIndex];\r\n    if (openTab && openTab.pageWillHandleCloseRequest)\r\n      settingsManager.onProcessSettingsTabActivation.emit({ requestedSettingsTabId:selectedTab.tabId, tabSelectionFunc: processTabSelectionById});\r\n    else\r\n      processTabSelection(selectedTab);\r\n  }, [openTab, processTabSelection, processTabSelectionById, settingsManager, tabs]);\r\n\r\n  React.useEffect (()=>{\r\n    const handleActivateSettingsTab = ({settingsTabId}: ActivateSettingsTabEventArgs) => {\r\n      const idToFind = settingsTabId.toLowerCase();\r\n      let tabToActivate = tabs.find((tab)=>tab.tabId.toLowerCase() === idToFind);\r\n      if (!tabToActivate)\r\n        tabToActivate = tabs.find((tab)=>tab.label.toLowerCase() === idToFind);\r\n      // istanbul ignore else\r\n      if (tabToActivate) {\r\n        if (openTab && openTab.pageWillHandleCloseRequest)\r\n          settingsManager.onProcessSettingsTabActivation.emit({ requestedSettingsTabId:tabToActivate.tabId, tabSelectionFunc: processTabSelectionById});\r\n        else\r\n          processTabSelection(tabToActivate);\r\n      }\r\n    };\r\n\r\n    return settingsManager.onActivateSettingsTab.addListener(handleActivateSettingsTab);\r\n  }, [openTab, processTabSelection, processTabSelectionById, settingsManager, settingsManager.onActivateSettingsTab, tabs]);\r\n\r\n  React.useEffect (()=>{\r\n    const handleSettingsContainerClose = ({closeFunc, closeFuncArgs}: ProcessSettingsContainerCloseEventArgs) => {\r\n      if (openTab && openTab.pageWillHandleCloseRequest)\r\n        settingsManager.onProcessSettingsContainerClose.emit({ closeFunc, closeFuncArgs });\r\n      else\r\n        closeFunc(closeFuncArgs);\r\n    };\r\n    return settingsManager.onCloseSettingsContainer.addListener(handleSettingsContainerClose);\r\n  }, [openTab, processTabSelection, settingsManager, settingsManager.onActivateSettingsTab, tabs]);\r\n\r\n  const labels=tabs.map((tab)=> {\r\n    return {label:tab.label, subLabel: tab.subLabel, icon: tab.icon,\r\n      tooltip: tab.tooltip, tabId: tab.tabId, disabled: ConditionalBooleanValue.getValue(tab.isDisabled)};\r\n  });\r\n  const activeIndex = tabs.findIndex((tab)=>tab.tabId === openTab.tabId);\r\n  return (\r\n    <div className=\"core-settings-container\">\r\n      <div className=\"core-settings-container-left\">\r\n        <VerticalTabs labels={labels} activeIndex={activeIndex} onActivateTab={onActivateTab} />\r\n      </div>\r\n      <div className=\"core-settings-container-right\">\r\n        {showHeader && <div className=\"core-settings-container-right-header\">\r\n          <span className=\"core-settings-container-main-header\">{openTab.label}</span>\r\n          {openTab.subLabel && <span className=\"core-settings-container-main-sub-header\">{openTab.subLabel}</span>}\r\n        </div>}\r\n        <div className=\"core-settings-container-right-contents\">\r\n          {openTab.page}\r\n        </div>\r\n      </div>\r\n    </div>\r\n  );\r\n};\r\n"]}
+{"version":3,"file":"SettingsContainer.js","sourceRoot":"","sources":["../../../../src/core-react/settings/SettingsContainer.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oCAAkC;AAClC,+BAA+B;AAE/B,uDAAoD;AACpD,0DAAgE;AAEhE;;;;;;;;;;;6GAW6G;AAE7G;;GAEG;AACH,SAAgB,qCAAqC,CAAC,eAAgC,EAAE,YAA2E;IACjK,KAAK,CAAC,SAAS,CAAE,GAAE,EAAE;QACnB,MAAM,mCAAmC,GAAG,CAAC,EAAC,SAAS,EAAE,aAAa,EAAyC,EAAE,EAAE;YACjH,YAAY,CAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF,OAAO,eAAe,CAAC,+BAA+B,CAAC,WAAW,CAAC,mCAAmC,CAAC,CAAC;IAC1G,CAAC,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;AACtC,CAAC;AAPD,sFAOC;AAED;;GAEG;AACH,SAAgB,qCAAqC,CAAC,eAAgC,EAAE,YAA8F;IACpL,KAAK,CAAC,SAAS,CAAE,GAAE,EAAE;QACnB,MAAM,kCAAkC,GAAG,CAAC,EAAC,gBAAgB,EAAE,sBAAsB,EAAwC,EAAE,EAAE;YAC/H,YAAY,CAAE,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;QAC1D,CAAC,CAAC;QACF,OAAO,eAAe,CAAC,8BAA8B,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAAC;IACxG,CAAC,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;AACtC,CAAC;AAPD,sFAOC;AAiBD;;;;GAIG;AACI,MAAM,iBAAiB,GAAG,CAAC,EAAC,IAAI,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,eAAe,EAAE,UAAU,EAAyB,EAAE,EAAE;IAC1I,sCAAsC;IACtC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAC,EAAE,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC;IAE3D,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAE,EAAE;QAC/C,IAAI,kBAAkB,IAAI,CAAC,wCAAuB,CAAC,QAAQ,CAAC,kBAAkB,CAAC,UAAU,CAAC;YACxF,OAAO,kBAAkB,CAAC;;YAE1B,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,GAAqB,EAAE,EAAE;QACtE,IAAI,wCAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC;YAClD,OAAO;QACT,qBAAqB,IAAI,qBAAqB,CAAC,GAAG,CAAC,CAAC;QACpD,UAAU,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAE5B,MAAM,uBAAuB,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,KAAa,EAAE,EAAE;QAClE,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAC,EAAE,CAAA,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;QAC5D,aAAa,IAAI,mBAAmB,CAAE,aAAa,CAAC,CAAC;IACvD,CAAC,EAAE,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhC,MAAM,aAAa,GAAI,KAAK,CAAC,WAAW,CAAC,CAAC,QAAgB,EAAE,EAAE;QAC5D,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;YAC/C,eAAe,CAAC,8BAA8B,CAAC,IAAI,CAAC,EAAE,sBAAsB,EAAC,WAAW,CAAC,KAAK,EAAE,gBAAgB,EAAE,uBAAuB,EAAC,CAAC,CAAC;;YAE5I,mBAAmB,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;IAEnF,KAAK,CAAC,SAAS,CAAE,GAAE,EAAE;QACnB,MAAM,yBAAyB,GAAG,CAAC,EAAC,aAAa,EAA+B,EAAE,EAAE;YAClF,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;YAC7C,IAAI,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAC,EAAE,CAAA,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,CAAC;YAC3E,IAAI,CAAC,aAAa;gBAChB,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAC,EAAE,CAAA,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,QAAQ,CAAC,CAAC;YACzE,uBAAuB;YACvB,IAAI,aAAa,EAAE;gBACjB,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;oBAC/C,eAAe,CAAC,8BAA8B,CAAC,IAAI,CAAC,EAAE,sBAAsB,EAAC,aAAa,CAAC,KAAK,EAAE,gBAAgB,EAAE,uBAAuB,EAAC,CAAC,CAAC;;oBAE9I,mBAAmB,CAAC,aAAa,CAAC,CAAC;aACtC;QACH,CAAC,CAAC;QAEF,OAAO,eAAe,CAAC,qBAAqB,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IACtF,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,eAAe,EAAE,eAAe,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC,CAAC;IAE1H,KAAK,CAAC,SAAS,CAAE,GAAE,EAAE;QACnB,MAAM,4BAA4B,GAAG,CAAC,EAAC,SAAS,EAAE,aAAa,EAAyC,EAAE,EAAE;YAC1G,IAAI,OAAO,IAAI,OAAO,CAAC,0BAA0B;gBAC/C,eAAe,CAAC,+BAA+B,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;;gBAEnF,SAAS,CAAC,aAAa,CAAC,CAAC;QAC7B,CAAC,CAAC;QACF,OAAO,eAAe,CAAC,wBAAwB,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAAC;IAC5F,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,eAAe,CAAC,qBAAqB,EAAE,IAAI,CAAC,CAAC,CAAC;IAEjG,MAAM,MAAM,GAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAC,EAAE;QAC3B,OAAO,EAAC,KAAK,EAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI;YAC7D,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,wCAAuB,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAC,CAAC;IACxG,CAAC,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAC,EAAE,CAAA,GAAG,CAAC,KAAK,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC;IACvE,OAAO,CACL,6BAAK,SAAS,EAAC,yBAAyB;QACtC,6BAAK,SAAS,EAAC,8BAA8B;YAC3C,oBAAC,2BAAY,IAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,GAAI,CACpF;QACN,6BAAK,SAAS,EAAC,+BAA+B;YAC3C,UAAU,IAAI,6BAAK,SAAS,EAAC,sCAAsC;gBAClE,8BAAM,SAAS,EAAC,qCAAqC,IAAE,OAAO,CAAC,KAAK,CAAQ;gBAC3E,OAAO,CAAC,QAAQ,IAAI,8BAAM,SAAS,EAAC,yCAAyC,IAAE,OAAO,CAAC,QAAQ,CAAQ,CACpG;YACN,6BAAK,SAAS,EAAC,wCAAwC,IACpD,OAAO,CAAC,IAAI,CACT,CACF,CACF,CACP,CAAC;AACJ,CAAC,CAAC;AAhFW,QAAA,iBAAiB,qBAgF5B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Settings\n */\n\nimport \"./SettingsContainer.scss\";\nimport * as React from \"react\";\nimport { ActivateSettingsTabEventArgs, ProcessSettingsContainerCloseEventArgs, ProcessSettingsTabActivationEventArgs, SettingsManager, SettingsTabEntry } from \"./SettingsManager\";\nimport { VerticalTabs } from \"../tabs/VerticalTabs\";\nimport { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\n\n/*  ---------------------------------------------------------------------------------------------------\n// A typical implementation of a saveFunction callback\nconst saveChanges = React.useCallback((afterSaveFunction: (args: any) => void, args?: any) => {\n  if (dataIsDirty) {\n    // prompt user to save changes passing in function and arguments to call after saving changes.\n    ModalDialogManager.openDialog(<CustomSavePromptModalDialog customProps={customProps}\n      onDialogCloseArgs={args} onDialogClose={afterSaveFunction} />);\n    return;\n  }\n  afterSaveFunction(args);\n}, []);\n---------------------------------------------------------------------------------------------------------- */\n\n/** Hook to use within Settings Page component to allow saving the current page's data before the Setting Container is closed.\n * @public\n */\nexport function useSaveBeforeClosingSettingsContainer(settingsManager: SettingsManager, saveFunction: (closeFunc: (args: any) => void, closeFuncArgs?: any) => void) {\n  React.useEffect (()=>{\n    const handleProcessSettingsContainerClose = ({closeFunc, closeFuncArgs}: ProcessSettingsContainerCloseEventArgs) => {\n      saveFunction (closeFunc, closeFuncArgs);\n    };\n    return settingsManager.onProcessSettingsContainerClose.addListener(handleProcessSettingsContainerClose);\n  }, [saveFunction, settingsManager]);\n}\n\n/** Hook to use within Settings Page component to allow saving the current page's data before loading to the requested Setting Tab's page.\n * @public\n */\nexport function useSaveBeforeActivatingNewSettingsTab(settingsManager: SettingsManager, saveFunction: (tabSelectionFunc: (args: any) => void, requestedSettingsTabId?: string) => void) {\n  React.useEffect (()=>{\n    const handleProcessSettingsTabActivation = ({tabSelectionFunc, requestedSettingsTabId}: ProcessSettingsTabActivationEventArgs) => {\n      saveFunction (tabSelectionFunc, requestedSettingsTabId);\n    };\n    return settingsManager.onProcessSettingsTabActivation.addListener(handleProcessSettingsTabActivation);\n  }, [saveFunction, settingsManager]);\n}\n\n/**\n * @public\n */\nexport interface SettingsContainerProps {\n  tabs: SettingsTabEntry[];\n  // sets tab to set as active tab\n  currentSettingsTab?: SettingsTabEntry;\n  // If plugging into a SPA and you need to modify the route, you can pass in additional logic here\n  onSettingsTabSelected?: (tab: SettingsTabEntry) => void;\n  // The SettingsManager that can have event handlers registered against it so pages can save its settings before the page is closed.\n  settingsManager: SettingsManager;\n  // if true show tab label as header above page contents.\n  showHeader?: boolean;\n}\n\n/**\n * SettingsContainer component that displays Setting Tabs on Left and the P\n * Note: that SettingsContainer is not rendered if tabs array is empty\n * @public\n */\nexport const SettingsContainer = ({tabs, onSettingsTabSelected, currentSettingsTab, settingsManager, showHeader}: SettingsContainerProps) => {\n  // sort the tabs based on itemPriority\n  tabs = tabs.sort((a, b)=> a.itemPriority - b.itemPriority);\n\n  const [openTab, setOpenTab] = React.useState(()=>{\n    if (currentSettingsTab && !ConditionalBooleanValue.getValue(currentSettingsTab.isDisabled))\n      return currentSettingsTab;\n    else\n      return tabs[0];\n  });\n\n  const processTabSelection = React.useCallback((tab: SettingsTabEntry) => {\n    if (ConditionalBooleanValue.getValue(tab.isDisabled))\n      return;\n    onSettingsTabSelected && onSettingsTabSelected(tab);\n    setOpenTab(tab);\n  }, [onSettingsTabSelected]);\n\n  const processTabSelectionById = React.useCallback((tabId: string) => {\n    const tabToActivate = tabs.find((tab)=>tab.tabId === tabId);\n    tabToActivate && processTabSelection (tabToActivate);\n  }, [processTabSelection, tabs]);\n\n  const onActivateTab =  React.useCallback((tabIndex: number) => {\n    const selectedTab = tabs[tabIndex];\n    if (openTab && openTab.pageWillHandleCloseRequest)\n      settingsManager.onProcessSettingsTabActivation.emit({ requestedSettingsTabId:selectedTab.tabId, tabSelectionFunc: processTabSelectionById});\n    else\n      processTabSelection(selectedTab);\n  }, [openTab, processTabSelection, processTabSelectionById, settingsManager, tabs]);\n\n  React.useEffect (()=>{\n    const handleActivateSettingsTab = ({settingsTabId}: ActivateSettingsTabEventArgs) => {\n      const idToFind = settingsTabId.toLowerCase();\n      let tabToActivate = tabs.find((tab)=>tab.tabId.toLowerCase() === idToFind);\n      if (!tabToActivate)\n        tabToActivate = tabs.find((tab)=>tab.label.toLowerCase() === idToFind);\n      // istanbul ignore else\n      if (tabToActivate) {\n        if (openTab && openTab.pageWillHandleCloseRequest)\n          settingsManager.onProcessSettingsTabActivation.emit({ requestedSettingsTabId:tabToActivate.tabId, tabSelectionFunc: processTabSelectionById});\n        else\n          processTabSelection(tabToActivate);\n      }\n    };\n\n    return settingsManager.onActivateSettingsTab.addListener(handleActivateSettingsTab);\n  }, [openTab, processTabSelection, processTabSelectionById, settingsManager, settingsManager.onActivateSettingsTab, tabs]);\n\n  React.useEffect (()=>{\n    const handleSettingsContainerClose = ({closeFunc, closeFuncArgs}: ProcessSettingsContainerCloseEventArgs) => {\n      if (openTab && openTab.pageWillHandleCloseRequest)\n        settingsManager.onProcessSettingsContainerClose.emit({ closeFunc, closeFuncArgs });\n      else\n        closeFunc(closeFuncArgs);\n    };\n    return settingsManager.onCloseSettingsContainer.addListener(handleSettingsContainerClose);\n  }, [openTab, processTabSelection, settingsManager, settingsManager.onActivateSettingsTab, tabs]);\n\n  const labels=tabs.map((tab)=> {\n    return {label:tab.label, subLabel: tab.subLabel, icon: tab.icon,\n      tooltip: tab.tooltip, tabId: tab.tabId, disabled: ConditionalBooleanValue.getValue(tab.isDisabled)};\n  });\n  const activeIndex = tabs.findIndex((tab)=>tab.tabId === openTab.tabId);\n  return (\n    <div className=\"core-settings-container\">\n      <div className=\"core-settings-container-left\">\n        <VerticalTabs labels={labels} activeIndex={activeIndex} onActivateTab={onActivateTab} />\n      </div>\n      <div className=\"core-settings-container-right\">\n        {showHeader && <div className=\"core-settings-container-right-header\">\n          <span className=\"core-settings-container-main-header\">{openTab.label}</span>\n          {openTab.subLabel && <span className=\"core-settings-container-main-sub-header\">{openTab.subLabel}</span>}\n        </div>}\n        <div className=\"core-settings-container-right-contents\">\n          {openTab.page}\n        </div>\n      </div>\n    </div>\n  );\n};\n"]}

package/lib/cjs/core-react/settings/SettingsContainer.scss

@@ -1,65 +1,65 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-
-@import "../style/themecolors";
-@import "~@itwin/itwinui-css/scss/style/typography";
-
-div.core-settings-container {
-  display: flex;
-  box-sizing: border-box;
-  height: 100%;
-  width: 100%;
-
-  *, *:before, *:after {
-    box-sizing: inherit;
-  }
-
-  .core-settings-container-left {
-    min-width: 15em;
-    height: 100%;
-    overflow: auto;
-    >.uicore-tabs-vertical {
-      font-size: 16px;
-    }
-  }
-  .core-settings-container-right {
-    display: flex;
-    flex-direction: column;
-    width: 100%;
-    height: 100%;
-    overflow: hidden;
-    background: var(--buic-background-dialog);
-    align-content: center;
-
-    .core-settings-container-right-header {
-      display: flex;
-      width: 100%;
-      height: ($iui-font-size-title * 2);
-      font-size: $iui-font-size-title;
-      font-weight: $iui-font-weight-semibold;
-      padding-left: 15px;
-      align-items: center;
-
-      .core-settings-container-main-sub-header {
-        position: relative;
-        padding-left: 20px;
-
-        &::before {
-          content: "-";
-          position: absolute;
-          left: 10px;
-          transform: translateX(-50%);
-        }
-      }
-    }
-
-    .core-settings-container-right-contents {
-      display: flex;
-      width: 100%;
-      height: 100%;
-      overflow: auto;
-    }
-  }
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+
+@import "../style/themecolors";
+@import "~@itwin/itwinui-css/scss/style/typography";
+
+div.core-settings-container {
+  display: flex;
+  box-sizing: border-box;
+  height: 100%;
+  width: 100%;
+
+  *, *:before, *:after {
+    box-sizing: inherit;
+  }
+
+  .core-settings-container-left {
+    min-width: 15em;
+    height: 100%;
+    overflow: auto;
+    >.uicore-tabs-vertical {
+      font-size: 16px;
+    }
+  }
+  .core-settings-container-right {
+    display: flex;
+    flex-direction: column;
+    width: 100%;
+    height: 100%;
+    overflow: hidden;
+    background: var(--buic-background-dialog);
+    align-content: center;
+
+    .core-settings-container-right-header {
+      display: flex;
+      width: 100%;
+      height: ($iui-font-size-title * 2);
+      font-size: $iui-font-size-title;
+      font-weight: $iui-font-weight-semibold;
+      padding-left: 15px;
+      align-items: center;
+
+      .core-settings-container-main-sub-header {
+        position: relative;
+        padding-left: 20px;
+
+        &::before {
+          content: "-";
+          position: absolute;
+          left: 10px;
+          transform: translateX(-50%);
+        }
+      }
+    }
+
+    .core-settings-container-right-contents {
+      display: flex;
+      width: 100%;
+      height: 100%;
+      overflow: auto;
+    }
+  }
 }

package/lib/cjs/core-react/settings/SettingsManager.d.ts

@@ -1,133 +1,133 @@
-/** @packageDocumentation
- * @module Settings
- */
-/// <reference types="react" />
-import { BeUiEvent } from "@itwin/core-bentley";
-import { ConditionalBooleanValue } from "@itwin/appui-abstract";
-/** Interface used to populate a tab entry in the SettingContainer control
- * @public
- */
-export interface SettingsTabEntry {
-    /** unique id for entry */
-    readonly tabId: string;
-    /** localized display label */
-    readonly label: string;
-    /** Setting page content to display when tab item is selected. */
-    readonly page: JSX.Element;
-    /** Setting to true if page will register to watch for stage closing event so it can save any dirty settings. Page component should register and handle the events:
-     * `settingsManager.onProcessSettingsTabActivation` and `settingsManager.onProcessSettingsContainerClose` */
-    readonly pageWillHandleCloseRequest?: boolean;
-    /** used to determine position in tablist */
-    readonly itemPriority: number;
-    /** Optional Subtitle to show below label. */
-    readonly subLabel?: string;
-    /** Icon specification */
-    readonly icon?: string | JSX.Element;
-    /** Tooltip. Allows JSX|Element to support react-tooltip component */
-    readonly tooltip?: string | JSX.Element;
-    /** Allows Settings entry to be disabled */
-    readonly isDisabled?: boolean | ConditionalBooleanValue;
-}
-/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.
- * @public
- */
-export declare class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> {
-}
-/** Arguments of [[this.onSettingsProvidersChanged]] event.
- * @public
- */
-export interface SettingsProvidersChangedEventArgs {
-    readonly providers: ReadonlyArray<SettingsTabsProvider>;
-}
-/** Event class for [[this.onProcessSettingsTabActivation]] which is emitted when a new Tab needs to be activated. This allows the current
- * settings page to save its settings before activating the new SettingTab.
- * @public
- */
-export declare class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> {
-}
-/** Arguments of [[this.onProcessSettingsTabActivation]] event.
- * @public
- */
-export interface ProcessSettingsTabActivationEventArgs {
-    readonly tabSelectionFunc: (tabId: string) => void;
-    readonly requestedSettingsTabId: string;
-}
-/** Event class for [[this.onProcessSettingsContainerClose]] which is emitted when the settings container will be closed. This allows the current
- * settings page to save its settings before calling the function to close the container.
- * @public
- */
-export declare class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
-}
-/** Event class for [[this.onCloseSettingsContainer]] which is monitored by the settings container and indicates that some out process want to close the settings container.
- * @internal
- */
-export declare class CloseSettingsContainerEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
-}
-/** Arguments of [[this.onProcessSettingsContainerClose]] event.
- * @public
- */
-export interface ProcessSettingsContainerCloseEventArgs {
-    readonly closeFunc: (args: any) => void;
-    readonly closeFuncArgs?: any;
-}
-/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).
- * @public
- */
-export declare class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> {
-}
-/** Arguments of [[this.onActivateSettingsTab]] event.
- * @public
- */
-export interface ActivateSettingsTabEventArgs {
-    readonly settingsTabId: string;
-}
-/** Setting Provider interface. Implemented by classes that want to supply settings pages for display in the SettingContainer. The
- * classes that implement this interface need to be registered with the [[SettingsManager]].
- * @public
- */
-export interface SettingsTabsProvider {
-    /** Id of provider, used to remove registration. */
-    readonly id: string;
-    getSettingEntries(stageId: string, stageUsage: string): ReadonlyArray<SettingsTabEntry> | undefined;
-}
-/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.
- * @public
- */
-export declare class SettingsManager {
-    private _providers;
-    /** Event raised when SettingsProviders are changed.
-     */
-    readonly onSettingsProvidersChanged: SettingsProvidersChangedEvent;
-    /** Event raised solely for a settings page to monitor so it can save its settings before continuing tab activation.
-     * See React hook function `useSaveBeforeActivatingNewSettingsTab`.
-     */
-    readonly onProcessSettingsTabActivation: ProcessSettingsTabActivationEvent;
-    /** Event raised when the settings container will be closed. Any setting page component that is 'modal' should register to
-     * listen to this event so that it can save its state before closing. See React hook function `useSaveBeforeClosingSettingsContainer`.
-     */
-    readonly onProcessSettingsContainerClose: ProcessSettingsContainerCloseEvent;
-    /** Event raised to change the active settings tab shown in UI. Monitored by the SettingsContainer.
-     * @internal
-     */
-    readonly onActivateSettingsTab: ActivateSettingsTabEvent;
-    /** Event monitored by SettingsContainer to process request to close the settings container.
-     * @internal
-     */
-    readonly onCloseSettingsContainer: CloseSettingsContainerEvent;
-    /** @public */
-    get providers(): ReadonlyArray<SettingsTabsProvider>;
-    set providers(p: ReadonlyArray<SettingsTabsProvider>);
-    /** Called by application when an tool, keyin, or other process want to change the active settings tab/page giving the current tab/page and opportunity
-     * to save its state.
-     */
-    activateSettingsTab(settingsTabId: string): void;
-    /** Called by application when the Settings Container is to be closed. The function to invoke to actually close the Settings Container is
-     * passed in and executed once the active settings tab/page has a chance to save its settings.
-     */
-    closeSettingsContainer(closeFunc: (args: any) => void, closeFuncArgs?: any): void;
-    addSettingsProvider(settingsProvider: SettingsTabsProvider): void;
-    removeSettingsProvider(providerId: string): boolean;
-    /** Get an array of SettingsTabEntry objects to populate the settings container. */
-    getSettingEntries(stageId: string, stageUsage: string): Array<SettingsTabEntry>;
-}
+/** @packageDocumentation
+ * @module Settings
+ */
+/// <reference types="react" />
+import { BeUiEvent } from "@itwin/core-bentley";
+import { ConditionalBooleanValue } from "@itwin/appui-abstract";
+/** Interface used to populate a tab entry in the SettingContainer control
+ * @public
+ */
+export interface SettingsTabEntry {
+    /** unique id for entry */
+    readonly tabId: string;
+    /** localized display label */
+    readonly label: string;
+    /** Setting page content to display when tab item is selected. */
+    readonly page: JSX.Element;
+    /** Setting to true if page will register to watch for stage closing event so it can save any dirty settings. Page component should register and handle the events:
+     * `settingsManager.onProcessSettingsTabActivation` and `settingsManager.onProcessSettingsContainerClose` */
+    readonly pageWillHandleCloseRequest?: boolean;
+    /** used to determine position in tablist */
+    readonly itemPriority: number;
+    /** Optional Subtitle to show below label. */
+    readonly subLabel?: string;
+    /** Icon specification */
+    readonly icon?: string | JSX.Element;
+    /** Tooltip. Allows JSX|Element to support react-tooltip component */
+    readonly tooltip?: string | JSX.Element;
+    /** Allows Settings entry to be disabled */
+    readonly isDisabled?: boolean | ConditionalBooleanValue;
+}
+/** Event class for [[this.onSettingsProvidersChanged]] which is emitted when a new SettingsTabsProvider is added or removed.
+ * @public
+ */
+export declare class SettingsProvidersChangedEvent extends BeUiEvent<SettingsProvidersChangedEventArgs> {
+}
+/** Arguments of [[this.onSettingsProvidersChanged]] event.
+ * @public
+ */
+export interface SettingsProvidersChangedEventArgs {
+    readonly providers: ReadonlyArray<SettingsTabsProvider>;
+}
+/** Event class for [[this.onProcessSettingsTabActivation]] which is emitted when a new Tab needs to be activated. This allows the current
+ * settings page to save its settings before activating the new SettingTab.
+ * @public
+ */
+export declare class ProcessSettingsTabActivationEvent extends BeUiEvent<ProcessSettingsTabActivationEventArgs> {
+}
+/** Arguments of [[this.onProcessSettingsTabActivation]] event.
+ * @public
+ */
+export interface ProcessSettingsTabActivationEventArgs {
+    readonly tabSelectionFunc: (tabId: string) => void;
+    readonly requestedSettingsTabId: string;
+}
+/** Event class for [[this.onProcessSettingsContainerClose]] which is emitted when the settings container will be closed. This allows the current
+ * settings page to save its settings before calling the function to close the container.
+ * @public
+ */
+export declare class ProcessSettingsContainerCloseEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
+}
+/** Event class for [[this.onCloseSettingsContainer]] which is monitored by the settings container and indicates that some out process want to close the settings container.
+ * @internal
+ */
+export declare class CloseSettingsContainerEvent extends BeUiEvent<ProcessSettingsContainerCloseEventArgs> {
+}
+/** Arguments of [[this.onProcessSettingsContainerClose]] event.
+ * @public
+ */
+export interface ProcessSettingsContainerCloseEventArgs {
+    readonly closeFunc: (args: any) => void;
+    readonly closeFuncArgs?: any;
+}
+/** Event class for [[this.onActivateSettingsTab]] which is emitted when API call needs to set the active settings tab (ie via Tool key-in).
+ * @public
+ */
+export declare class ActivateSettingsTabEvent extends BeUiEvent<ActivateSettingsTabEventArgs> {
+}
+/** Arguments of [[this.onActivateSettingsTab]] event.
+ * @public
+ */
+export interface ActivateSettingsTabEventArgs {
+    readonly settingsTabId: string;
+}
+/** Setting Provider interface. Implemented by classes that want to supply settings pages for display in the SettingContainer. The
+ * classes that implement this interface need to be registered with the [[SettingsManager]].
+ * @public
+ */
+export interface SettingsTabsProvider {
+    /** Id of provider, used to remove registration. */
+    readonly id: string;
+    getSettingEntries(stageId: string, stageUsage: string): ReadonlyArray<SettingsTabEntry> | undefined;
+}
+/** Settings Manager class. Hold registration of settings providers and supplies events for the provided settings pages to listen.
+ * @public
+ */
+export declare class SettingsManager {
+    private _providers;
+    /** Event raised when SettingsProviders are changed.
+     */
+    readonly onSettingsProvidersChanged: SettingsProvidersChangedEvent;
+    /** Event raised solely for a settings page to monitor so it can save its settings before continuing tab activation.
+     * See React hook function `useSaveBeforeActivatingNewSettingsTab`.
+     */
+    readonly onProcessSettingsTabActivation: ProcessSettingsTabActivationEvent;
+    /** Event raised when the settings container will be closed. Any setting page component that is 'modal' should register to
+     * listen to this event so that it can save its state before closing. See React hook function `useSaveBeforeClosingSettingsContainer`.
+     */
+    readonly onProcessSettingsContainerClose: ProcessSettingsContainerCloseEvent;
+    /** Event raised to change the active settings tab shown in UI. Monitored by the SettingsContainer.
+     * @internal
+     */
+    readonly onActivateSettingsTab: ActivateSettingsTabEvent;
+    /** Event monitored by SettingsContainer to process request to close the settings container.
+     * @internal
+     */
+    readonly onCloseSettingsContainer: CloseSettingsContainerEvent;
+    /** @public */
+    get providers(): ReadonlyArray<SettingsTabsProvider>;
+    set providers(p: ReadonlyArray<SettingsTabsProvider>);
+    /** Called by application when an tool, keyin, or other process want to change the active settings tab/page giving the current tab/page and opportunity
+     * to save its state.
+     */
+    activateSettingsTab(settingsTabId: string): void;
+    /** Called by application when the Settings Container is to be closed. The function to invoke to actually close the Settings Container is
+     * passed in and executed once the active settings tab/page has a chance to save its settings.
+     */
+    closeSettingsContainer(closeFunc: (args: any) => void, closeFuncArgs?: any): void;
+    addSettingsProvider(settingsProvider: SettingsTabsProvider): void;
+    removeSettingsProvider(providerId: string): boolean;
+    /** Get an array of SettingsTabEntry objects to populate the settings container. */
+    getSettingEntries(stageId: string, stageUsage: string): Array<SettingsTabEntry>;
+}
 //# sourceMappingURL=SettingsManager.d.ts.map