Merge pull request #1099 from Esri/onboarding-message

add initialNotice prop
Esri · Jan 15, 2025 · 65b1ebc · 65b1ebc
2 parents a7d377d + d1930b9
commit 65b1ebc
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/src/components.d.ts b/src/components.d.ts
@@ -1641,6 +1641,10 @@ export namespace Components {
           * boolean: When enabled features will be highlighted when their notification list item is clicked.
          */
         "featureHighlightEnabled": boolean;
+        /**
+          * string: The value to show in the initial notice to help with on boarding the user. When left empty the selectLayerAndAdd text from the nls will be used.
+         */
+        "initialNotice": string;
         /**
           * string: The current user locale.
          */
@@ -4480,6 +4484,10 @@ declare namespace LocalJSX {
           * boolean: When enabled features will be highlighted when their notification list item is clicked.
          */
         "featureHighlightEnabled"?: boolean;
+        /**
+          * string: The value to show in the initial notice to help with on boarding the user. When left empty the selectLayerAndAdd text from the nls will be used.
+         */
+        "initialNotice"?: string;
         /**
           * string: The current user locale.
          */

diff --git a/src/components/public-notification/public-notification.tsx b/src/components/public-notification/public-notification.tsx
@@ -137,6 +137,12 @@ export class PublicNotification {
    */
   @Prop() noResultText: string;
 
+  /**
+   * string: The value to show in the initial notice to help with on boarding the user.
+   * When left empty the selectLayerAndAdd text from the nls will be used.
+   */
+  @Prop() initialNotice = "";
+
   /**
    * ISearchConfiguration: Configuration details for the Search widget
    */
@@ -778,10 +784,12 @@ export class PublicNotification {
    */
   protected _getListPage(): VNode {
     const hasSets = this._hasSelections();
+    const noticeMessage = hasSets ? this._translations.listHasSetsTip :
+      this.initialNotice !== "" ? this.initialNotice : this._translations.selectLayerAndAdd;
     return (
       <calcite-panel>
         {this._getLabel(this._translations.myLists)}
-        {this._getNotice(hasSets ? this._translations.listHasSetsTip : this._translations.selectLayerAndAdd, "padding-sides-1 padding-bottom-1", "word-wrap-anywhere")}
+        {this._getNotice(noticeMessage, "padding-sides-1 padding-bottom-1", "word-wrap-anywhere")}
         {hasSets ? this._getSelectionSetList() : (this._getOnboardingImage())}
         <div class="display-flex padding-1">
           <calcite-button onClick={() => { this._setPageType(EPageType.SELECT) }} width="full"><span class="font-weight-500">{this._translations.add}</span></calcite-button>

diff --git a/src/components/public-notification/readme.md b/src/components/public-notification/readme.md
@@ -24,6 +24,7 @@
 | `enableSketchTools`          | `enable-sketch-tools`            | boolean: When true sketch tools will be provided to allow users to draw a selection geometry                                                                                                                                                                                                                                                                                                                | `boolean`                                       | `true`                |
 | `featureEffect`              | --                               | The effect that will be applied when featureHighlightEnabled is true  esri/layers/support/FeatureEffect: https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureEffect.html                                                                                                                                                                                               | `FeatureEffect`                                 | `undefined`           |
 | `featureHighlightEnabled`    | `feature-highlight-enabled`      | boolean: When enabled features will be highlighted when their notification list item is clicked.                                                                                                                                                                                                                                                                                                            | `boolean`                                       | `undefined`           |
+| `initialNotice`              | `initial-notice`                 | string: The value to show in the initial notice to help with on boarding the user. When left empty the selectLayerAndAdd text from the nls will be used.                                                                                                                                                                                                                                                    | `string`                                        | `""`                  |
 | `locale`                     | `locale`                         | string: The current user locale.                                                                                                                                                                                                                                                                                                                                                                            | `string`                                        | `undefined`           |
 | `mapView`                    | --                               | esri/views/MapView: https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html                                                                                                                                                                                                                                                                                                   | `MapView`                                       | `undefined`           |
 | `noResultText`               | `no-result-text`                 | string: The value to show for no results when left empty the default text "0 selected features from {layerTitle}" will be shown                                                                                                                                                                                                                                                                             | `string`                                        | `undefined`           |