@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.14

package/lib/cjs/appui-react/feedback/ValidationTextbox.d.ts

@@ -1,74 +1,74 @@
-/** @packageDocumentation
- * @module Notification
- */
-import "./ValidationTextbox.scss";
-import * as React from "react";
-import { CommonProps } from "@itwin/core-react";
-/** Enum for Input Status used in [[ValidationTextbox]]
- * @alpha
- */
-export declare enum InputStatus {
-    Valid = 0,
-    Invalid = 1
-}
-/** Property interface for ValidationTextbox
- * @alpha
- */
-interface ValidationTextboxProps extends CommonProps {
-    /** value to set ValidationTextbox to initially */
-    initialValue?: string;
-    /** placeholder value to show in gray before anything is entered in */
-    placeholder?: string;
-    /** triggered when the content of ValidationTextbox is changed. Return true if valid */
-    onValueChanged?: (value: string) => InputStatus;
-    /** listens for <Enter> key presses */
-    onEnterPressed?: () => void;
-    /** listens for <Esc> key presses */
-    onEscPressed?: () => void;
-    /** width of ValidationTextbox, measured in em */
-    size?: number;
-    /** Error message to display */
-    errorText?: string;
-    /** Detailed error message to display */
-    detailedErrorText?: string;
-    /** Content */
-    children?: React.ReactNode;
-}
-interface ValidationTextboxState {
-    isValid: boolean;
-}
-/**
- * Input box that validates text based on provided criteria. Defaults to checking
- * for empty if no method for onValueChanged is provided.
- * @alpha
- */
-export declare class ValidationTextbox extends React.PureComponent<ValidationTextboxProps, ValidationTextboxState> {
-    constructor(props: ValidationTextboxProps);
-    /** @internal */
-    render(): React.ReactNode;
-    private processValidateText;
-    /**
-     * Determines if value is valid and resolves any defined functions.
-     * Also will show or hide error message if defined.
-     * @param event   Button press event that triggers validation
-     */
-    private _validateText;
-    /**
-     * Determines if value provided is valid by calling user defined
-     * function. If no function is provided, the default criteria for
-     * validity is if the value has been defined.
-     * @param value   The value provided in textbox
-     */
-    private _calculateIsValid;
-    /** Hides error message */
-    private _hideErrorMessage;
-    /** Displays error message. */
-    private _showErrorMessage;
-    /**
-     * Manages special key codes by calling user defined functions
-     * @param event   Keyup event
-     */
-    private _handleKeyUp;
-}
-export {};
+/** @packageDocumentation
+ * @module Notification
+ */
+import "./ValidationTextbox.scss";
+import * as React from "react";
+import { CommonProps } from "@itwin/core-react";
+/** Enum for Input Status used in [[ValidationTextbox]]
+ * @alpha
+ */
+export declare enum InputStatus {
+    Valid = 0,
+    Invalid = 1
+}
+/** Property interface for ValidationTextbox
+ * @alpha
+ */
+interface ValidationTextboxProps extends CommonProps {
+    /** value to set ValidationTextbox to initially */
+    initialValue?: string;
+    /** placeholder value to show in gray before anything is entered in */
+    placeholder?: string;
+    /** triggered when the content of ValidationTextbox is changed. Return true if valid */
+    onValueChanged?: (value: string) => InputStatus;
+    /** listens for <Enter> key presses */
+    onEnterPressed?: () => void;
+    /** listens for <Esc> key presses */
+    onEscPressed?: () => void;
+    /** width of ValidationTextbox, measured in em */
+    size?: number;
+    /** Error message to display */
+    errorText?: string;
+    /** Detailed error message to display */
+    detailedErrorText?: string;
+    /** Content */
+    children?: React.ReactNode;
+}
+interface ValidationTextboxState {
+    isValid: boolean;
+}
+/**
+ * Input box that validates text based on provided criteria. Defaults to checking
+ * for empty if no method for onValueChanged is provided.
+ * @alpha
+ */
+export declare class ValidationTextbox extends React.PureComponent<ValidationTextboxProps, ValidationTextboxState> {
+    constructor(props: ValidationTextboxProps);
+    /** @internal */
+    render(): React.ReactNode;
+    private processValidateText;
+    /**
+     * Determines if value is valid and resolves any defined functions.
+     * Also will show or hide error message if defined.
+     * @param event   Button press event that triggers validation
+     */
+    private _validateText;
+    /**
+     * Determines if value provided is valid by calling user defined
+     * function. If no function is provided, the default criteria for
+     * validity is if the value has been defined.
+     * @param value   The value provided in textbox
+     */
+    private _calculateIsValid;
+    /** Hides error message */
+    private _hideErrorMessage;
+    /** Displays error message. */
+    private _showErrorMessage;
+    /**
+     * Manages special key codes by calling user defined functions
+     * @param event   Keyup event
+     */
+    private _handleKeyUp;
+}
+export {};
 //# sourceMappingURL=ValidationTextbox.d.ts.map

