@saasquatch/mint-components 1.10.1 → 1.10.2-10

package/dist/cjs/sqm-stencilbook.cjs.entry.js

@@ -28,7 +28,7 @@ const sqmPortalProfileView = require('./sqm-portal-profile-view-fde54e35.js');
 require('./utilities-cec9dd36.js');
 const sqmPortalResetPasswordView = require('./sqm-portal-reset-password-view-96f329ed.js');
 const sqmPortalVerifyEmailView = require('./sqm-portal-verify-email-view-7ffcc0d4.js');
-const ShadowViewAddon = require('./ShadowViewAddon-721bb748.js');
+const ShadowViewAddon = require('./ShadowViewAddon-3e537eb3.js');
 const sqmPortalContainerView = require('./sqm-portal-container-view-5fb2ad49.js');
 const sqmInvoiceTableView = require('./sqm-invoice-table-view-28b14d28.js');
 
@@ -1604,8 +1604,8 @@ const SlottedIntoComponent = () => {
     data: {
       rankType: "rowNumber",
       leaderboard: [],
-      showUser: true,
       rowNumber: 10,
+      showUser: true,
       userRank: {
         firstName: "Kutay",
         lastInitial: "C",
@@ -1813,7 +1813,7 @@ const BigStat = /*#__PURE__*/Object.freeze({
   MultipleStats: MultipleStats
 });
 
-const scenario$4 = "@owner:noah @author:noah\nFeature: Leaderboard\n\tThe leaderboard supports three main cases\n\t- Top Started Referrers\n\t- Top Converted Referrers\n\t- Top Point Earners\n\tTo display these different types of leaderboards it uses the backends pre-canned options.\n\tThe backend supports filtering on programId and interval, programId is sourced from program context.\n\n  Background: A user exists\n    Given a user\n    And they are viewing the leaderboard\n\n  @motivating\n  Scenario Outline: Two types of referrals leaderboards can be displayed\n    Given a leaderboard has prop \"leaderboard-type\" with <value>\n    And there are started referrals on the tenant\n    And there are started converted on the tenant\n    When the user views the leaderboard\n    Then they see the referral <referralType> leaderboard\n\n    Examples:\n      | value                 | referralType |\n      | topStartedReferrers   | started      |\n      | topConvertedReferrers | converted    |\n\n  @motivating\n  Scenario: The top point earners leaderboard can be displayed\n    Given a leaderboard has prop \"leaderboard-type\" with value \"topPointEarners\"\n    And there are users with points\n    When the user views the leaderboard\n    Then they see the top point earners leaderboard\n    And text values are displayed for point counts\n\n  @minutia\n  Scenario Outline: Reward pretty value is used on the top point earners leaderboard\n    Given top point earners leaderboard\n    And the \"POINT\" reward unit has a pretty value for the following locales\n      | locale |\n      | en     |\n      | fr     |\n      | tr     |\n    When the user views the leaderboard\n    And they have <locale>\n    Then they see the translated pretty value in the stat value column\n\n  @motivating\n  Scenario Outline: Program Context is used by default to filter leaderboard results\n    Given a <leaderboardType> leaderboard loaded with program context for \"my-program\"\n    When the user views the leaderboard\n    Then they only see <results> from \"my-program\"\n\n    Examples:\n      | leaderboardType       | results             |\n      | topStartedReferrers   | started referrals   |\n      | topConvertedReferrers | converted referrals |\n      | topPointEarners       | points earned       |\n\n  @motivating\n  Scenario Outline: Program Id context can be overwritten with a prop\n    Given a <leaderboardType> leaderboard has prop \"program-Id\" with value \"my-test-program\"\n    When the user views the leaderboard\n    Then they only see <results> from \"my-test-program\"\n\n    Examples:\n      | leaderboardType       | results             |\n      | topStartedReferrers   | started referrals   |\n      | topConvertedReferrers | converted referrals |\n      | topPointEarners       | points earned       |\n\n  @motivating\n  Scenario Outline: Global leaderboards can be displayed by clearing program context\n\t\t#This is important for clients with use cases like StaffTracks global points leaderboard\n\t\t#This can also be done with a program section in a similar manner\n    Given a <leaderboardType> leaderboard has prop \"program-Id\" with value \"\"\n    When the user views the leaderboard\n    Then they see global <results>\n\n    Examples:\n      | leaderboardType       | results             |\n      | topStartedReferrers   | started referrals   |\n      | topConvertedReferrers | converted referrals |\n      | topPointEarners       | points earned       |\n\n  @motivating\n  Scenario: Leaderboard results are shown in descending order\n    Given there are leaderboard results\n    When the user views the leaderboard\n    Then they see up to the 10 top leaderboard results\n    And leaderboard is in descending order\n\n  @motivating\n  Scenario Outline: Leaderboard results can be filtered with a time interval\n    Given a <leaderboardType> leaderboard\n    And it has prop \"interval\" with value \"2021-11-02T07:00:00.000Z/2021-11-07T07:00:00.000Z\"\n    When the user views the leaderboard\n    Then they only see <results> from within \"2021-11-02T07:00:00.000Z/2021-11-07T07:00:00.000Z\"\n\n    Examples:\n      | leaderboardType       | results             |\n      | topStartedReferrers   | started referrals   |\n      | topConvertedReferrers | converted referrals |\n      | topPointEarners       | points earned       |\n\n  @motivating\n  Scenario Outline: Leaderboard rank type can be configured\n    Given a leaderboard has prop \"rank-type\" with <value>\n    When the user views the leaderboard\n    Then their leaderboard rank is their <rank>\n\n    Examples:\n      | value     | rank       |\n      | rowNumber | row number |\n      | denseRank | dense rank |\n      | rank      | rank       |\n\n  @minutia\n  Scenario Outline: The max number of leaderboard rows displayed can be configured but defaults to 10\n    Given a leaderboard has prop \"max-rows\" with <value>\n    And the leaderboard has <resultCount>\n    When the user views the leaderboard\n    Then they see <number> rows\n\n    Examples:\n      | value | resultCount | number |\n      |       |          10 |     10 |\n      |     5 |          10 |      5 |\n      |     3 |           1 |      1 |\n      |    25 |          15 |     15 |\n\n  @minutiae @ui\n  Scenario: Leaderboards with no results show an empty state\n    Given a leaderboard has no results\n    When the user views the leaderboard\n    Then an empty state is dislayed\n    And they see an image of a leaderboard\n    And below they see \"View your rank in the leaderboard\"\n    And below they see \"Be the first to refer a friend and reach the top of the leaderboard\"\n    And the text is center aligned\n\n  @minutiae @ui\n  Scenario: A custom empty state can be provided\n    Given a leaderboard has no results\n    When the user views the leaderboard\n    Then the contents of the \"empty\" slot are displayed\n\n  @minutiae @ui\n  Scenario: User is on Essentials plan\n    Given the user has an Essentials plan\n    When they view the leaderboard\n    Then a message telling them to upgrade their plan appears:\n      \"\"\"\n      Contact Support to upgrade your plan and start leveraging\n                gamification in your program.\n      \"\"\"\n    And an empty table image is displayed\n\n  @minutiae @ui\n  Scenario: Leaderboard headings can be customized\n    Given a leaderboard\n    And it has the following props\n      | prop         | value          |\n      | rankheading  | Place          |\n      | usersheading | Customer       |\n      | statsheading | Referral Count |\n      | show-rank    | true           |\n    When the user views the leaderboard\n    Then they see the following columns with headings\n      | column | heading        |\n      | rank   | Place          |\n      | user   | Customer       |\n      | stat   | Referral Count |\n\n  @motivating @ui\n  Scenario Outline: Leaderboard rank can be hidden or shown\n    Given a leaderboard\n    And it has prop \"show-rank\" with <propValue>\n    When the user views the leaderboard\n    Then they <maySee> the rank column\n\n    Examples:\n      | propValue | maySee    |\n      | true      | see       |\n      | false     | don't see |\n      |           | don't see |\n\n  @motivating @ui\n  Scenario: Users in the top 10 of the leaderboard results see their leaderboard row highlighted\n    Given a user in the top 10 of the leaderboard results\n    When they view the leaderboard\n    Then they see the row with their name highlighted with brand colour\n\n  @motivating @ui\n  Scenario Outline: Users not in the top 10 leaderboard results can see their progress at the bottom of the leaderboard\n    Given a user <mayHave> completed actions counted by the leaderboard\n    And they are not in the top 10 leaderboard results\n    And the leaderboard has prop \"show-user\" with <value>\n    When they view the leaderboard\n    Then they <maySee> \"...\" under the top 10 leaderboard results\n    And under \"...\" they <maySee> a row highlighted with brand colour\n    And they <maySee> their name\n    And they <maySee> their leaderboard value\n    And they <maySeeRank>\n\n    Examples:\n      | mayHave | value | maySee    | maySeeRank           |\n      | has     | true  | see       | see their rank       |\n      | hasn't  | true  | see       | don't see their rank |\n      | N/A     | false | don't see | don't see their rank |\n      | hasn't  |       | see       | don't see their rank |\n\n  @minutiae\n  Scenario: Users without names are displayed as an \"Anonymous User\"\n    Given a user\n    And they do not have a first name\n    And they do not have a last initial\n    When they view the leaderboard\n    Then they see the user displayed as \"Anonymous User\"\n\n  @minutiae\n  Scenario Outline: If a user only has a first or last name, then only that is displayed\n    Given a user\n    And they only have a <name>\n    When they view the leaderboard\n    Then they only see their <name>\n\n    Examples:\n      | name      |\n      | firstName |\n      | lastName  |\n";
+const scenario$4 = "@owner:noah @author:noah\nFeature: Leaderboard\n\tThe leaderboard supports three main cases\n\t- Top Started Referrers\n\t- Top Converted Referrers\n\t- Top Point Earners\n\tTo display these different types of leaderboards it uses the backends pre-canned options.\n\tThe backend supports filtering on programId and interval, programId is sourced from program context.\n\n  Background: A user exists\n    Given a user\n    And they are viewing the leaderboard\n\n  @motivating\n  Scenario Outline: Two types of referrals leaderboards can be displayed\n    Given a leaderboard has prop \"leaderboard-type\" with <value>\n    And there are started referrals on the tenant\n    And there are started converted on the tenant\n    When the user views the leaderboard\n    Then they see the referral <referralType> leaderboard\n\n    Examples:\n      | value                 | referralType |\n      | topStartedReferrers   | started      |\n      | topConvertedReferrers | converted    |\n\n  @motivating\n  Scenario: The top point earners leaderboard can be displayed\n    Given a leaderboard has prop \"leaderboard-type\" with value \"topPointEarners\"\n    And there are users with points\n    When the user views the leaderboard\n    Then they see the top point earners leaderboard\n    And text values are displayed for point counts\n\n  @minutia\n  Scenario Outline: Reward pretty value is used on the top point earners leaderboard\n    Given top point earners leaderboard\n    And the \"POINT\" reward unit has a pretty value for the following locales\n      | locale |\n      | en     |\n      | fr     |\n      | tr     |\n    When the user views the leaderboard\n    And they have <locale>\n    Then they see the translated pretty value in the stat value column\n\n  @motivating\n  Scenario Outline: Program Context is used by default to filter leaderboard results\n    Given a <leaderboardType> leaderboard loaded with program context for \"my-program\"\n    When the user views the leaderboard\n    Then they only see <results> from \"my-program\"\n\n    Examples:\n      | leaderboardType       | results             |\n      | topStartedReferrers   | started referrals   |\n      | topConvertedReferrers | converted referrals |\n      | topPointEarners       | points earned       |\n\n  @motivating\n  Scenario Outline: Program Id context can be overwritten with a prop\n    Given a <leaderboardType> leaderboard has prop \"program-Id\" with value \"my-test-program\"\n    When the user views the leaderboard\n    Then they only see <results> from \"my-test-program\"\n\n    Examples:\n      | leaderboardType       | results             |\n      | topStartedReferrers   | started referrals   |\n      | topConvertedReferrers | converted referrals |\n      | topPointEarners       | points earned       |\n\n  @motivating\n  Scenario Outline: Global leaderboards can be displayed by clearing program context\n\t\t#This is important for clients with use cases like StaffTracks global points leaderboard\n\t\t#This can also be done with a program section in a similar manner\n    Given a <leaderboardType> leaderboard has prop \"program-Id\" with value \"\"\n    When the user views the leaderboard\n    Then they see global <results>\n\n    Examples:\n      | leaderboardType       | results             |\n      | topStartedReferrers   | started referrals   |\n      | topConvertedReferrers | converted referrals |\n      | topPointEarners       | points earned       |\n\n  @motivating\n  Scenario: Leaderboard results are shown in descending order\n    Given there are leaderboard results\n    When the user views the leaderboard\n    Then they see up to the 10 top leaderboard results\n    And leaderboard is in descending order\n\n  @motivating\n  Scenario Outline: Leaderboard results can be filtered with a time interval\n    Given a <leaderboardType> leaderboard\n    And it has prop \"interval\" with value \"2021-11-02T07:00:00.000Z/2021-11-07T07:00:00.000Z\"\n    When the user views the leaderboard\n    Then they only see <results> from within \"2021-11-02T07:00:00.000Z/2021-11-07T07:00:00.000Z\"\n\n    Examples:\n      | leaderboardType       | results             |\n      | topStartedReferrers   | started referrals   |\n      | topConvertedReferrers | converted referrals |\n      | topPointEarners       | points earned       |\n\n  @motivating\n  Scenario Outline: Leaderboard rank type can be configured\n    Given a leaderboard has prop \"rank-type\" with <value>\n    When the user views the leaderboard\n    Then their leaderboard rank is their <rank>\n\n    Examples:\n      | value     | rank       |\n      | rowNumber | row number |\n      | denseRank | dense rank |\n      | rank      | rank       |\n\n  @minutia\n  Scenario Outline: The max number of leaderboard rows displayed can be configured but defaults to 10\n    Given a leaderboard has prop \"max-rows\" with <value>\n    And the leaderboard has <resultCount>\n    When the user views the leaderboard\n    Then they see <number> rows\n\n    Examples:\n      | value | resultCount | number |\n      |       |          10 |     10 |\n      |     5 |          10 |      5 |\n      |     3 |           1 |      1 |\n      |    25 |          15 |     15 |\n\n  @minutiae @ui\n  Scenario: Leaderboards with no results show an empty state\n    Given a leaderboard has no results\n    When the user views the leaderboard\n    Then an empty state is dislayed\n    And they see an image of a leaderboard\n    And below they see \"View your rank in the leaderboard\"\n    And below they see \"Be the first to refer a friend and reach the top of the leaderboard\"\n    And the text is center aligned\n\n  @minutiae @ui\n  Scenario: A custom empty state can be provided\n    Given a leaderboard has no results\n    When the user views the leaderboard\n    Then the contents of the \"empty\" slot are displayed\n\n  @minutiae @ui\n  Scenario: User is on Essentials plan\n    Given the user has an Essentials plan\n    When they view the leaderboard\n    Then a message telling them to upgrade their plan appears:\n      \"\"\"\n      Contact Support to upgrade your plan and start leveraging\n                gamification in your program.\n      \"\"\"\n    And an empty table image is displayed\n\n  @minutiae @ui\n  Scenario: Leaderboard headings can be customized\n    Given a leaderboard\n    And it has the following props\n      | prop         | value          |\n      | rankheading  | Place          |\n      | usersheading | Customer       |\n      | statsheading | Referral Count |\n      | show-rank    | true           |\n    When the user views the leaderboard\n    Then they see the following columns with headings\n      | column | heading        |\n      | rank   | Place          |\n      | user   | Customer       |\n      | stat   | Referral Count |\n\n  @motivating @ui\n  Scenario Outline: Leaderboard rank can be hidden or shown\n    Given a leaderboard\n    And it has prop \"show-rank\" with <propValue>\n    When the user views the leaderboard\n    Then they <maySee> the rank column\n\n    Examples:\n      | propValue | maySee    |\n      | true      | see       |\n      | false     | don't see |\n      |           | don't see |\n\n    Scenario Outline: Users names can be hidden or shown\n    Given a leaderboard\n    And it has prop \"hide-names\" with <propValue>\n    When the user views the leaderboard\n    Then they <maySee> the referrer column\n\n    Examples:\n      | propValue | maySee    |\n      | true      | don't see |\n      | false     | see       |\n      |           | see       |\n\n  @motivating @ui\n  Scenario: Users in the top 10 of the leaderboard results see their leaderboard row highlighted\n    Given a user in the top 10 of the leaderboard results\n    When they view the leaderboard\n    Then they see the row with their name highlighted with brand colour\n\n  @motivating @ui\n  Scenario Outline: Users not in the top 10 leaderboard results can see their progress at the bottom of the leaderboard\n    Given a user <mayHave> completed actions counted by the leaderboard\n    And they are not in the top 10 leaderboard results\n    And the leaderboard has prop \"show-user\" with <value>\n    When they view the leaderboard\n    Then they <maySee> \"...\" under the top 10 leaderboard results\n    And under \"...\" they <maySee> a row highlighted with brand colour\n    And they <maySee> their name\n    And they <maySee> their leaderboard value\n    And they <maySeeRank>\n\n    Examples:\n      | mayHave | value | maySee    | maySeeRank           |\n      | has     | true  | see       | see their rank       |\n      | hasn't  | true  | see       | don't see their rank |\n      | N/A     | false | don't see | don't see their rank |\n      | hasn't  |       | see       | don't see their rank |\n\n  @minutiae\n  Scenario: Users without names are displayed as an \"Anonymous User\"\n    Given a user\n    And they do not have a first name\n    And they do not have a last initial\n    When they view the leaderboard\n    Then they see the user displayed as \"Anonymous User\"\n\n  @minutiae\n  Scenario Outline: If a user only has a first or last name, then only that is displayed\n    Given a user\n    And they only have a <name>\n    When they view the leaderboard\n    Then they only see their <name>\n\n    Examples:\n      | name      |\n      | firstName |\n      | lastName  |\n";
 
 const Leaderboard_stories = {
   title: "Components/Leaderboard",
@@ -1895,8 +1895,8 @@ const users = [
 ];
 const pointsUsers = [
   {
-    firstName: "",
-    lastInitial: "",
+    firstName: "Tom",
+    lastInitial: "Smith",
     textValue: "82 Points",
     rank: 1,
     rowNumber: 1,
@@ -1970,6 +1970,7 @@ const defaultStyles$1 = {
   statsheading: "Referrals",
   rankheading: "Rank",
   anonymousUser: "Anonymous User",
+  rankSuffix: "{rank, selectordinal, one {#st} two {#nd} few {#rd} other {#th}}",
 };
 const link = index.h("a", null, "Support");
 const defaultElements$1 = {
@@ -2186,6 +2187,38 @@ const ReferralLeaderboard = () => {
   };
   return index.h(ShadowViewAddon.LeaderboardView, Object.assign({}, props));
 };
+const ReferralLeaderboardWithMaxWidth = () => {
+  const props = {
+    states: {
+      loading: false,
+      hasLeaders: true,
+      styles: {
+        ...defaultStyles$1,
+        rankheading: "Rank",
+        usersheading: "User",
+        statsheading: "Referrals",
+        showRank: false,
+        maxWidth: "300px",
+      },
+    },
+    data: {
+      rankType: "rowNumber",
+      leaderboard: users,
+      rowNumber: 10,
+      viewerRank: {
+        firstName: "Viktor",
+        lastInitial: "V",
+        textValue: "82",
+        rank: 1,
+        rowNumber: 1,
+      },
+    },
+    elements: {
+      ...defaultElements$1,
+    },
+  };
+  return index.h(ShadowViewAddon.LeaderboardView, Object.assign({}, props));
+};
 const PointsLeaderboard = () => {
   const props = {
     states: {
@@ -2325,6 +2358,58 @@ const HideViewer = () => {
   };
   return index.h(ShadowViewAddon.LeaderboardView, Object.assign({}, props));
 };
+const HideNames = () => {
+  const props = {
+    states: {
+      loading: false,
+      hasLeaders: true,
+      rowNumber: 10,
+      styles: {
+        ...defaultStyles$1,
+        showRank: true,
+        hideNames: true,
+      },
+    },
+    data: {
+      rankType: "rowNumber",
+      leaderboard: users,
+      rowNumber: 10,
+      viewerRank: {
+        firstName: "Viktor",
+        lastInitial: "V",
+        textValue: "82",
+        rowNumber: 1,
+        rank: 1,
+      },
+    },
+    elements: {
+      ...defaultElements$1,
+    },
+  };
+  return index.h(ShadowViewAddon.LeaderboardView, Object.assign({}, props));
+};
+const LeaderboardWithNoNamesAndGraphic = () => {
+  return (index.h("div", { style: {
+      display: "flex",
+      alignItems: "flex-start",
+      justifyContent: "center",
+      width: "100%",
+      gap: "50px",
+    } },
+    index.h("div", { style: {
+        display: "flex",
+        flexDirection: "column",
+        alignItems: "center",
+        justifyContent: "center",
+        gap: "10px",
+        maxWidth: "30%",
+      } },
+      index.h("sqm-image", { width: "70%", alignment: "center", imageUrl: "https://res.cloudinary.com/saasquatch-staging/image/upload/v1729728469/Leaderboard_image_z87lsm.png" }),
+      index.h("h2", { style: { margin: "auto" } }, " Top Performers"),
+      index.h("p", { style: { margin: "0" } }, "The leaderboard highlights the top performers in real-time. Stay motivated, stay competitive!")),
+    index.h("sqm-leaderboard", { width: "300px", usersheading: "Referrer", statsheading: "Referrals", "rank-type": "rank", "leaderboard-type": "topStartedReferrers", rankheading: "Rank", "show-rank": "true", "hide-names": "true", "hide-viewer": "true" },
+      index.h("sqm-empty", { "empty-state-image": "https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_leaderboard2.png", "empty-state-header": "View your rank in the leaderboard", "empty-state-text": "Be the first to refer a friend and reach the top of the leaderboard" }))));
+};
 
 const Leaderboard = /*#__PURE__*/Object.freeze({
   __proto__: null,
@@ -2335,11 +2420,14 @@ const Leaderboard = /*#__PURE__*/Object.freeze({
   One: One,
   Five: Five,
   ReferralLeaderboard: ReferralLeaderboard,
+  ReferralLeaderboardWithMaxWidth: ReferralLeaderboardWithMaxWidth,
   PointsLeaderboard: PointsLeaderboard,
   TenWithRank: TenWithRank,
   ViewerOutside: ViewerOutside,
   ViewerAnonymous: ViewerAnonymous,
-  HideViewer: HideViewer
+  HideViewer: HideViewer,
+  HideNames: HideNames,
+  LeaderboardWithNoNamesAndGraphic: LeaderboardWithNoNamesAndGraphic
 });
 
 const HookStoryAddon = ({ story }, children) => {

package/dist/collection/components/sqm-empty/EmptyState.stories.js

@@ -37,8 +37,8 @@ export const SlottedIntoComponent = () => {
     data: {
       rankType: "rowNumber",
       leaderboard: [],
-      showUser: true,
       rowNumber: 10,
+      showUser: true,
       userRank: {
         firstName: "Kutay",
         lastInitial: "C",

package/dist/collection/components/sqm-image/sqm-image-view.js

@@ -5,13 +5,14 @@ export function ImageView(props) {
   const style = {
     Container: {
       display: "flex",
+      // width: props.width || "100%",
       width: "100%",
       justifyContent: props.alignment || "center",
       background: props.backgroundColor || "",
     },
     Image: {
       minHeight: props.minHeight || "100%",
-      width: "100%",
+      width: props.width || "100%",
       maxWidth: "max-content",
       objectFit: "cover",
     },

package/dist/collection/components/sqm-image/sqm-image.js

@@ -126,6 +126,26 @@ export class Image {
       },
       "attribute": "min-height",
       "reflect": false
+    },
+    "width": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [{
+            "text": "Width",
+            "name": "uiName"
+          }],
+        "text": "(Optional) Constrains the width of the image. Can be a pixel value or a percentage i.e. \"500px\", \"33%\", etc."
+      },
+      "attribute": "width",
+      "reflect": false
     }
   }; }
 }

package/dist/collection/components/sqm-leaderboard/Leaderboard.stories.js

@@ -81,8 +81,8 @@ const users = [
 ];
 const pointsUsers = [
   {
-    firstName: "",
-    lastInitial: "",
+    firstName: "Tom",
+    lastInitial: "Smith",
     textValue: "82 Points",
     rank: 1,
     rowNumber: 1,
@@ -156,6 +156,7 @@ const defaultStyles = {
   statsheading: "Referrals",
   rankheading: "Rank",
   anonymousUser: "Anonymous User",
+  rankSuffix: "{rank, selectordinal, one {#st} two {#nd} few {#rd} other {#th}}",
 };
 const link = h("a", null, "Support");
 const tag = "Contact" + link + "about upgrading your plan";
@@ -373,6 +374,38 @@ export const ReferralLeaderboard = () => {
   };
   return h(LeaderboardView, Object.assign({}, props));
 };
+export const ReferralLeaderboardWithMaxWidth = () => {
+  const props = {
+    states: {
+      loading: false,
+      hasLeaders: true,
+      styles: {
+        ...defaultStyles,
+        rankheading: "Rank",
+        usersheading: "User",
+        statsheading: "Referrals",
+        showRank: false,
+        maxWidth: "300px",
+      },
+    },
+    data: {
+      rankType: "rowNumber",
+      leaderboard: users,
+      rowNumber: 10,
+      viewerRank: {
+        firstName: "Viktor",
+        lastInitial: "V",
+        textValue: "82",
+        rank: 1,
+        rowNumber: 1,
+      },
+    },
+    elements: {
+      ...defaultElements,
+    },
+  };
+  return h(LeaderboardView, Object.assign({}, props));
+};
 export const PointsLeaderboard = () => {
   const props = {
     states: {
@@ -512,3 +545,55 @@ export const HideViewer = () => {
   };
   return h(LeaderboardView, Object.assign({}, props));
 };
+export const HideNames = () => {
+  const props = {
+    states: {
+      loading: false,
+      hasLeaders: true,
+      rowNumber: 10,
+      styles: {
+        ...defaultStyles,
+        showRank: true,
+        hideNames: true,
+      },
+    },
+    data: {
+      rankType: "rowNumber",
+      leaderboard: users,
+      rowNumber: 10,
+      viewerRank: {
+        firstName: "Viktor",
+        lastInitial: "V",
+        textValue: "82",
+        rowNumber: 1,
+        rank: 1,
+      },
+    },
+    elements: {
+      ...defaultElements,
+    },
+  };
+  return h(LeaderboardView, Object.assign({}, props));
+};
+export const LeaderboardWithNoNamesAndGraphic = () => {
+  return (h("div", { style: {
+      display: "flex",
+      alignItems: "flex-start",
+      justifyContent: "center",
+      width: "100%",
+      gap: "50px",
+    } },
+    h("div", { style: {
+        display: "flex",
+        flexDirection: "column",
+        alignItems: "center",
+        justifyContent: "center",
+        gap: "10px",
+        maxWidth: "30%",
+      } },
+      h("sqm-image", { width: "70%", alignment: "center", imageUrl: "https://res.cloudinary.com/saasquatch-staging/image/upload/v1729728469/Leaderboard_image_z87lsm.png" }),
+      h("h2", { style: { margin: "auto" } }, " Top Performers"),
+      h("p", { style: { margin: "0" } }, "The leaderboard highlights the top performers in real-time. Stay motivated, stay competitive!")),
+    h("sqm-leaderboard", { width: "300px", usersheading: "Referrer", statsheading: "Referrals", "rank-type": "rank", "leaderboard-type": "topStartedReferrers", rankheading: "Rank", "show-rank": "true", "hide-names": "true", "hide-viewer": "true" },
+      h("sqm-empty", { "empty-state-image": "https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_leaderboard2.png", "empty-state-header": "View your rank in the leaderboard", "empty-state-text": "Be the first to refer a friend and reach the top of the leaderboard" }))));
+};

package/dist/collection/components/sqm-leaderboard/sqm-leaderboard-view.js

@@ -1,5 +1,6 @@
 import { h } from "@stencil/core";
 import { createStyleSheet } from "../../styling/JSS";
+import { intl } from "../../global/global";
 const style = {
   Leaderboard: {
     "& table": {
@@ -39,6 +40,9 @@ const style = {
       width: "auto",
       whiteSpace: "nowrap",
     },
+    "& .fullWidth": {
+      width: "100%",
+    },
   },
 };
 const sheet = createStyleSheet(style);
@@ -49,7 +53,7 @@ const vanillaStyle = `
   }
 `;
 export function LeaderboardView(props) {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
   const { states, data, elements } = props;
   const { styles } = states;
   if (states.loading)
@@ -63,17 +67,18 @@ export function LeaderboardView(props) {
   if (!states.hasLeaders)
     return elements.empty;
   let userSeenFlag = false;
-  return (h("div", { class: sheet.classes.Leaderboard, part: "sqm-base" },
+  console.log("The rank is: ", (_a = data.viewerRank) === null || _a === void 0 ? void 0 : _a.rank);
+  console.log("The rank suffix  is: ", styles.width);
+  return (h("div", { class: sheet.classes.Leaderboard, part: "sqm-base", style: { width: styles.width || "100%" } },
     h("style", { type: "text/css" },
       styleString,
       vanillaStyle),
-    h("div", null, "Leaderboards"),
     h("table", { part: "sqm-table" },
       h("tr", null,
-        styles.showRank && h("th", { class: "Rank" }, styles.rankheading),
-        h("th", { class: "User" }, styles.usersheading),
-        h("th", { class: "Score" }, styles.statsheading)), (_a = data.leaderboard) === null || _a === void 0 ? void 0 :
-      _a.map((user) => {
+        styles.showRank && (h("th", { class: `Rank ${styles.hideNames ? "fullWidth" : ""}` }, styles.rankheading)),
+        !styles.hideNames && h("th", { class: "User" }, styles.usersheading),
+        h("th", { class: "Score" }, styles.statsheading)), (_b = data.leaderboard) === null || _b === void 0 ? void 0 :
+      _b.map((user) => {
         var _a, _b;
         if (user.rowNumber === ((_a = data.viewerRank) === null || _a === void 0 ? void 0 : _a.rowNumber))
           userSeenFlag = true;
@@ -81,24 +86,27 @@ export function LeaderboardView(props) {
             user.rowNumber === ((_b = data.viewerRank) === null || _b === void 0 ? void 0 : _b.rowNumber)
             ? "highlight"
             : "" },
-          styles.showRank && h("td", { class: "Rank" }, user.rank),
-          h("td", { class: "User" }, user.firstName && user.lastInitial
+          styles.showRank && (h("td", { class: "Rank" }, intl.formatMessage({
+            id: "rank",
+            defaultMessage: styles.rankSuffix,
+          }, { rank: user.rank }))),
+          !styles.hideNames && (h("td", { class: "User" }, user.firstName && user.lastInitial
             ? user.firstName + " " + user.lastInitial
             : user.firstName || user.lastInitial
               ? user.firstName || user.lastInitial
-              : styles.anonymousUser),
+              : styles.anonymousUser)),
           h("td", { class: "Score" }, user.textValue)));
       }),
       !userSeenFlag && !styles.hideViewer && (h("tr", null,
         h("td", { colSpan: 100, class: "ellipses" },
           h("sl-icon", { name: "three-dots", style: { verticalAlign: "middle" } })))),
       !userSeenFlag && !styles.hideViewer && (h("tr", { class: "highlight" },
-        styles.showRank && (h("td", { class: "Rank" }, ((_b = data.viewerRank) === null || _b === void 0 ? void 0 : _b.rank) || "-")),
-        h("td", { class: "User" }, ((_c = data.viewerRank) === null || _c === void 0 ? void 0 : _c.firstName) && ((_d = data.viewerRank) === null || _d === void 0 ? void 0 : _d.lastInitial)
-          ? ((_e = data.viewerRank) === null || _e === void 0 ? void 0 : _e.firstName) +
-            " " + ((_f = data.viewerRank) === null || _f === void 0 ? void 0 : _f.lastInitial)
-          : ((_g = data.viewerRank) === null || _g === void 0 ? void 0 : _g.firstName) || ((_h = data.viewerRank) === null || _h === void 0 ? void 0 : _h.lastInitial)
-            ? ((_j = data.viewerRank) === null || _j === void 0 ? void 0 : _j.firstName) || ((_k = data.viewerRank) === null || _k === void 0 ? void 0 : _k.lastInitial)
-            : styles.anonymousUser),
-        h("td", { class: "Score" }, ((_l = data.viewerRank) === null || _l === void 0 ? void 0 : _l.textValue) || "0"))))));
+        styles.showRank && (h("td", { class: "Rank" }, ((_c = data.viewerRank) === null || _c === void 0 ? void 0 : _c.rank) || "-")),
+        !styles.hideNames && (h("td", { class: "User" }, ((_d = data.viewerRank) === null || _d === void 0 ? void 0 : _d.firstName) && ((_e = data.viewerRank) === null || _e === void 0 ? void 0 : _e.lastInitial)
+          ? ((_f = data.viewerRank) === null || _f === void 0 ? void 0 : _f.firstName) +
+            " " + ((_g = data.viewerRank) === null || _g === void 0 ? void 0 : _g.lastInitial)
+          : ((_h = data.viewerRank) === null || _h === void 0 ? void 0 : _h.firstName) || ((_j = data.viewerRank) === null || _j === void 0 ? void 0 : _j.lastInitial)
+            ? ((_k = data.viewerRank) === null || _k === void 0 ? void 0 : _k.firstName) || ((_l = data.viewerRank) === null || _l === void 0 ? void 0 : _l.lastInitial)
+            : styles.anonymousUser)),
+        h("td", { class: "Score" }, ((_m = data.viewerRank) === null || _m === void 0 ? void 0 : _m.textValue) || "0"))))));
 }

package/dist/collection/components/sqm-leaderboard/sqm-leaderboard.js

@@ -9,14 +9,25 @@ import { useLeaderboard } from "./useLeaderboard";
  * @uiName Leaderboard
  * @slots [{"name":"empty", "title":"Empty State"}]
  * @requiredFeatures ["LEADERBOARDS"]
+ * @validParents ["div"]
  * @exampleGroup Leaderboard
  * @example Referral Started Leaderboard - <sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rank-type="rank" leaderboard-type="topStartedReferrers" rankheading="Rank" show-rank="true"><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard" ></sqm-empty></sqm-leaderboard>
  * @example Referral Converted Leaderboard - <sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rank-type="rank" leaderboard-type="topConvertedReferrers" rankheading="Rank" show-rank="true"><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard" ></sqm-empty></sqm-leaderboard>
  * @example Points Earned Leaderboard - <sqm-leaderboard usersheading="Name" statsheading="Points" rank-type="rank" leaderboard-type="topPointEarners" rankheading="Rank" show-rank="true"><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard" ></sqm-empty></sqm-leaderboard>
+ * @example Anonymous Leaderboard - <div style="display: flex; align-items: flex-start; justify-content: center; width: 100%; gap: 50px;"><div style="display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 10px; max-width: 30%;"><sqm-image width="70%" alignment="center" imageUrl="https://res.cloudinary.com/saasquatch-staging/image/upload/v1729728469/Leaderboard_image_z87lsm.png"></sqm-image><h2 style="margin: auto;">Top Performers</h2><p style="margin: 0;">The leaderboard highlights the top performers in real-time. Stay motivated, stay competitive!</p></div><sqm-leaderboard width="300px" usersheading="Referrer" statsheading="Referrals" rank-type="rank" leaderboard-type="topStartedReferrers" rankheading="Rank" show-rank="true" hide-names="true" hide-viewer="true"><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard"></sqm-empty></sqm-leaderboard></div>
+ * @example Test - <sqm-leaderboard usersheading="Name" statsheading="Points" rank-type="rank" leaderboard-type="topPointEarners" rankheading="Rank" show-rank="true"><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to refer a friend and reach the top of the leaderboard" ></sqm-empty></sqm-leaderboard>
  * @featureTooltip <div>Motivate your participants by gamifying your program. Contact <a href="mailto:saasquatch-support%40impact.com?subject=Next steps for Leaderboards feature&body=Hi Support Team, %0D%0A%0D%0A I am interested in learning more about how Leaderboards can support the growth of our referral program. Please connect me with a program strategy manager to discuss this feature further, and determine the next steps.%0D%0A%0D%0A%0D%0AThank you,%0D%0A[Add your name here]">Support</a> to upgrade your plan and add a leaderboard.</div>
  */
 export class Leaderboard {
   constructor() {
+    /**
+     * @uiName Place text
+     */
+    this.width = "100%";
+    /**
+     * @uiName Rank Suffix
+     */
+    this.rankSuffix = "{rank, selectordinal, one {#st} two {#nd} few {#rd} other {#th}}";
     /**
      * Hide the viewer's leaderboard row if not in the top results.
      *
@@ -24,10 +35,17 @@ export class Leaderboard {
      * @default
      */
     this.hideViewer = false;
+    /**
+     * Hide the Names of users to protect personal identifiable information
+     *
+     * @uiName Hide users names
+     * @default
+     */
+    this.hideNames = false;
     /**
      * Hides the leaderboard if user is on Essentials plan
      *
-     * @uiName Hide viewing user
+     * @uiName Hide leaderboard for essentials user
      * @default
      */
     this.isEssentials = false;
@@ -62,8 +80,11 @@ export class Leaderboard {
       anonymousUser: this.anonymousUser,
       interval: this.interval,
       hideViewer: this.hideViewer,
+      hideNames: this.hideNames,
       showRank: this.showRank,
       isEssentials: this.isEssentials,
+      rankSuffix: this.rankSuffix,
+      width: this.width,
     };
     const demoProps = { ...props, demoData: this.demoData };
     const viewprops = isDemo()
@@ -177,6 +198,48 @@ export class Leaderboard {
       "attribute": "show-rank",
       "reflect": false
     },
+    "width": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Place text",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "width",
+      "reflect": false,
+      "defaultValue": "\"100%\""
+    },
+    "rankSuffix": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Rank Suffix",
+            "name": "uiName"
+          }],
+        "text": ""
+      },
+      "attribute": "rank-suffix",
+      "reflect": false,
+      "defaultValue": "\"{rank, selectordinal, one {#st} two {#nd} few {#rd} other {#th}}\""
+    },
     "hideViewer": {
       "type": "boolean",
       "mutable": false,
@@ -201,6 +264,30 @@ export class Leaderboard {
       "reflect": false,
       "defaultValue": "false"
     },
+    "hideNames": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "text": "Hide users names",
+            "name": "uiName"
+          }, {
+            "text": undefined,
+            "name": "default"
+          }],
+        "text": "Hide the Names of users to protect personal identifiable information"
+      },
+      "attribute": "hide-names",
+      "reflect": false,
+      "defaultValue": "false"
+    },
     "isEssentials": {
       "type": "boolean",
       "mutable": false,
@@ -213,7 +300,7 @@ export class Leaderboard {
       "optional": true,
       "docs": {
         "tags": [{
-            "text": "Hide viewing user",
+            "text": "Hide leaderboard for essentials user",
             "name": "uiName"
           }, {
             "text": undefined,
@@ -359,7 +446,7 @@ export class Leaderboard {
       "mutable": false,
       "complexType": {
         "original": "DemoData<LeaderboardViewProps>",
-        "resolved": "{ states?: { loading: boolean; hasLeaders: boolean; isEssentials?: boolean; styles: { usersheading: string; statsheading: string; rankheading?: string; showRank?: boolean; hideViewer?: boolean; anonymousUser?: string; }; }; data?: { rankType: string; leaderboard: { textValue: string; rank: number; firstName: string; lastInitial: string; rowNumber: number; }[]; viewerRank?: { textValue: string; rank: number; firstName: string; lastInitial: string; rowNumber: number; }; }; elements?: { empty: VNode; essentials: VNode; loadingstate: VNode; }; }",
+        "resolved": "{ states?: { loading: boolean; hasLeaders: boolean; isEssentials?: boolean; styles: { usersheading: string; statsheading: string; rankheading?: string; showRank?: boolean; hideViewer?: boolean; hideNames?: boolean; anonymousUser?: string; rankSuffix?: string; width?: string; }; }; data?: { rankType: string; leaderboard: { textValue: string; rank: number; firstName: string; lastInitial: string; rowNumber: number; }[]; viewerRank?: { textValue: string; rank: number; firstName: string; lastInitial: string; rowNumber: number; }; }; elements?: { empty: VNode; essentials: VNode; loadingstate: VNode; }; }",
         "references": {
           "DemoData": {
             "location": "import",
@@ -460,6 +547,9 @@ function useLeaderboardDemo(props) {
           : "Anonymous User",
         showRank: props.showRank,
         hideViewer: props.hideViewer,
+        hideNames: props.hideNames,
+        rankSuffix: props.rankSuffix,
+        width: props.width,
       },
     },
     data: {