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

package/lib/esm/components-react/propertygrid/dataproviders/filterers/PropertyDataFiltererBase.d.ts

@@ -1,90 +1,90 @@
-/** @packageDocumentation
- * @module PropertyGrid
- */
-import { PropertyRecord } from "@itwin/appui-abstract";
-import { BeEvent } from "@itwin/core-bentley";
-import { PropertyCategory } from "../../PropertyDataProvider";
-/**
- * Enumeration of possible component filtered types
- * @public
- */
-export declare enum FilteredType {
-    Category = 0,
-    Label = 1,
-    Value = 2
-}
-/**
- * Data structure for storing [[IPropertyDataFilterer]] matching results
- * @public
- */
-export interface PropertyDataFilterResult {
-    /** Indicates whether provided item matched filter */
-    matchesFilter: boolean;
-    /**
-     * Indicates whether descendants nodes should be forcefully included in filtered results.
-     * Can only be true for nodes that have `matchesFilter` set to true.
-     */
-    shouldForceIncludeDescendants?: boolean;
-    /**
-     * Indicates whether parents of node should be expanded up to this match node.
-     * Can only be true for nodes that have `matchesFilter` set to true.
-     */
-    shouldExpandNodeParents?: boolean;
-    /**
-     * Indicates how many times filter was matched in the provided item.
-     */
-    matchesCount?: number;
-    /**
-     * Indicates what item types were matched.
-     */
-    filteredTypes?: FilteredType[];
-}
-/**
- * A signature for property data change listeners
- * @public
- */
-export declare type PropertyFilterChangesListener = () => void;
-/**
- * An event broadcasted when property filter changes
- * @public
- */
-export declare class PropertyFilterChangeEvent extends BeEvent<PropertyFilterChangesListener> {
-}
-/**
- * An interface for a filterer that filters [[PropertyData]] based on content of [[PropertyRecord]]
- * and [[PropertyCategory]] objects.
- * @public
- */
-export interface IPropertyDataFilterer {
-    readonly isActive: boolean;
-    recordMatchesFilter: (node: PropertyRecord, parents: PropertyRecord[]) => Promise<PropertyDataFilterResult>;
-    categoryMatchesFilter: (node: PropertyCategory, parents: PropertyCategory[]) => Promise<PropertyDataFilterResult>;
-    onFilterChanged: PropertyFilterChangeEvent;
-}
-/**
- * An abstract implementation of [[IPropertyDataFilterer]] to share common behavior between different implementations.
- * @public
- */
-export declare abstract class PropertyDataFiltererBase implements IPropertyDataFilterer {
-    onFilterChanged: PropertyFilterChangeEvent;
-    abstract get isActive(): boolean;
-    abstract recordMatchesFilter(node: PropertyRecord, parents: PropertyRecord[]): Promise<PropertyDataFilterResult>;
-    abstract categoryMatchesFilter(node: PropertyCategory, parents: PropertyCategory[]): Promise<PropertyDataFilterResult>;
-}
-/**
- * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
- * filterers that filter based on [[PropertyCategory]] content.
- * @public
- */
-export declare abstract class PropertyCategoryDataFiltererBase extends PropertyDataFiltererBase {
-    recordMatchesFilter(): Promise<PropertyDataFilterResult>;
-}
-/**
- * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
- * filterers that filter based on [[PropertyRecord]] content.
- * @public
- */
-export declare abstract class PropertyRecordDataFiltererBase extends PropertyDataFiltererBase {
-    categoryMatchesFilter(): Promise<PropertyDataFilterResult>;
-}
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { PropertyRecord } from "@itwin/appui-abstract";
+import { BeEvent } from "@itwin/core-bentley";
+import { PropertyCategory } from "../../PropertyDataProvider";
+/**
+ * Enumeration of possible component filtered types
+ * @public
+ */
+export declare enum FilteredType {
+    Category = 0,
+    Label = 1,
+    Value = 2
+}
+/**
+ * Data structure for storing [[IPropertyDataFilterer]] matching results
+ * @public
+ */
+export interface PropertyDataFilterResult {
+    /** Indicates whether provided item matched filter */
+    matchesFilter: boolean;
+    /**
+     * Indicates whether descendants nodes should be forcefully included in filtered results.
+     * Can only be true for nodes that have `matchesFilter` set to true.
+     */
+    shouldForceIncludeDescendants?: boolean;
+    /**
+     * Indicates whether parents of node should be expanded up to this match node.
+     * Can only be true for nodes that have `matchesFilter` set to true.
+     */
+    shouldExpandNodeParents?: boolean;
+    /**
+     * Indicates how many times filter was matched in the provided item.
+     */
+    matchesCount?: number;
+    /**
+     * Indicates what item types were matched.
+     */
+    filteredTypes?: FilteredType[];
+}
+/**
+ * A signature for property data change listeners
+ * @public
+ */
+export declare type PropertyFilterChangesListener = () => void;
+/**
+ * An event broadcasted when property filter changes
+ * @public
+ */
+export declare class PropertyFilterChangeEvent extends BeEvent<PropertyFilterChangesListener> {
+}
+/**
+ * An interface for a filterer that filters [[PropertyData]] based on content of [[PropertyRecord]]
+ * and [[PropertyCategory]] objects.
+ * @public
+ */
+export interface IPropertyDataFilterer {
+    readonly isActive: boolean;
+    recordMatchesFilter: (node: PropertyRecord, parents: PropertyRecord[]) => Promise<PropertyDataFilterResult>;
+    categoryMatchesFilter: (node: PropertyCategory, parents: PropertyCategory[]) => Promise<PropertyDataFilterResult>;
+    onFilterChanged: PropertyFilterChangeEvent;
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] to share common behavior between different implementations.
+ * @public
+ */
+export declare abstract class PropertyDataFiltererBase implements IPropertyDataFilterer {
+    onFilterChanged: PropertyFilterChangeEvent;
+    abstract get isActive(): boolean;
+    abstract recordMatchesFilter(node: PropertyRecord, parents: PropertyRecord[]): Promise<PropertyDataFilterResult>;
+    abstract categoryMatchesFilter(node: PropertyCategory, parents: PropertyCategory[]): Promise<PropertyDataFilterResult>;
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
+ * filterers that filter based on [[PropertyCategory]] content.
+ * @public
+ */
+export declare abstract class PropertyCategoryDataFiltererBase extends PropertyDataFiltererBase {
+    recordMatchesFilter(): Promise<PropertyDataFilterResult>;
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
+ * filterers that filter based on [[PropertyRecord]] content.
+ * @public
+ */
+export declare abstract class PropertyRecordDataFiltererBase extends PropertyDataFiltererBase {
+    categoryMatchesFilter(): Promise<PropertyDataFilterResult>;
+}
 //# sourceMappingURL=PropertyDataFiltererBase.d.ts.map

package/lib/esm/components-react/propertygrid/dataproviders/filterers/PropertyDataFiltererBase.js

@@ -1,54 +1,54 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PropertyGrid
- */
-import { BeEvent } from "@itwin/core-bentley";
-/**
- * Enumeration of possible component filtered types
- * @public
- */
-export var FilteredType;
-(function (FilteredType) {
-    FilteredType[FilteredType["Category"] = 0] = "Category";
-    FilteredType[FilteredType["Label"] = 1] = "Label";
-    FilteredType[FilteredType["Value"] = 2] = "Value";
-})(FilteredType || (FilteredType = {}));
-/**
- * An event broadcasted when property filter changes
- * @public
- */
-export class PropertyFilterChangeEvent extends BeEvent {
-}
-/**
- * An abstract implementation of [[IPropertyDataFilterer]] to share common behavior between different implementations.
- * @public
- */
-export class PropertyDataFiltererBase {
-    constructor() {
-        this.onFilterChanged = new PropertyFilterChangeEvent();
-    }
-}
-/**
- * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
- * filterers that filter based on [[PropertyCategory]] content.
- * @public
- */
-export class PropertyCategoryDataFiltererBase extends PropertyDataFiltererBase {
-    async recordMatchesFilter() {
-        return { matchesFilter: !this.isActive };
-    }
-}
-/**
- * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
- * filterers that filter based on [[PropertyRecord]] content.
- * @public
- */
-export class PropertyRecordDataFiltererBase extends PropertyDataFiltererBase {
-    async categoryMatchesFilter() {
-        return { matchesFilter: !this.isActive };
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { BeEvent } from "@itwin/core-bentley";
+/**
+ * Enumeration of possible component filtered types
+ * @public
+ */
+export var FilteredType;
+(function (FilteredType) {
+    FilteredType[FilteredType["Category"] = 0] = "Category";
+    FilteredType[FilteredType["Label"] = 1] = "Label";
+    FilteredType[FilteredType["Value"] = 2] = "Value";
+})(FilteredType || (FilteredType = {}));
+/**
+ * An event broadcasted when property filter changes
+ * @public
+ */
+export class PropertyFilterChangeEvent extends BeEvent {
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] to share common behavior between different implementations.
+ * @public
+ */
+export class PropertyDataFiltererBase {
+    constructor() {
+        this.onFilterChanged = new PropertyFilterChangeEvent();
+    }
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
+ * filterers that filter based on [[PropertyCategory]] content.
+ * @public
+ */
+export class PropertyCategoryDataFiltererBase extends PropertyDataFiltererBase {
+    async recordMatchesFilter() {
+        return { matchesFilter: !this.isActive };
+    }
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
+ * filterers that filter based on [[PropertyRecord]] content.
+ * @public
+ */
+export class PropertyRecordDataFiltererBase extends PropertyDataFiltererBase {
+    async categoryMatchesFilter() {
+        return { matchesFilter: !this.isActive };
+    }
+}
 //# sourceMappingURL=PropertyDataFiltererBase.js.map

package/lib/esm/components-react/propertygrid/internal/PropertyGridEventHandler.d.ts

@@ -1,25 +1,25 @@
-/** @packageDocumentation
- * @module PropertyGrid
- */
-import { IPropertyGridModelSource } from "./PropertyGridModelSource";
-/**
- * Handles events and changes on PropertyGridModel data.
- * @public
- */
-export interface IPropertyGridEventHandler {
-    onExpansionToggled: (selectionKey: string) => void;
-}
-/**
- * Handles events and changes on PropertyGridModel data.
- * @public
- */
-export declare class PropertyGridEventHandler {
-    private _modelSource;
-    constructor(_modelSource: IPropertyGridModelSource);
-    /**
-     * Flips isExpand on item by given selectionKey
-     * @param selectionKey item to be modified
-     */
-    onExpansionToggled: (selectionKey: string) => void;
-}
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { IPropertyGridModelSource } from "./PropertyGridModelSource";
+/**
+ * Handles events and changes on PropertyGridModel data.
+ * @public
+ */
+export interface IPropertyGridEventHandler {
+    onExpansionToggled: (selectionKey: string) => void;
+}
+/**
+ * Handles events and changes on PropertyGridModel data.
+ * @public
+ */
+export declare class PropertyGridEventHandler {
+    private _modelSource;
+    constructor(_modelSource: IPropertyGridModelSource);
+    /**
+     * Flips isExpand on item by given selectionKey
+     * @param selectionKey item to be modified
+     */
+    onExpansionToggled: (selectionKey: string) => void;
+}
 //# sourceMappingURL=PropertyGridEventHandler.d.ts.map

package/lib/esm/components-react/propertygrid/internal/PropertyGridEventHandler.js

@@ -1,24 +1,24 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/**
- * Handles events and changes on PropertyGridModel data.
- * @public
- */
-export class PropertyGridEventHandler {
-    constructor(_modelSource) {
-        this._modelSource = _modelSource;
-        /**
-         * Flips isExpand on item by given selectionKey
-         * @param selectionKey item to be modified
-         */
-        this.onExpansionToggled = (selectionKey) => {
-            this._modelSource.modifyModel((draftModel) => {
-                const item = draftModel.getItem(selectionKey);
-                item.isExpanded = !item.isExpanded;
-            });
-        };
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/**
+ * Handles events and changes on PropertyGridModel data.
+ * @public
+ */
+export class PropertyGridEventHandler {
+    constructor(_modelSource) {
+        this._modelSource = _modelSource;
+        /**
+         * Flips isExpand on item by given selectionKey
+         * @param selectionKey item to be modified
+         */
+        this.onExpansionToggled = (selectionKey) => {
+            this._modelSource.modifyModel((draftModel) => {
+                const item = draftModel.getItem(selectionKey);
+                item.isExpanded = !item.isExpanded;
+            });
+        };
+    }
+}
 //# sourceMappingURL=PropertyGridEventHandler.js.map

package/lib/esm/components-react/propertygrid/internal/PropertyGridHooks.d.ts

@@ -1,39 +1,39 @@
-/** @packageDocumentation
- * @module PropertyGrid
- */
-import { IPropertyDataProvider } from "../PropertyDataProvider";
-import { PropertyGridEventHandler } from "./PropertyGridEventHandler";
-import { IPropertyGridModel } from "./PropertyGridModel";
-import { IPropertyGridModelSource, PropertyGridModelSource } from "./PropertyGridModelSource";
-/**
- * Custom hook that gets [[PropertyData]] from given [[IPropertyDataProvider]] and subscribes to further data changes.
- * @public
- */
-export declare function usePropertyData(props: {
-    dataProvider: IPropertyDataProvider;
-}): {
-    value: import("../PropertyDataProvider").PropertyData | undefined;
-    inProgress: boolean;
-};
-/**
- * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider.
- * @public
- */
-export declare function usePropertyGridModelSource(props: {
-    dataProvider: IPropertyDataProvider;
-}): PropertyGridModelSource;
-/**
- * Custom hook that creates memoized version of [[PropertyGridEventHandler]] that modifies given modelSource
- * @public
- */
-export declare function usePropertyGridEventHandler(props: {
-    modelSource: IPropertyGridModelSource;
-}): PropertyGridEventHandler;
-/**
- * Custom hook that automatically listens and retrieves latest model from model source
- * @public
- */
-export declare function usePropertyGridModel(props: {
-    modelSource: IPropertyGridModelSource;
-}): IPropertyGridModel | undefined;
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { IPropertyDataProvider } from "../PropertyDataProvider";
+import { PropertyGridEventHandler } from "./PropertyGridEventHandler";
+import { IPropertyGridModel } from "./PropertyGridModel";
+import { IPropertyGridModelSource, PropertyGridModelSource } from "./PropertyGridModelSource";
+/**
+ * Custom hook that gets [[PropertyData]] from given [[IPropertyDataProvider]] and subscribes to further data changes.
+ * @public
+ */
+export declare function usePropertyData(props: {
+    dataProvider: IPropertyDataProvider;
+}): {
+    value: import("../PropertyDataProvider").PropertyData | undefined;
+    inProgress: boolean;
+};
+/**
+ * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider.
+ * @public
+ */
+export declare function usePropertyGridModelSource(props: {
+    dataProvider: IPropertyDataProvider;
+}): PropertyGridModelSource;
+/**
+ * Custom hook that creates memoized version of [[PropertyGridEventHandler]] that modifies given modelSource
+ * @public
+ */
+export declare function usePropertyGridEventHandler(props: {
+    modelSource: IPropertyGridModelSource;
+}): PropertyGridEventHandler;
+/**
+ * Custom hook that automatically listens and retrieves latest model from model source
+ * @public
+ */
+export declare function usePropertyGridModel(props: {
+    modelSource: IPropertyGridModelSource;
+}): IPropertyGridModel | undefined;
 //# sourceMappingURL=PropertyGridHooks.d.ts.map

package/lib/esm/components-react/propertygrid/internal/PropertyGridHooks.js

@@ -1,68 +1,68 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PropertyGrid
- */
-import { useCallback, useEffect, useMemo, useReducer, useState } from "react";
-import { useDebouncedAsyncValue } from "../../common/UseDebouncedAsyncValue";
-import { MutableGridItemFactory } from "./flat-items/MutableGridItemFactory";
-import { PropertyGridEventHandler } from "./PropertyGridEventHandler";
-import { PropertyGridModelSource } from "./PropertyGridModelSource";
-/**
- * Custom hook that gets [[PropertyData]] from given [[IPropertyDataProvider]] and subscribes to further data changes.
- * @public
- */
-export function usePropertyData(props) {
-    const { dataProvider } = props;
-    const [forcedUpdate, triggerForcedUpdate] = useReducer(() => ({}), {});
-    useEffect(() => {
-        return dataProvider.onDataChanged.addListener(() => {
-            triggerForcedUpdate();
-        });
-    }, [dataProvider]);
-    // forcedUpdate is added to dependency list to re-memo getData promise when onDataChanged emits an event.
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    return useDebouncedAsyncValue(useCallback(async () => dataProvider.getData(), [dataProvider, forcedUpdate]));
-}
-/**
- * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider.
- * @public
- */
-export function usePropertyGridModelSource(props) {
-    const { value: propertyData } = usePropertyData(props);
-    const { dataProvider } = { ...props };
-    // Model source needs to be recreated if data provider changes
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    const modelSource = useMemo(() => new PropertyGridModelSource(new MutableGridItemFactory()), [dataProvider]);
-    useEffect(() => {
-        if (propertyData)
-            modelSource.setPropertyData(propertyData);
-    }, [modelSource, propertyData]);
-    return modelSource;
-}
-/**
- * Custom hook that creates memoized version of [[PropertyGridEventHandler]] that modifies given modelSource
- * @public
- */
-export function usePropertyGridEventHandler(props) {
-    return useMemo(() => new PropertyGridEventHandler(props.modelSource), [props.modelSource]);
-}
-/**
- * Custom hook that automatically listens and retrieves latest model from model source
- * @public
- */
-export function usePropertyGridModel(props) {
-    const { modelSource } = { ...props };
-    const [model, setModel] = useState();
-    useEffect(() => {
-        const modelChanged = () => {
-            setModel(modelSource.getModel());
-        };
-        modelChanged();
-        return modelSource.onModelChanged.addListener(modelChanged);
-    }, [modelSource]);
-    return model;
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { useCallback, useEffect, useMemo, useReducer, useState } from "react";
+import { useDebouncedAsyncValue } from "../../common/UseDebouncedAsyncValue";
+import { MutableGridItemFactory } from "./flat-items/MutableGridItemFactory";
+import { PropertyGridEventHandler } from "./PropertyGridEventHandler";
+import { PropertyGridModelSource } from "./PropertyGridModelSource";
+/**
+ * Custom hook that gets [[PropertyData]] from given [[IPropertyDataProvider]] and subscribes to further data changes.
+ * @public
+ */
+export function usePropertyData(props) {
+    const { dataProvider } = props;
+    const [forcedUpdate, triggerForcedUpdate] = useReducer(() => ({}), {});
+    useEffect(() => {
+        return dataProvider.onDataChanged.addListener(() => {
+            triggerForcedUpdate();
+        });
+    }, [dataProvider]);
+    // forcedUpdate is added to dependency list to re-memo getData promise when onDataChanged emits an event.
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    return useDebouncedAsyncValue(useCallback(async () => dataProvider.getData(), [dataProvider, forcedUpdate]));
+}
+/**
+ * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider.
+ * @public
+ */
+export function usePropertyGridModelSource(props) {
+    const { value: propertyData } = usePropertyData(props);
+    const { dataProvider } = { ...props };
+    // Model source needs to be recreated if data provider changes
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    const modelSource = useMemo(() => new PropertyGridModelSource(new MutableGridItemFactory()), [dataProvider]);
+    useEffect(() => {
+        if (propertyData)
+            modelSource.setPropertyData(propertyData);
+    }, [modelSource, propertyData]);
+    return modelSource;
+}
+/**
+ * Custom hook that creates memoized version of [[PropertyGridEventHandler]] that modifies given modelSource
+ * @public
+ */
+export function usePropertyGridEventHandler(props) {
+    return useMemo(() => new PropertyGridEventHandler(props.modelSource), [props.modelSource]);
+}
+/**
+ * Custom hook that automatically listens and retrieves latest model from model source
+ * @public
+ */
+export function usePropertyGridModel(props) {
+    const { modelSource } = { ...props };
+    const [model, setModel] = useState();
+    useEffect(() => {
+        const modelChanged = () => {
+            setModel(modelSource.getModel());
+        };
+        modelChanged();
+        return modelSource.onModelChanged.addListener(modelChanged);
+    }, [modelSource]);
+    return model;
+}
 //# sourceMappingURL=PropertyGridHooks.js.map