package/lib/cjs/appui-react/feedback/ValidationTextbox.js

@@ -1,116 +1,116 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Notification
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidationTextbox = exports.InputStatus = void 0;
-require("./ValidationTextbox.scss");
-const classnames_1 = require("classnames");
-const React = require("react");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const MessageManager_1 = require("../messages/MessageManager");
-const itwinui_react_1 = require("@itwin/itwinui-react");
-/** Enum for Input Status used in [[ValidationTextbox]]
- * @alpha
- */
-var InputStatus;
-(function (InputStatus) {
-    InputStatus[InputStatus["Valid"] = 0] = "Valid";
-    InputStatus[InputStatus["Invalid"] = 1] = "Invalid";
-})(InputStatus = exports.InputStatus || (exports.InputStatus = {}));
-/**
- * Input box that validates text based on provided criteria. Defaults to checking
- * for empty if no method for onValueChanged is provided.
- * @alpha
- */
-class ValidationTextbox extends React.PureComponent {
-    constructor(props) {
-        super(props);
-        /**
-         * Determines if value is valid and resolves any defined functions.
-         * Also will show or hide error message if defined.
-         * @param event   Button press event that triggers validation
-         */
-        this._validateText = (event) => {
-            this.processValidateText(event.target);
-        };
-        /**
-         * Manages special key codes by calling user defined functions
-         * @param event   Keyup event
-         */
-        this._handleKeyUp = (event) => {
-            this.processValidateText(event.target);
-            switch (event.key) {
-                case appui_abstract_1.SpecialKey.Escape:
-                    // istanbul ignore else
-                    if (this.props.onEscPressed)
-                        this.props.onEscPressed();
-                    break;
-                case appui_abstract_1.SpecialKey.Enter:
-                    // istanbul ignore else
-                    if (this.props.onEnterPressed)
-                        this.props.onEnterPressed();
-                    break;
-            }
-        };
-        this.state = { isValid: true };
-    }
-    /** @internal */
-    render() {
-        const sizeStyle = {
-            width: this.props.size ? `${this.props.size.toString()}em` : "12em",
-        };
-        const divStyle = {
-            ...sizeStyle,
-            ...this.props.style,
-        };
-        const validClassNames = (0, classnames_1.default)("ValidationTextbox-input");
-        const invalidClassNames = (0, classnames_1.default)("ValidationTextbox-input", "ValidationTextbox-invalid");
-        return (React.createElement("div", { className: (0, classnames_1.default)("uifw-ValidationTextbox", this.props.className), style: divStyle },
-            React.createElement(itwinui_react_1.Input, { className: this.state.isValid ? validClassNames : invalidClassNames, onChange: this._validateText, onKeyUp: this._handleKeyUp, onPaste: this._validateText, onCut: this._validateText, onBlur: this._validateText, placeholder: this.props.placeholder ? this.props.placeholder : "", style: sizeStyle }),
-            this.props.children));
-    }
-    processValidateText(target) {
-        // istanbul ignore next
-        if (undefined === target)
-            return;
-        const value = target.value;
-        const isValid = this._calculateIsValid(value);
-        this.setState({ isValid }, () => {
-            if (this.state.isValid) {
-                this._hideErrorMessage();
-            }
-            else {
-                // istanbul ignore else
-                if (this.props.errorText && !this.state.isValid)
-                    this._showErrorMessage(target);
-            }
-        });
-    }
-    /**
-     * Determines if value provided is valid by calling user defined
-     * function. If no function is provided, the default criteria for
-     * validity is if the value has been defined.
-     * @param value   The value provided in textbox
-     */
-    _calculateIsValid(value) {
-        if (this.props.onValueChanged)
-            return (this.props.onValueChanged(value) === InputStatus.Valid) ? /* istanbul ignore next */ true : false;
-        return value.length > 0;
-    }
-    /** Hides error message */
-    _hideErrorMessage() {
-        MessageManager_1.MessageManager.hideInputFieldMessage();
-    }
-    /** Displays error message. */
-    _showErrorMessage(target) {
-        MessageManager_1.MessageManager.displayInputFieldMessage(target, this.props.errorText, this.props.detailedErrorText);
-        return;
-    }
-}
-exports.ValidationTextbox = ValidationTextbox;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Notification
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationTextbox = exports.InputStatus = void 0;
+require("./ValidationTextbox.scss");
+const classnames_1 = require("classnames");
+const React = require("react");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const MessageManager_1 = require("../messages/MessageManager");
+const itwinui_react_1 = require("@itwin/itwinui-react");
+/** Enum for Input Status used in [[ValidationTextbox]]
+ * @alpha
+ */
+var InputStatus;
+(function (InputStatus) {
+    InputStatus[InputStatus["Valid"] = 0] = "Valid";
+    InputStatus[InputStatus["Invalid"] = 1] = "Invalid";
+})(InputStatus = exports.InputStatus || (exports.InputStatus = {}));
+/**
+ * Input box that validates text based on provided criteria. Defaults to checking
+ * for empty if no method for onValueChanged is provided.
+ * @alpha
+ */
+class ValidationTextbox extends React.PureComponent {
+    constructor(props) {
+        super(props);
+        /**
+         * Determines if value is valid and resolves any defined functions.
+         * Also will show or hide error message if defined.
+         * @param event   Button press event that triggers validation
+         */
+        this._validateText = (event) => {
+            this.processValidateText(event.target);
+        };
+        /**
+         * Manages special key codes by calling user defined functions
+         * @param event   Keyup event
+         */
+        this._handleKeyUp = (event) => {
+            this.processValidateText(event.target);
+            switch (event.key) {
+                case appui_abstract_1.SpecialKey.Escape:
+                    // istanbul ignore else
+                    if (this.props.onEscPressed)
+                        this.props.onEscPressed();
+                    break;
+                case appui_abstract_1.SpecialKey.Enter:
+                    // istanbul ignore else
+                    if (this.props.onEnterPressed)
+                        this.props.onEnterPressed();
+                    break;
+            }
+        };
+        this.state = { isValid: true };
+    }
+    /** @internal */
+    render() {
+        const sizeStyle = {
+            width: this.props.size ? `${this.props.size.toString()}em` : "12em",
+        };
+        const divStyle = {
+            ...sizeStyle,
+            ...this.props.style,
+        };
+        const validClassNames = (0, classnames_1.default)("ValidationTextbox-input");
+        const invalidClassNames = (0, classnames_1.default)("ValidationTextbox-input", "ValidationTextbox-invalid");
+        return (React.createElement("div", { className: (0, classnames_1.default)("uifw-ValidationTextbox", this.props.className), style: divStyle },
+            React.createElement(itwinui_react_1.Input, { className: this.state.isValid ? validClassNames : invalidClassNames, onChange: this._validateText, onKeyUp: this._handleKeyUp, onPaste: this._validateText, onCut: this._validateText, onBlur: this._validateText, placeholder: this.props.placeholder ? this.props.placeholder : "", style: sizeStyle }),
+            this.props.children));
+    }
+    processValidateText(target) {
+        // istanbul ignore next
+        if (undefined === target)
+            return;
+        const value = target.value;
+        const isValid = this._calculateIsValid(value);
+        this.setState({ isValid }, () => {
+            if (this.state.isValid) {
+                this._hideErrorMessage();
+            }
+            else {
+                // istanbul ignore else
+                if (this.props.errorText && !this.state.isValid)
+                    this._showErrorMessage(target);
+            }
+        });
+    }
+    /**
+     * Determines if value provided is valid by calling user defined
+     * function. If no function is provided, the default criteria for
+     * validity is if the value has been defined.
+     * @param value   The value provided in textbox
+     */
+    _calculateIsValid(value) {
+        if (this.props.onValueChanged)
+            return (this.props.onValueChanged(value) === InputStatus.Valid) ? /* istanbul ignore next */ true : false;
+        return value.length > 0;
+    }
+    /** Hides error message */
+    _hideErrorMessage() {
+        MessageManager_1.MessageManager.hideInputFieldMessage();
+    }
+    /** Displays error message. */
+    _showErrorMessage(target) {
+        MessageManager_1.MessageManager.displayInputFieldMessage(target, this.props.errorText, this.props.detailedErrorText);
+        return;
+    }
+}
+exports.ValidationTextbox = ValidationTextbox;
 //# sourceMappingURL=ValidationTextbox.js.map

