@arcgis/map-components
Version:
ArcGIS Map Components
79 lines (77 loc) • 3.5 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/components-controllers';
import { Nil } from '@arcgis/components-utils';
import { default as Expand } from '@arcgis/core/widgets/Expand.js';
import { PublicLitElement as LitElement, ToElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';
declare const useExpandWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
manager: import('@arcgis/components-controllers').ControllerManager;
el: HTMLElement;
autoDestroyDisabled?: boolean;
destroy?: () => Promise<void>;
} & Pick<Expand, never> & {
reactiveUtils?: typeof __esri.reactiveUtils;
state?: unknown;
viewModel?: __esri.ExpandViewModel | undefined;
icon: Nil | string;
label: Nil | string;
referenceElement: ArcgisReferenceElement | Nil | string;
position: __esri.UIPosition;
arcgisReady: import('@arcgis/components-controllers').EventEmitter;
arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
name: string;
}> | undefined;
el: HTMLElement & {
childElem?: HTMLElement & {
ownedBy?: HTMLElement;
};
view?: __esri.MapView | __esri.SceneView | Nil;
};
autoDestroyDisabled: boolean;
destroy: () => Promise<void>;
}, options?: {
editConstructorProperties(props: __esri.ExpandProperties | undefined): __esri.ExpandProperties | Promise<__esri.ExpandProperties | undefined> | undefined;
} | undefined) => Expand;
/** Expand component acts as a clickable button for opening content.
*/
export declare class ArcgisExpand extends LitElement {
autoCollapse: boolean;
/**
* If true, the component will not be destroyed automatically when it is
* disconnected from the document. This is useful when you want to move the
* component to a different place on the page, or temporarily hide it. If this
* is set, make sure to call the \`destroy\` method when you are done to prevent
* memory leaks.
*/
autoDestroyDisabled: boolean;
closeOnEsc: boolean | Function;
collapseIcon: string;
collapseTooltip: string;
expandIcon: string | nullish;
expandTooltip: string;
expanded: boolean;
focusTrapEnabled: boolean;
group: string | nullish;
/** @private */
/**
* Icon which represents the component.
* Typically used when the component is controlled by another component (e.g. by the Expand component).
* Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
*/
icon: string | nullish;
iconNumber: number;
/** The component's default label. */
label: string;
mode: "auto" | "floating" | "drawer";
placement: nullish | "left" | "right" | "top" | "bottom" | "auto" | "auto-start" | "auto-end" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end" | "leading-start" | "leading" | "leading-end" | "trailing-end" | "trailing" | "trailing-start";
position: __esri.UIPosition;
referenceElement: ArcgisReferenceElement | Nil | string;
collapse(): Promise<void>;
/** Permanently destroy the component */
destroy(): Promise<void>;
expand(): Promise<void>;
toggle(): Promise<void>;
readonly arcgisReady: TargetedEvent<this, undefined>;
}
export {};