@arcgis/map-components 4.31.0-next.98 → 4.32.0-next.10

package/dist/controllers/useWidget.d.ts

@@ -0,0 +1,97 @@
+/// <reference types="@arcgis/core/interfaces.d.ts" />
+import { BaseComponent, EventEmitter } from '@arcgis/components-controllers';
+import { AccessorController } from '@arcgis/components-controllers/accessor';
+import { Nil } from '@arcgis/components-utils';
+import { default as ArcgisMap } from '@arcgis/core/Map';
+import { ArcgisReferenceElement } from '../utils/component-utils';
+type Requires<Props, Widget extends WidgetInstance> = BaseComponent & Pick<Widget, keyof Props & keyof Widget> & Uses<Widget>;
+type WidgetInstance = __esri.Widget & {
+    state?: string;
+    viewModel?: __esri.Accessor & {
+        state?: string;
+        view?: __esri.MapView | __esri.SceneView | Nil;
+        map?: ArcgisMap | Nil;
+    };
+    view?: __esri.MapView | __esri.SceneView | Nil;
+    map?: ArcgisMap | Nil;
+    visibleElements?: Record<never, unknown>;
+};
+type Uses<Widget extends WidgetInstance> = {
+    reactiveUtils?: typeof __esri.reactiveUtils;
+    state?: Exclude<Widget["viewModel"], Nil>["state"] | Widget["state"];
+    viewModel?: Widget["viewModel"];
+    icon: Nil | string;
+    label: Nil | string;
+    referenceElement: ArcgisReferenceElement | Nil | string;
+    position: __esri.UIPosition;
+    arcgisReady: EventEmitter;
+    arcgisPropertyChange: EventEmitter<{
+        name: string;
+    }> | undefined;
+    el: HTMLElement & {
+        childElem?: HTMLElement & {
+            ownedBy?: HTMLElement;
+        };
+        view?: __esri.MapView | __esri.SceneView | Nil;
+    };
+    autoDestroyDisabled: boolean;
+    destroy: () => Promise<void>;
+};
+/**
+ * A controller for a wrapped JS API Widget
+ * - loads the widget
+ * - initializes the widget with the component's properties
+ * - does two-way binding between widget and component properties
+ * - re-emits the widgets's events on the component
+ * - type-checks everything ✨
+ *
+ * Documentation:
+ * https://qawebgis.esri.com/arcgis-components/?path=/docs/lumina-transition-from-widgets--docs#usewidget-controller
+ */
+export declare const makeWidgetController: <Props, Widget extends WidgetInstance, OmitProps extends string = never>(loadWidget: (props: Props) => Promise<Widget>, _options?: {
+    /**
+     * Don't expose the following Widget's properties on the component.
+     * You can also bind the property to \@State rather than \@Prop if you
+     * wish to use it internally only:
+     *
+     * @example
+     * \@State() timeZone = this.widget.timeZone;
+     */
+    omitProps: OmitProps[];
+}) => (component: Requires<Omit<Props, OmitProps | "container" | "id" | "view" | "visible" | "visibleElements">, Widget>, options?: {
+    editConstructorProperties(props: Props): Promise<Props> | Props;
+}) => Widget;
+export declare class WidgetController<Props, Widget extends WidgetInstance> extends AccessorController<Props, Widget, Uses<Widget>> {
+    private _watchedViewModelProperties;
+    private _watchedVisibleElementsProperties;
+    private _isBindingViewModel;
+    constructor(component: Requires<Props, Widget> & Uses<Widget>, _loadAccessor: (props: Props) => Promise<Widget>, _options?: {
+        editConstructorProperties?(props: Props): Promise<Props> | Props;
+    });
+    hostConnected(): void;
+    hostLoad(): Promise<void>;
+    private _updateWidgetVisibleElement;
+    hostLoaded(): void;
+    hostDisconnected(): void;
+    hostDestroy(): void;
+    private _watchMetaProperties;
+    private _makeVisibleElementsBinder;
+    private _makeRecursiveProxy;
+    /**
+     * Destroy the component if view gets destroyed.
+     *
+     * When view is destroyed, component disconnect is triggered, which will
+     * destroy the component in 1s but that can be too late, because in the
+     * meanwhile, a watcher on the widget/viewModel instance may get triggered,
+     * and throw an error if it's not able to access this.view.map or etc
+     * (happens in VersionManagementViewModel for example).
+     *
+     * We can't check for this in disconnectedCallback though as, if the entire
+     * component tree is removed, the disconnect for the component will be
+     * triggered before that of arcgis-map, so the view might not be destroyed
+     * yet at that point.
+     */
+    private _watchViewDestroy;
+    private _watchViewDestroyHandle?;
+}
+export {};