package/lib/cjs/appui-react/feedback/ValidationTextbox.scss

@@ -5,7 +5,6 @@
 @import "~@itwin/core-react/lib/cjs/core-react/icons/variables";
 @import "~@itwin/core-react/lib/cjs/core-react/inputs/variables";
 @import "~@itwin/core-react/lib/cjs/core-react/style/themecolors";
-@import "~@itwin/core-react/lib/cjs/core-react/style/variables";
 
 .uifw-ValidationTextbox {
   font-family: var(--iui-font-sans);
@@ -16,7 +15,7 @@
 
   .ValidationTextbox-input {
     position: absolute;
-    min-height: $uicore-component-height-normal;
+    min-height: 28px;
     padding: $uicore-iui-input-padding;
     width: 12em;
     left: 0px;

package/lib/cjs/appui-react/framework/FrameworkBackstage.d.ts

@@ -1,44 +1,44 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { IconSpec } from "@itwin/core-react";
-import { CommandItemDef } from "../shared/CommandItemDef";
-/** Arguments of [[Backstage.onToggled]].
- * @public
- */
-export interface BackstageToggledArgs {
-    readonly isOpen: boolean;
-}
-/**
- * [[UiFramework.backstage]] interface.
- * @public
- */
-export interface FrameworkBackstage {
-    /**
-     * Event activated when the backstage is toggled.
-     */
-    readonly onToggled: BeEvent<(args: BackstageToggledArgs) => void>;
-    /**
-     * State of the backstage.
-     */
-    readonly isOpen: boolean;
-    /**
-     * Display the backstage.
-     */
-    open(): void;
-    /**
-     * Hides the backstage.
-     */
-    close(): void;
-    /**
-     * Toggle the backstage.
-     */
-    toggle(): void;
-    /**
-     * Creates a CommandItemDef that toggle the backstage.
-     * @param overrideIconSpec Icon to replace the default 'home'.
-     */
-    getBackstageToggleCommand(overrideIconSpec?: IconSpec): CommandItemDef;
-}
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { IconSpec } from "@itwin/core-react";
+import { CommandItemDef } from "../shared/CommandItemDef";
+/** Arguments of [[Backstage.onToggled]].
+ * @public
+ */
+export interface BackstageToggledArgs {
+    readonly isOpen: boolean;
+}
+/**
+ * [[UiFramework.backstage]] interface.
+ * @public
+ */
+export interface FrameworkBackstage {
+    /**
+     * Event activated when the backstage is toggled.
+     */
+    readonly onToggled: BeEvent<(args: BackstageToggledArgs) => void>;
+    /**
+     * State of the backstage.
+     */
+    readonly isOpen: boolean;
+    /**
+     * Display the backstage.
+     */
+    open(): void;
+    /**
+     * Hides the backstage.
+     */
+    close(): void;
+    /**
+     * Toggle the backstage.
+     */
+    toggle(): void;
+    /**
+     * Creates a CommandItemDef that toggle the backstage.
+     * @param overrideIconSpec Icon to replace the default 'home'.
+     */
+    getBackstageToggleCommand(overrideIconSpec?: IconSpec): CommandItemDef;
+}
 //# sourceMappingURL=FrameworkBackstage.d.ts.map

package/lib/cjs/appui-react/framework/FrameworkBackstage.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Backstage
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Backstage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=FrameworkBackstage.js.map

package/lib/cjs/appui-react/framework/FrameworkChildWindows.d.ts

@@ -1,76 +1,76 @@
-/** @packageDocumentation
- * @module ChildWindowManager
- */
-/// <reference types="react" />
-/** @public */
-export interface OpenChildWindowInfo {
-    childWindowId: string;
-    window: Window;
-    parentWindow: Window;
-}
-/** @public */
-export interface ChildWindowLocationProps {
-    width: number;
-    height: number;
-    left: number;
-    top: number;
-}
-/**
- * Basic recreation of the `createRoot` function type, intentionally not exported.
- */
-declare type CreateRoot = (container: Element | DocumentFragment) => {
-    render(children: React.ReactNode): void;
-};
-/**
- * [[UiFramework.childWindows]] interface.
- * @beta
- */
-export interface FrameworkChildWindows {
-    /**
-     * List of currently open child windows;
-     */
-    readonly openChildWindows: OpenChildWindowInfo[];
-    /**
-     * When using React18, the `createRoot` function must be provided in order to render Popout content with React18.
-     * Do not call if using React 17 or before.
-     *
-     * Note: The type of the function is intentionally simplified here.
-     *
-     * @param createRootFn Function imported from `import { createRoot } from "react-dom/client";`
-     * @beta Will be removed once the transition to react 18 is complete.
-     */
-    useCreateRoot(createRootFn: CreateRoot): void;
-    /**
-     * Returns the OpenChildWindowInfo for the related id.
-     * @param childWindowId Id of the window to retrieve.
-     * @returns undefined if not found.
-     */
-    find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;
-    /**
-     * Return the childWindowId of the provided window.
-     * @param contentWindow Window element to identify
-     * @returns undefined if not found
-     */
-    findId(contentWindow: Window | undefined | null): string | undefined;
-    /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */
-    closeAll(): void;
-    /**
-     * Close a specific child window.
-     * @param childWindowId Id of the window to close
-     * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)
-     * @returns false if the window could not be found.
-     */
-    close(childWindowId: string, processWindowClose?: boolean): boolean;
-    /**
-     * Open a new child window.
-     * @param childWindowId Id to assign to the newly created window.
-     * @param title Title to display on the window.
-     * @param content ReactNode to be rendered in the window.
-     * @param location Position and size information
-     * @param useDefaultPopoutUrl use "/iTwinPopup.html" as the window Url, "" otherwise.
-     * @returns true if the window is opened successfully.
-     */
-    open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;
-}
-export {};
+/** @packageDocumentation
+ * @module ChildWindowManager
+ */
+/// <reference types="react" />
+/** @public */
+export interface OpenChildWindowInfo {
+    childWindowId: string;
+    window: Window;
+    parentWindow: Window;
+}
+/** @public */
+export interface ChildWindowLocationProps {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+}
+/**
+ * Basic recreation of the `createRoot` function type, intentionally not exported.
+ */
+type CreateRoot = (container: Element | DocumentFragment) => {
+    render(children: React.ReactNode): void;
+};
+/**
+ * [[UiFramework.childWindows]] interface.
+ * @beta
+ */
+export interface FrameworkChildWindows {
+    /**
+     * List of currently open child windows;
+     */
+    readonly openChildWindows: OpenChildWindowInfo[];
+    /**
+     * When using React18, the `createRoot` function must be provided in order to render Popout content with React18.
+     * Do not call if using React 17 or before.
+     *
+     * Note: The type of the function is intentionally simplified here.
+     *
+     * @param createRootFn Function imported from `import { createRoot } from "react-dom/client";`
+     * @beta Will be removed once the transition to react 18 is complete.
+     */
+    useCreateRoot(createRootFn: CreateRoot): void;
+    /**
+     * Returns the OpenChildWindowInfo for the related id.
+     * @param childWindowId Id of the window to retrieve.
+     * @returns undefined if not found.
+     */
+    find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;
+    /**
+     * Return the childWindowId of the provided window.
+     * @param contentWindow Window element to identify
+     * @returns undefined if not found
+     */
+    findId(contentWindow: Window | undefined | null): string | undefined;
+    /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */
+    closeAll(): void;
+    /**
+     * Close a specific child window.
+     * @param childWindowId Id of the window to close
+     * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)
+     * @returns false if the window could not be found.
+     */
+    close(childWindowId: string, processWindowClose?: boolean): boolean;
+    /**
+     * Open a new child window.
+     * @param childWindowId Id to assign to the newly created window.
+     * @param title Title to display on the window.
+     * @param content ReactNode to be rendered in the window.
+     * @param location Position and size information
+     * @param useDefaultPopoutUrl use "/iTwinPopup.html" as the window Url, "" otherwise.
+     * @returns true if the window is opened successfully.
+     */
+    open(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;
+}
+export {};
 //# sourceMappingURL=FrameworkChildWindows.d.ts.map