@arcgis/portal-components 5.2.0-next.7 → 5.2.0-next.71

package/dist/components/arcgis-portal-navigation/customElement.d.ts

@@ -0,0 +1,528 @@
+/// <reference path="../../index.d.ts" />
+import type Portal from "@arcgis/core/portal/Portal.js";
+import type PortalItem from "@arcgis/core/portal/PortalItem.js";
+import type { PublicLitElement as LitElement } from "@arcgis/lumina";
+import type { PortalNavigationNavigateDetail, PortalNavigationProduct, PortalNavigationProjectMenuClick, PortalNavigationProjectMenuOption, PortalNavigationProjectSaveResult } from "./types.js";
+import type { T9nMeta } from "@arcgis/lumina/controllers";
+import type { Icon as Icon } from "@esri/calcite-components/components/calcite-icon";
+
+/**
+ * Global navigation component for all ArcGIS web products
+ * Includes app switching, latest content, project menu, notifications, and user settings
+ * NOT intended for external use, Esri apps only!
+ * To request your app get added to the supported products list, please [open an issue](https://devtopia.esri.com/WebGIS/webgis-sdk/issues).
+ *
+ * Example usage:
+ * ```jsx
+ * <arcgis-portal-navigation
+ *    portal={Portal}
+ *    product="Map Viewer"
+ *
+ *    // optional, call `preventDefault` on the event to do your own client side navigation
+ *    onNavigate={(e) => ( { href: string; event: Event } ) }
+ *
+ *    // optional, used for classification
+ *    portalItem={PortalItem}
+ *
+ *    // project menu configuration and events
+ *    projectTitle="Untitled Map"
+ *    projectTitleSave={async (title) => {
+ *      // returning error status with message here will show an error in the ui
+ *      // returning a success status will close the edit UI
+ *      return { status: "success" };
+ *    }}
+ *    projectMenuSaveIndicator={true}
+ *    // all items optional, built in options can have their text overridden
+ *    projectMenuOptions={[
+ *      { id: "new", text: "New map" },
+ *      { id: "open" },
+ *      { id: "rename" },
+ *      { id: "saveCopy" },
+ *      { id: "save" },
+ *      { id: "share", disabled: true },
+ *      {
+ *        text: "Custom new option",
+ *        id: "custom",
+ *        group: "new",
+ *        disabled: true,
+ *      }
+ *    ]}
+ *
+ *    onProjectMenuClick={ ({detail}) => ({ id }) }
+ * >
+ *    // the content-end slot allows adding actions at the end of the nav
+ *    <calcite-action slot="content-end" icon="presentation" text="Present"/>
+ *
+ * </arcgis-portal-navigation>
+ * ```
+ *
+ * @cssproperty [--arcgis-portal-navigation-logo-max-width] - specify a max-width for the logo component (helpful for long org names).
+ * @cssproperty [--arcgis-portal-navigation-logo-text-display] - set to none to hide the product logo text and show glyph only (useful at smaller screen sizes).
+ * @cssproperty [--arcgis-portal-navigation-user-max-width] - specify a max-width for the user component.
+ * @cssproperty [--arcgis-portal-navigation-user-text-display] - set to none to hide user text and use avatar only at smaller screen sizes.
+ * @cssproperty [--arcgis-portal-navigation-project-max-width] - specify a max-width for the project menu.
+ * @slot [content-end] - elements slotted here will appear at the end of the central navigation area
+ * @internal
+ */
+export abstract class ArcGISPortalNavigation extends LitElement {
+  /** Uncommon, use to pass a specific clientId, this helps disambiguate certain home app scenarios */
+  accessor clientId: string | undefined;
+  /** Uncommon, pass in the current pathname, used for active status in nav links */
+  accessor currentPathname: string | undefined;
+  /**
+   * Set to false if notebook servers are not configured on your portal instance
+   *
+   * @default false
+   */
+  accessor disableNotebookServer: boolean | undefined;
+  /**
+   * Set to false if notebook servers are not configured on your portal instance
+   *
+   * @default false
+   */
+  accessor disableTrackViewer: boolean | undefined;
+  /** Set a maximum width for the nav. Screens larger than this width will center the nav inside the available space */
+  accessor maxWidth: number | undefined;
+  /** @internal */
+  protected messages: {
+      shared: { close: string; };
+      platform: {
+          label: string;
+          applicationMenu: string;
+          searchMyApps: string;
+          allMyApplications: string;
+          customizeApps: string;
+          reorder: string;
+          applyChanges: string;
+          myApps: string;
+          recentContent: string;
+          searchRecentContent: string;
+          recentContentNoResultsDescription: string;
+          noContent: string;
+          noContentDescription: string;
+          hide: string;
+          show: string;
+          cancel: string;
+          noAppResults: string;
+          noAppResultsDescriptionOrg: string;
+          noAppsDescriptionPublic: string;
+          noAppsAvailable: string;
+          noAppsAvailableDescription: string;
+          new: string;
+          descriptions: {
+              "360 VR": string;
+              "ArcGIS Community Analyst": string;
+              "ArcGIS Dashboards": string;
+              "ArcGIS Earth": string;
+              "ArcGIS Excalibur": string;
+              "ArcGIS Experience Builder": string;
+              "ArcGIS Explorer": string;
+              "ArcGIS for Power BI": string;
+              "ArcGIS Field Maps": string;
+              "ArcGIS Field Maps Early Access": string;
+              "ArcGIS GeoBIM": string;
+              "ArcGIS Hub": string;
+              "ArcGIS Indoors": string;
+              "ArcGIS Indoors Floor Plan Editor": string;
+              "ArcGIS Indoors Space Planner": string;
+              "ArcGIS Maps for Adobe Creative Cloud": string;
+              "ArcGIS Mission Responder": string;
+              "ArcGIS Online": string;
+              "ArcGIS QuickCapture Web Designer": string;
+              "ArcGIS Solutions": string;
+              "ArcGIS Urban": string;
+              "ArcGIS Velocity": string;
+              "Business Analyst": string;
+              "Data Pipelines": string;
+              "Deep Learning Studio": string;
+              "Developer Documentation": string;
+              "Esri Redistricting": string;
+              "Field Maps Designer": string;
+              "GeoPlanner for ArcGIS": string;
+              "Insights for ArcGIS": string;
+              "Instant Apps": string;
+              "Knowledge Studio": string;
+              "Living Atlas": string;
+              "Map Viewer": string;
+              "Mission Manager": string;
+              "My Esri": string;
+              "Ortho Maker": string;
+              "Scene Viewer": string;
+              Sites: string;
+              StoryMaps: string;
+              "Story Maps": string;
+              Survey123: string;
+              "Track Viewer": string;
+              "Vector Tile Style Editor": string;
+              "Wayback Imagery": string;
+              "Web Editor": string;
+              "Workflow Manager": string;
+              Workforce: string;
+              "XR Viewer (early access)": string;
+          };
+          lessThanOneMinute: string;
+          lastUpdated: string;
+      };
+      logo: { label: string; };
+      project: {
+          label: string;
+          new: string;
+          open: string;
+          create: string;
+          save: string;
+          saveAsCopy: string;
+          manageSharing: string;
+          rename: string;
+          copyLink: string;
+          embed: string;
+          print: string;
+          itemDetails: string;
+          resources: string;
+          saveRename: string;
+          cancelRename: string;
+          error: string;
+          title: string;
+      };
+      links: {
+          label: string;
+          home: string;
+          gallery: string;
+          content: string;
+          groups: string;
+          features: string;
+          organization: string;
+          overview: string;
+          pricing: string;
+          map: string;
+          scene: string;
+          help: string;
+          subscription: string;
+          downloads: string;
+          developerCredentials: string;
+          account: string;
+          ArcGIS: string;
+          myContent: string;
+          notebook: string;
+          portalAdmin: string;
+      };
+      search: {
+          label: string;
+          online: string;
+          close: string;
+          loadingResults: string;
+          topResults: string;
+          viewAll: string;
+          suggestions: string;
+          by: string;
+          searchType: {
+              label: string;
+              keywordTitle: string;
+              keywordDescription: string;
+              keywordPlaceholder: string;
+              semanticTitle: string;
+              semanticDescription: string;
+              semanticPlaceholder: string;
+          };
+      };
+      notifications: {
+          label: string;
+          noNotifications: string;
+          noNotificationsDescription: string;
+          dismissAllLabel: string;
+          dismissLabel: string;
+          lessThanOneMinute: string;
+          deleting: string;
+          types: {
+              group_join: string;
+              group_join_admin: string;
+              group_application_accepted: string;
+              group_application_declined: string;
+              user_invite: string;
+              user_invitation_accepted: string;
+              user_invitation_declined: string;
+              user_added_to_group: string;
+              collaboration_workspace_added: string;
+              collaboration_deleted: string;
+              collaboration_leaving: string;
+              collaboration_join: string;
+              collaboration_participant_join: string;
+              collaboration_participant_workspace_join: string;
+              collaboration_participant_workspace_unjoin: string;
+              collaboration_participant_removed: string;
+              collaboration_peer_participant_removed: string;
+              collaboration_participant_access_changed: string;
+              collaboration_content_store_disk_limit_reached: string;
+              user_email_bounced: string;
+              feature_layer_copy_over_failed: string;
+              feature_layer_one_way_shared_not_two_way: string;
+              feature_view_copy_over_failed: string;
+              webapp_not_copied: string;
+              webapp_not_copied_portal: string;
+              insights_item_not_copied: string;
+              scheduled_task_disabled: string;
+              portal_certificate_about_to_expire: string;
+              portal_certificate_expired: string;
+              notebook_runtime_deprecated: string;
+              ingress_certificate_about_to_expire: string;
+              ingress_certificate_expired: string;
+          };
+      };
+      user: {
+          account: string;
+          resources: string;
+          myProfile: string;
+          mySettings: string;
+          myEsri: string;
+          training: string;
+          communityForums: string;
+          trialDownload: string;
+          arcgisBlog: string;
+          help: string;
+          switchAccounts: string;
+          signOut: string;
+          signIn: string;
+          userMenu: string;
+      };
+  } & T9nMeta<{
+      shared: { close: string; };
+      platform: {
+          label: string;
+          applicationMenu: string;
+          searchMyApps: string;
+          allMyApplications: string;
+          customizeApps: string;
+          reorder: string;
+          applyChanges: string;
+          myApps: string;
+          recentContent: string;
+          searchRecentContent: string;
+          recentContentNoResultsDescription: string;
+          noContent: string;
+          noContentDescription: string;
+          hide: string;
+          show: string;
+          cancel: string;
+          noAppResults: string;
+          noAppResultsDescriptionOrg: string;
+          noAppsDescriptionPublic: string;
+          noAppsAvailable: string;
+          noAppsAvailableDescription: string;
+          new: string;
+          descriptions: {
+              "360 VR": string;
+              "ArcGIS Community Analyst": string;
+              "ArcGIS Dashboards": string;
+              "ArcGIS Earth": string;
+              "ArcGIS Excalibur": string;
+              "ArcGIS Experience Builder": string;
+              "ArcGIS Explorer": string;
+              "ArcGIS for Power BI": string;
+              "ArcGIS Field Maps": string;
+              "ArcGIS Field Maps Early Access": string;
+              "ArcGIS GeoBIM": string;
+              "ArcGIS Hub": string;
+              "ArcGIS Indoors": string;
+              "ArcGIS Indoors Floor Plan Editor": string;
+              "ArcGIS Indoors Space Planner": string;
+              "ArcGIS Maps for Adobe Creative Cloud": string;
+              "ArcGIS Mission Responder": string;
+              "ArcGIS Online": string;
+              "ArcGIS QuickCapture Web Designer": string;
+              "ArcGIS Solutions": string;
+              "ArcGIS Urban": string;
+              "ArcGIS Velocity": string;
+              "Business Analyst": string;
+              "Data Pipelines": string;
+              "Deep Learning Studio": string;
+              "Developer Documentation": string;
+              "Esri Redistricting": string;
+              "Field Maps Designer": string;
+              "GeoPlanner for ArcGIS": string;
+              "Insights for ArcGIS": string;
+              "Instant Apps": string;
+              "Knowledge Studio": string;
+              "Living Atlas": string;
+              "Map Viewer": string;
+              "Mission Manager": string;
+              "My Esri": string;
+              "Ortho Maker": string;
+              "Scene Viewer": string;
+              Sites: string;
+              StoryMaps: string;
+              "Story Maps": string;
+              Survey123: string;
+              "Track Viewer": string;
+              "Vector Tile Style Editor": string;
+              "Wayback Imagery": string;
+              "Web Editor": string;
+              "Workflow Manager": string;
+              Workforce: string;
+              "XR Viewer (early access)": string;
+          };
+          lessThanOneMinute: string;
+          lastUpdated: string;
+      };
+      logo: { label: string; };
+      project: {
+          label: string;
+          new: string;
+          open: string;
+          create: string;
+          save: string;
+          saveAsCopy: string;
+          manageSharing: string;
+          rename: string;
+          copyLink: string;
+          embed: string;
+          print: string;
+          itemDetails: string;
+          resources: string;
+          saveRename: string;
+          cancelRename: string;
+          error: string;
+          title: string;
+      };
+      links: {
+          label: string;
+          home: string;
+          gallery: string;
+          content: string;
+          groups: string;
+          features: string;
+          organization: string;
+          overview: string;
+          pricing: string;
+          map: string;
+          scene: string;
+          help: string;
+          subscription: string;
+          downloads: string;
+          developerCredentials: string;
+          account: string;
+          ArcGIS: string;
+          myContent: string;
+          notebook: string;
+          portalAdmin: string;
+      };
+      search: {
+          label: string;
+          online: string;
+          close: string;
+          loadingResults: string;
+          topResults: string;
+          viewAll: string;
+          suggestions: string;
+          by: string;
+          searchType: {
+              label: string;
+              keywordTitle: string;
+              keywordDescription: string;
+              keywordPlaceholder: string;
+              semanticTitle: string;
+              semanticDescription: string;
+              semanticPlaceholder: string;
+          };
+      };
+      notifications: {
+          label: string;
+          noNotifications: string;
+          noNotificationsDescription: string;
+          dismissAllLabel: string;
+          dismissLabel: string;
+          lessThanOneMinute: string;
+          deleting: string;
+          types: {
+              group_join: string;
+              group_join_admin: string;
+              group_application_accepted: string;
+              group_application_declined: string;
+              user_invite: string;
+              user_invitation_accepted: string;
+              user_invitation_declined: string;
+              user_added_to_group: string;
+              collaboration_workspace_added: string;
+              collaboration_deleted: string;
+              collaboration_leaving: string;
+              collaboration_join: string;
+              collaboration_participant_join: string;
+              collaboration_participant_workspace_join: string;
+              collaboration_participant_workspace_unjoin: string;
+              collaboration_participant_removed: string;
+              collaboration_peer_participant_removed: string;
+              collaboration_participant_access_changed: string;
+              collaboration_content_store_disk_limit_reached: string;
+              user_email_bounced: string;
+              feature_layer_copy_over_failed: string;
+              feature_layer_one_way_shared_not_two_way: string;
+              feature_view_copy_over_failed: string;
+              webapp_not_copied: string;
+              webapp_not_copied_portal: string;
+              insights_item_not_copied: string;
+              scheduled_task_disabled: string;
+              portal_certificate_about_to_expire: string;
+              portal_certificate_expired: string;
+              notebook_runtime_deprecated: string;
+              ingress_certificate_about_to_expire: string;
+              ingress_certificate_expired: string;
+          };
+      };
+      user: {
+          account: string;
+          resources: string;
+          myProfile: string;
+          mySettings: string;
+          myEsri: string;
+          training: string;
+          communityForums: string;
+          trialDownload: string;
+          arcgisBlog: string;
+          help: string;
+          switchAccounts: string;
+          signOut: string;
+          signIn: string;
+          userMenu: string;
+      };
+  }>;
+  /** The current portal instance */
+  accessor portal: Portal;
+  /** Portal Item currently in use (optional, required for classification use) */
+  accessor portalItem: PortalItem | undefined;
+  /** ID of the ArcGIS Product, used for showing branding, etc */
+  accessor product: PortalNavigationProduct;
+  /** Path to landing page if available, if provided clicking the logo will direct to this path */
+  accessor productHref: string | undefined;
+  /** Text to show in the project menu (will fall back to item title if provided) */
+  accessor projectMenuIcon: Icon["icon"] | undefined;
+  /** Customize which project menu links to include */
+  accessor projectMenuOptions: PortalNavigationProjectMenuOption[];
+  /**
+   * Set to true to indicate that the current project needs to be saved
+   *
+   * @default false
+   */
+  accessor projectMenuSaveIndicator: boolean | undefined;
+  /** Text to show in the project menu (will fall back to item title if provided) */
+  accessor projectTitle: string | undefined;
+  /** Handler for new user-entered project title. Used to handle persisting title to server, or title validation */
+  accessor projectTitleSave: ((newTitle?: string) => Promise<PortalNavigationProjectSaveResult>) | undefined;
+  /**
+   * fires for all navigation events
+   * emits both a desired url, along with the original event (used to cancel if doing client side routing)
+   */
+  readonly arcgisNavigate: import("@arcgis/lumina").TargetedEvent<this, PortalNavigationNavigateDetail>;
+  /**
+   * fires for all project menu clicks
+   * emits a type from a known set
+   */
+  readonly arcgisNavigationProjectMenuClick: import("@arcgis/lumina").TargetedEvent<this, PortalNavigationProjectMenuClick>;
+  /** fires when user clicks the sign in button */
+  readonly arcgisNavigationSignIn: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** fires when user clicks the sign out button */
+  readonly arcgisNavigationSignOut: import("@arcgis/lumina").TargetedEvent<this, void>;
+  readonly "@eventTypes": {
+    arcgisNavigate: ArcGISPortalNavigation["arcgisNavigate"]["detail"];
+    arcgisNavigationProjectMenuClick: ArcGISPortalNavigation["arcgisNavigationProjectMenuClick"]["detail"];
+    arcgisNavigationSignIn: ArcGISPortalNavigation["arcgisNavigationSignIn"]["detail"];
+    arcgisNavigationSignOut: ArcGISPortalNavigation["arcgisNavigationSignOut"]["detail"];
+  };
+}