@itwin/appui-react 3.0.0-dev.100

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# @itwin/appui-react
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
+
+## Description
+
+The __@itwin/appui-react__ package contains application fragments for Login, Project, iModel and View selection, and configuration of the application UI including the Backstage, Frontstages, Widgets, etc.
+
+The ui-framework package is a portion of the iTwin.js User Interface library. It consists of major fragments of code that combine the
+functionality from the imodeljs-frontend and imodeljs client packages with the ui-core, ui-components and ui-ninezone packages to implement substantial
+functionality that can be used within an iTwin.js application.
+
+The ui-framework package makes use of React for rendering of the user interface, and uses react-redux and its concept of the state store for
+actions using reducers.
+
+There are a number of sub-frameworks, each which has a set of components, actions, and reducers, and contributes to the overall State. Each such
+sub-framework is contained in a separate folder.
+
+## Documentation
+
+See the [iTwin.js](https://www.itwinjs.org) documentation for more information.

package/lib/cjs/appui-react/UiFramework.d.ts

@@ -0,0 +1,197 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { Store } from "redux";
+import { GuidString } from "@itwin/core-bentley";
+import { Localization } from "@itwin/core-common";
+import { IModelConnection, SnapMode, ViewState } from "@itwin/core-frontend";
+import { SettingsManager, UiEvent, UiSettingsStorage } from "@itwin/core-react";
+import { BackstageManager } from "./backstage/BackstageManager";
+import { ChildWindowManager } from "./childwindow/ChildWindowManager";
+import { FrameworkState } from "./redux/FrameworkState";
+import { CursorMenuData, PresentationSelectionScope } from "./redux/SessionState";
+import { HideIsolateEmphasizeActionHandler } from "./selection/HideIsolateEmphasizeManager";
+import { UserInfo } from "./UserInfo";
+import { WidgetManager } from "./widgets/WidgetManager";
+/** Defined that available Ui Versions. It is recommended to always use the latest version available.
+ * @public
+ */
+export declare type FrameworkVersionId = "1" | "2";
+/** Interface to be implemented but any classes that wants to load their user settings when the UiSetting storage class is set.
+ * @public
+ */
+export interface UserSettingsProvider {
+    /** Unique provider Id */
+    providerId: string;
+    /** Function to load settings from settings storage */
+    loadUserSettings(storage: UiSettingsStorage): Promise<void>;
+}
+/** UiVisibility Event Args interface.
+ * @public
+ */
+export interface UiVisibilityEventArgs {
+    visible: boolean;
+}
+/** UiVisibility Event class.
+ * @public
+ */
+export declare class UiVisibilityChangedEvent extends UiEvent<UiVisibilityEventArgs> {
+}
+/** FrameworkVersion Changed Event Args interface.
+ * @internal
+ */
+export interface FrameworkVersionChangedEventArgs {
+    oldVersion: FrameworkVersionId;
+    version: FrameworkVersionId;
+}
+/** FrameworkVersion Changed Event class.
+ * @internal
+ */
+export declare class FrameworkVersionChangedEvent extends UiEvent<FrameworkVersionChangedEventArgs> {
+}
+/** TrackingTime time argument used by our feature tracking manager as an option argument to the TelemetryClient
+ * @internal
+ */
+export interface TrackingTime {
+    startTime: Date;
+    endTime: Date;
+}
+/**
+ * Manages the Redux store, localization service and iModel, Project and Login services for the ui-framework package.
+ * @public
+ */
+export declare class UiFramework {
+    private static _initialized;
+    private static _store?;
+    private static _complaint;
+    private static _frameworkStateKeyInStore;
+    private static _backstageManager?;
+    private static _widgetManager?;
+    private static _uiVersion;
+    private static _hideIsolateEmphasizeActionHandler?;
+    private static _uiSettingsStorage;
+    private static _settingsManager?;
+    private static _uiSettingsProviderRegistry;
+    private static _PopupWindowManager;
+    static useDefaultPopoutUrl: boolean;
+    /** @public */
+    static get childWindowManager(): ChildWindowManager;
+    /** Registers class that will be informed when the UserSettingsStorage location has been set or changed. This allows
+     * classes to load any previously saved settings from the new storage location. Common storage locations are the browser's
+     * local storage, or the iTwin Product Settings cloud storage available via the SettingsAdmin see `IModelApp.settingsAdmin`.
+     * @beta
+     */
+    static registerUserSettingsProvider(entry: UserSettingsProvider): boolean;
+    /** Get Show Ui event.
+     * @public
+     */
+    static readonly onUiVisibilityChanged: UiVisibilityChangedEvent;
+    /**
+     * Called by the application to initialize the UiFramework. Also initializes UIIModelComponents, UiComponents, UiCore.
+     * @param store The single Redux store created by the host application. If this is `undefined` then it is assumed that the [[StateManager]] is being used to provide the Redux store.
+     * @param frameworkStateKey The name of the key used by the app when adding the UiFramework state into the Redux store. If not defined "frameworkState" is assumed. This value is ignored if [[StateManager]] is being used. The StateManager use "frameworkState".
+     */
+    static initialize(store: Store<any> | undefined, frameworkStateKey?: string): Promise<void>;
+    /**
+     * Called by the application to initialize the UiFramework. Also initializes UIIModelComponents, UiComponents, UiCore.
+     * @param store The single Redux store created by the host application. If this is `undefined` then it is assumed that the [[StateManager]] is being used to provide the Redux store.
+     * @param frameworkStateKey The name of the key used by the app when adding the UiFramework state into the Redux store. If not defined "frameworkState" is assumed. This value is ignored if [[StateManager]] is being used. The StateManager use "frameworkState".
+     *
+     * @internal
+     */
+    static initializeEx(store: Store<any> | undefined, frameworkStateKey?: string): Promise<void>;
+    /** Un-registers the UiFramework internationalization service namespace */
+    static terminate(): void;
+    /** Determines if UiFramework has been initialized */
+    static get initialized(): boolean;
+    /** Property that returns the SettingManager used by AppUI-based applications.
+     *  @public */
+    static get settingsManager(): SettingsManager;
+    /** @public */
+    static get frameworkStateKey(): string;
+    /** The UiFramework state maintained by Redux
+     * @public
+     */
+    static get frameworkState(): FrameworkState | undefined;
+    /** The Redux store */
+    static get store(): Store<any>;
+    /** The internationalization service created by the app.
+     * @internal
+    */
+    static get localization(): Localization;
+    /** The internationalization service namespace. */
+    static get localizationNamespace(): string;
+    /** @public */
+    static get backstageManager(): BackstageManager;
+    /** @alpha */
+    static get hideIsolateEmphasizeActionHandler(): HideIsolateEmphasizeActionHandler;
+    /** @alpha */
+    static setHideIsolateEmphasizeActionHandler(handler: HideIsolateEmphasizeActionHandler | undefined): void;
+    /** @alpha */
+    static get widgetManager(): WidgetManager;
+    /** Calls localization.getLocalizedStringWithNamespace with the "UiFramework" namespace. Do NOT include the namespace in the key.
+     * @internal
+     */
+    static translate(key: string | string[]): string;
+    /** @internal */
+    static get packageName(): string;
+    /** @internal */
+    static loggerCategory(obj: any): string;
+    static dispatchActionToStore(type: string, payload: any, immediateSync?: boolean): void;
+    static setAccudrawSnapMode(snapMode: SnapMode): void;
+    static getAccudrawSnapMode(): SnapMode;
+    static getActiveSelectionScope(): string;
+    static setActiveSelectionScope(selectionScopeId: string): void;
+    /** @public */
+    static openCursorMenu(menuData: CursorMenuData | undefined): void;
+    /** @public */
+    static closeCursorMenu(): void;
+    /** @public */
+    static getCursorMenuData(): CursorMenuData | undefined;
+    static getActiveIModelId(): string;
+    static setActiveIModelId(iModelId: string): void;
+    static setIModelConnection(iModelConnection: IModelConnection | undefined, immediateSync?: boolean): void;
+    static getIModelConnection(): IModelConnection | undefined;
+    /** @public */
+    static setUiSettingsStorage(storage: UiSettingsStorage, immediateSync?: boolean): Promise<void>;
+    /** @public */
+    static getUiSettingsStorage(): UiSettingsStorage;
+    /** @public */
+    static setUserInfo(userInfo: UserInfo | undefined, immediateSync?: boolean): void;
+    /** @public */
+    static getUserInfo(): UserInfo | undefined;
+    static setDefaultIModelViewportControlId(iModelViewportControlId: string, immediateSync?: boolean): void;
+    static getDefaultIModelViewportControlId(): string | undefined;
+    static setDefaultViewId(viewId: string, immediateSync?: boolean): void;
+    static getDefaultViewId(): string | undefined;
+    static setDefaultViewState(viewState: ViewState, immediateSync?: boolean): void;
+    static getDefaultViewState(): ViewState | undefined;
+    /** @public */
+    static getAvailableSelectionScopes(): PresentationSelectionScope[];
+    static getIsUiVisible(): boolean;
+    static setIsUiVisible(visible: boolean): void;
+    static setColorTheme(theme: string): void;
+    static getColorTheme(): string;
+    static setWidgetOpacity(opacity: number): void;
+    static getWidgetOpacity(): number;
+    static isMobile(): boolean;
+    /** Returns the Ui Version.
+     * @public
+     */
+    static get uiVersion(): FrameworkVersionId;
+    static setUiVersion(version: FrameworkVersionId): void;
+    static get useDragInteraction(): boolean;
+    static setUseDragInteraction(useDragInteraction: boolean): void;
+    /** Send logging message to the telemetry system
+     * @internal
+     */
+    static postTelemetry(eventName: string, eventId?: GuidString, iTwinId?: GuidString, iModeId?: GuidString, changeSetId?: string, time?: TrackingTime, additionalProperties?: {
+        [key: string]: any;
+    }): Promise<void>;
+    private static _handleFrameworkVersionChangedEvent;
+    /** Determines whether a ContextMenu is open
+     * @alpha
+     * */
+    static get isContextMenuOpen(): boolean;
+}
+//# sourceMappingURL=UiFramework.d.ts.map

package/lib/cjs/appui-react/UiFramework.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiFramework.d.ts","sourceRoot":"","sources":["../../../src/appui-react/UiFramework.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAe,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAa,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAIxF,OAAO,EAAwB,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtG,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAGtE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAwB,MAAM,sBAAsB,CAAC;AAExG,OAAO,EAAE,iCAAiC,EAA+B,MAAM,yCAAyC,CAAC;AAOzH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAKxD;;GAEG;AACH,oBAAY,kBAAkB,GAAG,GAAG,GAAG,GAAG,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,qBAAqB,CAAC;CAAI;AAEhF;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,OAAO,CAAC,gCAAgC,CAAC;CAAI;AAE/F;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAa;IACnC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAiC;IAC1D,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAA4B;IACpE,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAmB;IACpD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAgB;IAC9C,OAAO,CAAC,MAAM,CAAC,UAAU,CAA2B;IACpD,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAoC;IACtF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAiD;IAClF,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAkB;IAClD,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA8E;IACxH,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAA4B;IAC9D,OAAc,mBAAmB,UAAS;IAE1C,cAAc;IACd,WAAkB,kBAAkB,IAAI,kBAAkB,CAEzD;IAED;;;;OAIG;WACW,4BAA4B,CAAC,KAAK,EAAE,oBAAoB;IAQtE;;OAEG;IACH,gBAAuB,qBAAqB,2BAAkC;IAE9E;;;;OAIG;WACiB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxG;;;;;;OAMG;WACiB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiD1G,0EAA0E;WAC5D,SAAS;IAiBvB,qDAAqD;IACrD,WAAkB,WAAW,IAAI,OAAO,CAAqC;IAE7E;kBACc;IACd,WAAkB,eAAe,oBAIhC;IAED,cAAc;IACd,WAAkB,iBAAiB,IAAI,MAAM,CAE5C;IAED;;OAEG;IACH,WAAkB,cAAc,IAAI,cAAc,GAAG,SAAS,CAO7D;IAED,sBAAsB;IACtB,WAAkB,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,CAUpC;IAED;;MAEE;IACF,WAAkB,YAAY,IAAI,YAAY,CAK7C;IAED,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;IAED,cAAc;IACd,WAAkB,gBAAgB,IAAI,gBAAgB,CAKrD;IAED,aAAa;IACb,WAAkB,iCAAiC,IAAI,iCAAiC,CAKvF;IAED,aAAa;WACC,oCAAoC,CAAC,OAAO,EAAE,iCAAiC,GAAG,SAAS;IAQzG,aAAa;IACb,WAAkB,aAAa,IAAI,aAAa,CAK/C;IAED;;OAEG;WACW,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IAIvD,gBAAgB;IAChB,WAAkB,WAAW,IAAI,MAAM,CAEtC;IAED,gBAAgB;WACF,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;WAMhC,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,aAAa,UAAQ;WAQvE,mBAAmB,CAAC,QAAQ,EAAE,QAAQ;WAItC,mBAAmB,IAAI,QAAQ;WAI/B,uBAAuB,IAAI,MAAM;WAIjC,uBAAuB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAYrE,cAAc;WACA,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI;IAIxE,cAAc;WACA,eAAe,IAAI,IAAI;IAIrC,cAAc;WACA,iBAAiB,IAAI,cAAc,GAAG,SAAS;WAI/C,iBAAiB,IAAI,MAAM;WAI3B,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;WAIzC,mBAAmB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,EAAE,aAAa,UAAQ;WAYzF,mBAAmB,IAAI,gBAAgB,GAAG,SAAS;IAIjE,cAAc;WACM,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,UAAQ;IAmB1F,cAAc;WACA,oBAAoB,IAAI,iBAAiB;IAIvD,cAAc;WACA,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,EAAE,aAAa,UAAQ;IAI/E,cAAc;WACA,WAAW,IAAI,QAAQ,GAAG,SAAS;WAInC,iCAAiC,CAAC,uBAAuB,EAAE,MAAM,EAAE,aAAa,UAAQ;WAIxF,iCAAiC,IAAI,MAAM,GAAG,SAAS;WAIvD,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,UAAQ;WAItD,gBAAgB,IAAI,MAAM,GAAG,SAAS;WAItC,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,aAAa,UAAQ;WAG/D,mBAAmB,IAAI,SAAS,GAAG,SAAS;IAI1D,cAAc;WACA,2BAA2B,IAAI,0BAA0B,EAAE;WAO3D,cAAc;WAId,cAAc,CAAC,OAAO,EAAE,OAAO;WAO/B,aAAa,CAAC,KAAK,EAAE,MAAM;WAO3B,aAAa,IAAI,MAAM;WAIvB,gBAAgB,CAAC,OAAO,EAAE,MAAM;WAOhC,gBAAgB,IAAI,MAAM;WAI1B,QAAQ;IAItB;;OAEG;IACH,WAAkB,SAAS,IAAI,kBAAkB,CAEhD;WAEa,YAAY,CAAC,OAAO,EAAE,kBAAkB;IAOtD,WAAkB,kBAAkB,IAAI,OAAO,CAE9C;WAEa,qBAAqB,CAAC,kBAAkB,EAAE,OAAO;IAI/D;;OAEG;WAEiB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,EAAE,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB/N,OAAO,CAAC,MAAM,CAAC,mCAAmC,CAMhD;IAEF;;SAEK;IACL,WAAkB,iBAAiB,IAAI,OAAO,CAG7C;CAEF"}