@arcgis/portal-components 5.2.0-next.57 → 5.2.0-next.59

package/dist/components/arcgis-portal-group-browser/customElement.d.ts

@@ -0,0 +1,301 @@
+/// <reference path="../../index.d.ts" />
+import type Portal from "@arcgis/core/portal/Portal.js";
+import type PortalGroup from "@arcgis/core/portal/PortalGroup.js";
+import type Accessor from "@arcgis/core/core/Accessor.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { PortalGroupCardProps } from "../arcgis-portal-group-card/customElement.js";
+import type { InternalUIAction } from "../../types/tracking.js";
+import type { GroupBrowserState, PortalGroupBrowserCardsConfig, PortalGroupBrowserFiltersConfig, PortalGroupBrowserQuery, PortalGroupBrowserResponse, PortalGroupBrowserSearchResult, PortalGroupBrowserSortConfig } from "./types.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+
+/** A group-browser wrapper around `arcgis-portal-browser` that renders filters from declarative config. */
+export abstract class ArcgisPortalGroupBrowser extends LitElement {
+  /** @internal */
+  protected _messages: {
+      browser: {
+          pageRange: string;
+          pageRangeAria: string;
+      };
+      filters: { title: string; };
+      groupsByUser: {
+          title: string;
+          me: string;
+      };
+      owner: {
+          title: string;
+          label: string;
+          owner: string;
+          inOrg: string;
+          outsideOrg: string;
+          someoneElse: string;
+      };
+      membership: {
+          title: string;
+          label: string;
+          org: string;
+          collaboration: string;
+          anyOrg: string;
+      };
+      memberOrg: {
+          title: string;
+          label: string;
+          myOrg: string;
+          anotherOrg: string;
+      };
+      specialGroups: {
+          title: string;
+          label: string;
+          openData: string;
+          sharedUpdate: string;
+          distributed: string;
+          admin: string;
+          settings: string;
+      };
+      access: {
+          title: string;
+          label: string;
+          public: string;
+          org: string;
+          private: string;
+      };
+      preview: {
+          titleFallback: string;
+          loading: string;
+          close: string;
+          ownedBy: string;
+          overview: string;
+          noSummary: string;
+          description: string;
+          noDescription: string;
+          content: string;
+          noContent: string;
+          viewContent: string;
+          groupManagers: string;
+          groupOwner: string;
+          noManagers: string;
+          openMembers: string;
+          settings: string;
+          viewableBy: string;
+          contributors: string;
+          joinMethod: string;
+          openSettings: string;
+          everyone: string;
+          onlyMembers: string;
+          onlyOrganization: string;
+          onlyOrganizationAndPartners: string;
+          onlyOwnerManager: string;
+          allMembers: string;
+          byAutojoin: string;
+          byInvitation: string;
+          byEnterprise: string;
+          byRequest: string;
+          access: string;
+          groupTags: string;
+          openGroupPage: string;
+          unknownValue: string;
+      };
+      content: {
+          noResults: string;
+          noContent: string;
+          loading: string;
+      };
+  } & T9nMeta<{
+      browser: {
+          pageRange: string;
+          pageRangeAria: string;
+      };
+      filters: { title: string; };
+      groupsByUser: {
+          title: string;
+          me: string;
+      };
+      owner: {
+          title: string;
+          label: string;
+          owner: string;
+          inOrg: string;
+          outsideOrg: string;
+          someoneElse: string;
+      };
+      membership: {
+          title: string;
+          label: string;
+          org: string;
+          collaboration: string;
+          anyOrg: string;
+      };
+      memberOrg: {
+          title: string;
+          label: string;
+          myOrg: string;
+          anotherOrg: string;
+      };
+      specialGroups: {
+          title: string;
+          label: string;
+          openData: string;
+          sharedUpdate: string;
+          distributed: string;
+          admin: string;
+          settings: string;
+      };
+      access: {
+          title: string;
+          label: string;
+          public: string;
+          org: string;
+          private: string;
+      };
+      preview: {
+          titleFallback: string;
+          loading: string;
+          close: string;
+          ownedBy: string;
+          overview: string;
+          noSummary: string;
+          description: string;
+          noDescription: string;
+          content: string;
+          noContent: string;
+          viewContent: string;
+          groupManagers: string;
+          groupOwner: string;
+          noManagers: string;
+          openMembers: string;
+          settings: string;
+          viewableBy: string;
+          contributors: string;
+          joinMethod: string;
+          openSettings: string;
+          everyone: string;
+          onlyMembers: string;
+          onlyOrganization: string;
+          onlyOrganizationAndPartners: string;
+          onlyOwnerManager: string;
+          allMembers: string;
+          byAutojoin: string;
+          byInvitation: string;
+          byEnterprise: string;
+          byRequest: string;
+          access: string;
+          groupTags: string;
+          openGroupPage: string;
+          unknownValue: string;
+      };
+      content: {
+          noResults: string;
+          noContent: string;
+          loading: string;
+      };
+  }>;
+  /**
+   * Optionally force showing selection region in content top bar.
+   *
+   * @default false
+   */
+  accessor alwaysShowSelection: boolean;
+  /** Optional per-group card prop customization for baked-in result rendering. */
+  accessor cards: PortalGroupBrowserCardsConfig;
+  /** Optional custom fetch function for group data retrieval. */
+  accessor fetch: ((query: PortalGroupBrowserQuery) => Promise<PortalGroupBrowserSearchResult>) | undefined;
+  /** Filter configuration rendered internally by this component. */
+  accessor filters: PortalGroupBrowserFiltersConfig;
+  /**
+   * Browser responsive form factor.
+   *
+   * @default "large"
+   */
+  accessor formFactor: "large" | "small";
+  /**
+   * True when membership options should be restricted for indoor spaces behavior.
+   *
+   * @default false
+   */
+  accessor hasIndoorsSpaces: boolean;
+  /**
+   * Height sizing mode forwarded to arcgis-portal-browser.
+   *
+   * @default "full"
+   */
+  accessor height: "auto" | "full";
+  /**
+   * Optionally hide group badges for the group browser preview element.
+   *
+   * @default false
+   */
+  accessor hidePreviewBadges: boolean;
+  /**
+   * Optionally hide the footer for the group browser preview element.
+   *
+   * @default false
+   */
+  accessor hidePreviewFooter: boolean;
+  /**
+   * Browser loading state.
+   *
+   * @default false
+   */
+  accessor loading: boolean;
+  /**
+   * Number of results to fetch per page.
+   *
+   * @default 60
+   */
+  accessor num: number;
+  accessor portal: Portal;
+  /** Optional preflight transform before fetch is executed. */
+  accessor preflight: ((query: PortalGroupBrowserQuery) => Promise<PortalGroupBrowserQuery>) | undefined;
+  /**
+   * Default preview behavior forwarded to group cards unless overridden per card.
+   *
+   * @default "top"
+   */
+  accessor preview: PortalGroupCardProps["preview"];
+  /**
+   * Optional base query applied to each fetch operation.
+   *
+   * @default ""
+   */
+  accessor q: string;
+  /**
+   * Optional search term forwarded to arcgis-portal-browser.
+   *
+   * @default ""
+   */
+  accessor searchTerm: string;
+  /** Optional search-user input to constrain queries by user. */
+  accessor searchUser: string | undefined;
+  /** Optional selected groups forwarded to arcgis-portal-browser. */
+  accessor selected: PortalGroup[] | undefined;
+  /**
+   * Selection mode for card-level interactions.
+   *
+   * @default "none"
+   */
+  accessor selection: "multiple" | "none" | "single";
+  /** Sort configuration rendered internally by this component. */
+  accessor sort: PortalGroupBrowserSortConfig;
+  /** Shared browser store that tracks active filters and responsive state. */
+  accessor store: Accessor & GroupBrowserState;
+  refresh(): Promise<void>;
+  /** Mirrors live-region announcements from the underlying portal browser. */
+  readonly arcgisAriaUpdate: import("@arcgis/lumina").TargetedEvent<this, string>;
+  readonly arcgisGroupBrowserInternalUIAction: import("@arcgis/lumina").TargetedEvent<this, InternalUIAction>;
+  readonly arcgisGroupBrowserLoading: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly arcgisGroupBrowserPreview: import("@arcgis/lumina").TargetedEvent<this, PortalGroup | null>;
+  readonly arcgisGroupBrowserSelect: import("@arcgis/lumina").TargetedEvent<this, PortalGroup[]>;
+  /** Fires when preview is opened or closed for sublayer parity; currently emits null on close. */
+  readonly arcgisGroupBrowserSublayerPreview: import("@arcgis/lumina").TargetedEvent<this, null>;
+  readonly arcgisGroupBrowserUpdate: import("@arcgis/lumina").TargetedEvent<this, PortalGroupBrowserResponse>;
+  readonly arcgisGroupBrowserUserFilterChange: import("@arcgis/lumina").TargetedEvent<this, string>;
+  readonly "@eventTypes": {
+    arcgisAriaUpdate: ArcgisPortalGroupBrowser["arcgisAriaUpdate"]["detail"];
+    arcgisGroupBrowserInternalUIAction: ArcgisPortalGroupBrowser["arcgisGroupBrowserInternalUIAction"]["detail"];
+    arcgisGroupBrowserLoading: ArcgisPortalGroupBrowser["arcgisGroupBrowserLoading"]["detail"];
+    arcgisGroupBrowserPreview: ArcgisPortalGroupBrowser["arcgisGroupBrowserPreview"]["detail"];
+    arcgisGroupBrowserSelect: ArcgisPortalGroupBrowser["arcgisGroupBrowserSelect"]["detail"];
+    arcgisGroupBrowserSublayerPreview: ArcgisPortalGroupBrowser["arcgisGroupBrowserSublayerPreview"]["detail"];
+    arcgisGroupBrowserUpdate: ArcgisPortalGroupBrowser["arcgisGroupBrowserUpdate"]["detail"];
+    arcgisGroupBrowserUserFilterChange: ArcgisPortalGroupBrowser["arcgisGroupBrowserUserFilterChange"]["detail"];
+  };
+}