@saasquatch/mint-components 1.5.6-2 → 1.5.6-5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/dist/cjs/sqm-stencilbook.cjs.entry.js +2 -1
  2. package/dist/collection/components/sqm-big-stat/sqm-big-stat.js +2 -1
  3. package/dist/collection/components/sqm-brand/sqm-brand.js +1 -1
  4. package/dist/collection/components/sqm-card-feed/sqm-card-feed.js +1 -0
  5. package/dist/collection/components/sqm-hero-image/sqm-hero-image.js +1 -0
  6. package/dist/collection/components/sqm-image/sqm-image.js +1 -0
  7. package/dist/collection/components/sqm-leaderboard/sqm-leaderboard.js +2 -0
  8. package/dist/collection/components/sqm-leaderboard-rank/sqm-leaderboard-rank.js +4 -0
  9. package/dist/collection/components/sqm-portal-container/sqm-portal-container.js +1 -0
  10. package/dist/collection/components/sqm-program-explainer/sqm-program-explainer.js +2 -0
  11. package/dist/collection/components/sqm-program-explainer-step/sqm-program-explainer-step.js +1 -0
  12. package/dist/collection/components/sqm-referral-card/sqm-referral-card.js +1 -0
  13. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-column.js +1 -0
  14. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-date-column.js +1 -0
  15. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-rewards-column.js +1 -0
  16. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-status-column.js +1 -0
  17. package/dist/collection/components/sqm-referral-table/columns/sqm-referral-table-user-column.js +1 -0
  18. package/dist/collection/components/sqm-referral-table/sqm-referral-table.js +2 -0
  19. package/dist/collection/components/sqm-reward-exchange-list/sqm-reward-exchange-list.js +2 -0
  20. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-date-column.js +1 -0
  21. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-note-column.js +1 -0
  22. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-reward-column.js +1 -0
  23. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-source-column.js +1 -0
  24. package/dist/collection/components/sqm-rewards-table/columns/sqm-rewards-table-status-column.js +1 -0
  25. package/dist/collection/components/sqm-rewards-table/sqm-rewards-table.js +2 -0
  26. package/dist/collection/components/sqm-scroll/sqm-scroll.js +2 -0
  27. package/dist/collection/components/sqm-share-button/sqm-share-button.js +2 -0
  28. package/dist/collection/components/sqm-share-code/sqm-share-code.js +1 -0
  29. package/dist/collection/components/sqm-share-link/sqm-share-link.js +1 -0
  30. package/dist/collection/components/sqm-stat-container/sqm-stat-container.js +2 -0
  31. package/dist/collection/components/sqm-tab/sqm-tab.js +3 -0
  32. package/dist/collection/components/sqm-tabs/Tabs.stories.js +2 -1
  33. package/dist/collection/components/sqm-tabs/sqm-tabs.js +5 -0
  34. package/dist/collection/components/sqm-task-card/sqm-task-card.js +1 -0
  35. package/dist/collection/components/sqm-text/sqm-text.js +7 -0
  36. package/dist/collection/components/sqm-timeline/sqm-timeline-entry.js +1 -0
  37. package/dist/collection/components/sqm-timeline/sqm-timeline.js +1 -0
  38. package/dist/collection/components/sqm-titled-section/sqm-titled-section.js +2 -0
  39. package/dist/collection/components/sqm-user-name/sqm-user-name.js +2 -0
  40. package/dist/esm/sqm-stencilbook.entry.js +2 -1
  41. package/dist/esm-es5/sqm-stencilbook.entry.js +1 -1
  42. package/dist/mint-components/mint-components.esm.js +1 -1
  43. package/dist/mint-components/{p-c7b0f076.entry.js → p-37ea62c3.entry.js} +1 -1
  44. package/dist/mint-components/{p-5bef951d.system.entry.js → p-6e1ed926.system.entry.js} +1 -1
  45. package/dist/mint-components/p-94096609.system.js +1 -1
  46. package/dist/types/components/sqm-big-stat/sqm-big-stat.d.ts +2 -1
  47. package/dist/types/components/sqm-brand/sqm-brand.d.ts +1 -1
  48. package/dist/types/components/sqm-card-feed/sqm-card-feed.d.ts +1 -0
  49. package/dist/types/components/sqm-hero-image/sqm-hero-image.d.ts +1 -0
  50. package/dist/types/components/sqm-image/sqm-image.d.ts +1 -0
  51. package/dist/types/components/sqm-leaderboard/sqm-leaderboard.d.ts +2 -0
  52. package/dist/types/components/sqm-leaderboard-rank/sqm-leaderboard-rank.d.ts +4 -0
  53. package/dist/types/components/sqm-portal-container/sqm-portal-container.d.ts +1 -0
  54. package/dist/types/components/sqm-program-explainer/sqm-program-explainer.d.ts +2 -0
  55. package/dist/types/components/sqm-program-explainer-step/sqm-program-explainer-step.d.ts +1 -0
  56. package/dist/types/components/sqm-referral-card/sqm-referral-card.d.ts +1 -0
  57. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-column.d.ts +1 -0
  58. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-date-column.d.ts +1 -0
  59. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-rewards-column.d.ts +1 -0
  60. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-status-column.d.ts +1 -0
  61. package/dist/types/components/sqm-referral-table/columns/sqm-referral-table-user-column.d.ts +1 -0
  62. package/dist/types/components/sqm-referral-table/sqm-referral-table.d.ts +2 -0
  63. package/dist/types/components/sqm-reward-exchange-list/sqm-reward-exchange-list.d.ts +2 -0
  64. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-date-column.d.ts +1 -0
  65. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-note-column.d.ts +1 -0
  66. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-reward-column.d.ts +1 -0
  67. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-source-column.d.ts +1 -0
  68. package/dist/types/components/sqm-rewards-table/columns/sqm-rewards-table-status-column.d.ts +1 -0
  69. package/dist/types/components/sqm-rewards-table/sqm-rewards-table.d.ts +2 -0
  70. package/dist/types/components/sqm-scroll/sqm-scroll.d.ts +2 -0
  71. package/dist/types/components/sqm-share-button/sqm-share-button.d.ts +2 -0
  72. package/dist/types/components/sqm-share-code/sqm-share-code.d.ts +1 -0
  73. package/dist/types/components/sqm-share-link/sqm-share-link.d.ts +1 -0
  74. package/dist/types/components/sqm-stat-container/sqm-stat-container.d.ts +2 -0
  75. package/dist/types/components/sqm-tab/sqm-tab.d.ts +3 -0
  76. package/dist/types/components/sqm-tabs/sqm-tabs.d.ts +5 -0
  77. package/dist/types/components/sqm-task-card/sqm-task-card.d.ts +1 -0
  78. package/dist/types/components/sqm-text/sqm-text.d.ts +7 -0
  79. package/dist/types/components/sqm-timeline/sqm-timeline-entry.d.ts +1 -0
  80. package/dist/types/components/sqm-timeline/sqm-timeline.d.ts +1 -0
  81. package/dist/types/components/sqm-titled-section/sqm-titled-section.d.ts +2 -0
  82. package/dist/types/components/sqm-user-name/sqm-user-name.d.ts +2 -0
  83. package/docs/docs.docx +0 -0
  84. package/docs/raisins.json +1 -1
  85. package/package.json +5 -3
@@ -12372,7 +12372,8 @@ const ManyTabs = () => (index.h("div", { style: { maxWidth: "700px", margin: "au
12372
12372
  <sqm-tabs>
12373
12373
  <sqm-tab header="General">This is the general tab</sqm-tab>
12374
12374
  <sqm-tab header="Custom">This is the custom tab</sqm-tab>
12375
- <sqm-tab header="Advanced">This is the advanced tab</sqm-tab> <sqm-tab header="General">This is the general tab</sqm-tab>
12375
+ <sqm-tab header="Advanced">This is the advanced tab</sqm-tab>
12376
+ <sqm-tab header="General">This is the general tab</sqm-tab>
12376
12377
  <sqm-tab header="Custom">This is the custom tab</sqm-tab>
12377
12378
  <sqm-tab header="Advanced">This is the advanced tab</sqm-tab>
12378
12379
  <sqm-tab header="General">This is the general tab</sqm-tab>
@@ -8,7 +8,8 @@ import { isDemo, useHost } from "@saasquatch/component-boilerplate";
8
8
  *
9
9
  * @uiName Big Stat
10
10
  * @slots [{"name":"","title":"Stat Text"}]
11
- * @example Points Balance - <sqm-big-stat flex-reverse="true" alignment="left" stat-type="/rewardBalance/CREDIT/POINT/value/global">Points Balance</sqm-big-stat>
11
+ * @exampleGroup Statistics
12
+ * @example Points Balance - <sqm-big-stat flex-reverse="true" alignment="left" stat-type="/rewardBalance/CREDIT/POINT/value/global">Points Balance</sqm-big-stat>
12
13
  * @example GiftCards Earned - <sqm-big-stat flex-reverse="true" alignment="left" stat-type="/integrationRewardsCountFiltered/AVAILABLE/global">Giftcards Earned</sqm-big-stat>
13
14
  * @example Referrals - <sqm-big-stat flex-reverse="true" alignment="left" stat-type="/referralsCount">Referrals</sqm-big-stat>
14
15
  */
@@ -4,9 +4,9 @@ import { Component, h, Host, Prop } from "@stencil/core";
4
4
  import { buildFontsCssUrl } from "../../fonts/GoogleFonts";
5
5
  import { autoColorScaleCss } from "../sqm-stencilbook/AutoColor";
6
6
  /**
7
- *
8
7
  * @uiName Brand Container
9
8
  * @slots [{"name":"","title":"Branded Content"}]
9
+ * @exampleGroup Common Components
10
10
  */
11
11
  export class BrandComponent {
12
12
  constructor() {
@@ -5,6 +5,7 @@ import { CardFeedView } from "./sqm-card-feed-view";
5
5
  /**
6
6
  * @uiName Card Feed
7
7
  * @slots [{"name":"","title":"Cards"}]
8
+ * @exampleGroup Rewards
8
9
  */
9
10
  export class CardFeed {
10
11
  constructor() {
@@ -4,6 +4,7 @@ import { getProps } from "../../utils/utils";
4
4
  import { HeroImageView } from "./sqm-hero-image-view";
5
5
  /**
6
6
  * @uiName Hero Image
7
+ * @exampleGroup Common Components
7
8
  * @example Two Column Layout - <sqm-hero-image image-url="https://res.cloudinary.com/saasquatch/image/upload/v1644000275/squatch-assets/yr6ER3R.png" header="MyCompany Rewards" description="Refer a friend and earn up to $1200 in rewards" layout="columns" image-pos="right" background-color="#F9F9F9"></sqm-hero-image>
8
9
  * @example Overlay - <sqm-hero-image image-url="https://res.cloudinary.com/saasquatch/image/upload/v1644000275/squatch-assets/yr6ER3R.png" header="MyCompany Rewards" description="Refer a friend and earn up to $1200 in rewards" layout="overlay" image-pos="center" background-color="#F9F9F9" button-link="https://www.example.com" button-new-tab button-text="Earn!" image-percentage="45" overlay-opacity=".5" padding-image="small" padding-text="xxxx-large"></sqm-hero-image>
9
10
  */
@@ -3,6 +3,7 @@ import { getProps } from "../../utils/utils";
3
3
  import { ImageView } from "./sqm-image-view";
4
4
  /**
5
5
  * @uiName Image
6
+ * @exampleGroup Common Components
6
7
  */
7
8
  export class Image {
8
9
  constructor() {
@@ -7,6 +7,8 @@ import { LeaderboardView } from "./sqm-leaderboard-view";
7
7
  import { useLeaderboard } from "./useLeaderboard";
8
8
  /**
9
9
  * @uiName Leaderboard
10
+ * @slot [{"name":"empty", "title":"Empty State"}]
11
+ * @exampleGroup Leaderboards
10
12
  * @example Referral Converted Leaderboard - <sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topConvertedReferrers" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/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>
11
13
  * @example Referral Started Leaderboard - <sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topStartedReferrers" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/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>
12
14
  * @example Point Earners Leaderboard - <sqm-leaderboard usersheading="Users" statsheading="Points Earned" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topPointEarners" show-rank anonymous-user="Anonymous User"> <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to earn points and reach the top of the leaderboard" ></sqm-empty></sqm-leaderboard>
@@ -7,6 +7,10 @@ import deepmerge from "deepmerge";
7
7
  import { intl } from "../../global/global";
8
8
  /**
9
9
  * @uiName Leaderboard Rank
10
+ * @exampleGroup Leaderboards
11
+ * @example Referral Converted Leaderboard - <sqm-leaderboard-rank leaderboard-type="topConvertedReferrers" rank-type="rowNumber" rank-text="You are currently in {rank, selectordinal, one {#st} two {#nd} few {#rd} other {#th} } place!" unranked-text="You are currently unranked, refer a friend!"></sqm-leaderboard-rank>
12
+ * @example Referral Started Leaderboard - <sqm-leaderboard-rank leaderboard-type="topStartedReferrers" rank-type="rowNumber" rank-text="You are currently in {rank, selectordinal, one {#st} two {#nd} few {#rd} other {#th} } place!" unranked-text="You are currently unranked, refer a friend!"></sqm-leaderboard-rank>
13
+ * @example Point Earners Leaderboard - <sqm-leaderboard-rank rleaderboard-type="topPointEarners" ank-type="rowNumber" rank-text="You are currently in {rank, selectordinal, one {#st} two {#nd} few {#rd} other {#th} } place!" unranked-text="You are currently unranked, earn points!"></sqm-leaderboard-rank>
10
14
  */
11
15
  export class LeaderboardRank {
12
16
  constructor() {
@@ -5,6 +5,7 @@ import { getProps } from "../../utils/utils";
5
5
  /**
6
6
  * @uiName Portal Container
7
7
  * @slots [{"name":"","title":"Widget Content"}]
8
+ * @exampleGroup Layout
8
9
  */
9
10
  export class PortalContainer {
10
11
  constructor() {
@@ -4,6 +4,8 @@ import { getProps } from "../../utils/utils";
4
4
  import { ProgramExplainerView } from "./sqm-program-explainer-view";
5
5
  /**
6
6
  * @uiName Program Explainer
7
+ * @exampleGroup Common Components
8
+ * @slot [{"name":"", "title":"Explainer", "validChildren":["sqm-program-explainer-step"]}]
7
9
  * @examples Program Explainer - <sqm-program-explainer header="How it works"><sqm-program-explainer-step description="Complete tasks like uploading your first video or sharing videos with friends" header="Earn points" icon="cash-stack" text-color="#000000"></sqm-program-explainer-step><sqm-program-explainer-step description="Use your points and redeem rewards like one free month of Enterprise or a visa giftcard" header="Redeem rewards" icon="people" text-color="#000000"></sqm-program-explainer-step></sqm-program-explainer>
8
10
  */
9
11
  export class ProgramExplainer {
@@ -4,6 +4,7 @@ import { getProps } from "../../utils/utils";
4
4
  import { ProgramExplainerStepView } from "./sqm-program-explainer-step-view";
5
5
  /**
6
6
  * @uiName Program Explainer Step
7
+ * @exampleGroup Common Components
7
8
  * @example Program Explainer Step - <sqm-program-explainer-step description="Complete tasks like uploading your first video or sharing videos with friends" header="Earn points" icon="cash-stack" text-color="#000000"></sqm-program-explainer-step>
8
9
  * @validParents ["sqm-program-explainer"]
9
10
  */
@@ -4,6 +4,7 @@ import { getProps } from "../../utils/utils";
4
4
  import { ReferralCardView } from "./sqm-referral-card-view";
5
5
  /**
6
6
  * @uiName Referral Card
7
+ * @exampleGroup Referrals
7
8
  * @slots [{"name":"left","title":"Left Content"},{"name":"right","title":"Right Content"}]
8
9
  * @example Referral Card - <sqm-referral-card vertical-alignment="start"> <sqm-portal-container gap="large" slot="left" direction="column" display="grid" max-width="100%" padding="none" > <sqm-text >They’ll get a $50 credit towards a new account and you’ll get: </sqm-text> <sqm-timeline icon="circle"> <sqm-timeline-entry reward="$50" unit="visa giftcard" desc="Your friend purchases a Business plan" icon="circle" > </sqm-timeline-entry> <sqm-timeline-entry reward="$200" unit="visa giftcard" desc="Our sales team qualifies your friend as a good fit for our Enterprise plan" icon="circle" > </sqm-timeline-entry> <sqm-timeline-entry reward="$1000" unit="visa giftcard" desc="Your friend purchases an Enterprise plan" icon="circle" > </sqm-timeline-entry> </sqm-timeline> </sqm-portal-container> <sqm-portal-container gap="large" slot="right" direction="column" display="grid" max-width="100%" padding="none" > <sqm-text>Choose how you want to share: </sqm-text> <sqm-text> <sub>Your unique referral link:</sub> <sqm-share-link tooltip-text="Copied to Clipboard" tooltip-lifespan="1000" > </sqm-share-link> </sqm-text> <sqm-portal-container gap="x-small" direction="column" display="grid" max-width="100%" padding="none" > <sqm-share-button medium="email" icon-slot="prefix" size="medium" type="default" > Share via email </sqm-share-button> <sqm-share-button medium="linkedin" icon-slot="prefix" size="medium" type="default" > Share on LinkedIn </sqm-share-button> <sqm-share-button medium="twitter" icon-slot="prefix" size="medium" type="default" > Share on Twitter </sqm-share-button> </sqm-portal-container> </sqm-portal-container> </sqm-referral-card>
9
10
  */
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Referral Table Generic Column
6
6
  * @validParents ["sqm-referral-table"]
7
+ * @exampleGroup Referrals
7
8
  */
8
9
  export class ReferralTableGenericColumn {
9
10
  constructor() {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Referral Table Date Column
6
6
  * @validParents ["sqm-referral-table"]
7
+ * @exampleGroup Referrals
7
8
  */
8
9
  export class ReferralTableDateColumn {
9
10
  constructor() {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Referral Table Rewards Column
6
6
  * @validParents ["sqm-referral-table"]
7
+ * @exampleGroup Referrals
7
8
  */
8
9
  export class ReferralTableRewardsColumn {
9
10
  constructor() {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Referral Table Status Column
6
6
  * @validParents ["sqm-referral-table"]
7
+ * @exampleGroup Referrals
7
8
  */
8
9
  export class ReferralTableStatusColumn {
9
10
  constructor() {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Referral Table User Column
6
6
  * @validParents ["sqm-referral-table"]
7
+ * @exampleGroup Referrals
7
8
  */
8
9
  export class ReferralTableUserColumn {
9
10
  constructor() {
@@ -10,6 +10,8 @@ import mockReferralData from "./mockReferralData";
10
10
  import { tryMethod, useReferralTable } from "./useReferralTable";
11
11
  /**
12
12
  * @uiName Referral Table
13
+ * @exampleGroup Referrals
14
+ * @slots [{"name":"", "title":"Table Row"}]
13
15
  */
14
16
  export class ReferralTable {
15
17
  constructor() {
@@ -8,6 +8,8 @@ import { getProps } from "../../utils/utils";
8
8
  import { demoRewardExchange } from "./RewardExchangeListData";
9
9
  /**
10
10
  * @uiName Reward Exchange
11
+ * @slots [{"name":"empty", "title":"Empty State"}]
12
+ * @exampleGroup Rewards
11
13
  * @example Reward Exchange - <sqm-reward-exchange-list back-text="Back" button-text="Exchange Rewards" cancel-text="Cancel" choose-amount-title="Select" choose-reward-title="Rewards" confirmation-title="Confirm" continue-text="Continue" continue-to-confirmation-text="Continue to confirmation" done-text="Done" reward-title="Choose a reward" not-available-error="{unavailableReasonCode, select, US_TAX {US Tax limit} INSUFFICIENT_REDEEMABLE_CREDIT {{sourceValue} required} AVAILABILITY_PREDICATE {Not available} other {{unavailableReasonCode}} }" not-enough-error="Not enough {sourceUnit} to redeem for this reward" query-error="Unable to load reward exchange list. Please try again" redeem-text="Redeem" redeem-title="Confirm and redeem" redemption-error="An error occured trying to redeem this reward. Please try again" redemption-success-text="Redeemed {sourceValue} for {destinationValue}" select-text="Select amount to receive" source-amount-message="{ruleType, select, FIXED_GLOBAL_REWARD {{sourceValue}} other {{sourceMinValue} to {sourceMaxValue}}}" tooltiptext="Copied" reward-name-title="Reward" reward-amount-title="Reward Amount" cost-title="Cost to Redeem" reward-redeemed-text="Reward redeemed" skeleton-card-num="8" promo-code="Promo Code" tooltip-text="Copied!"><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_exchange2.png" empty-state-header="Redeem rewards" empty-state-text="Use your points to redeem rewards once they become available" > </sqm-empty></sqm-reward-exchange-list>
12
14
  */
13
15
  export class SqmRewardExchangeList {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Reward Table Date Column
6
6
  * @validParents ["sqm-rewards-table"]
7
+ * @exampleGroup Rewards
7
8
  */
8
9
  export class RewardTableDateColumn {
9
10
  constructor() {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Reward Table Customer Note Column
6
6
  * @validParents ["sqm-rewards-table"]
7
+ * @exampleGroup Rewards
7
8
  */
8
9
  export class RewardTableCustomerNoteColumn {
9
10
  constructor() {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Rewards Table Reward Column
6
6
  * @validParents ["sqm-rewards-table"]
7
+ * @exampleGroup Rewards
7
8
  */
8
9
  export class RewardsTableColumn {
9
10
  constructor() {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Reward Table Source Column
6
6
  * @validParents ["sqm-rewards-table"]
7
+ * @exampleGroup Rewards
7
8
  */
8
9
  export class RewardTableUserColumn {
9
10
  constructor() {
@@ -4,6 +4,7 @@ import { useRequestRerender } from "../../../tables/re-render";
4
4
  /**
5
5
  * @uiName Reward Table Status Column
6
6
  * @validParents ["sqm-rewards-table"]
7
+ * @exampleGroup Rewards
7
8
  */
8
9
  export class RewardTableStatusColumn {
9
10
  constructor() {
@@ -10,6 +10,8 @@ import mockRewardData from "./mockRewardData";
10
10
  import { tryMethod, useRewardsTable } from "./useRewardsTable";
11
11
  /**
12
12
  * @uiName Reward Table
13
+ * @exampleGroup Rewards
14
+ * @slots [{"name":"", "title":"Table Row"}]
13
15
  */
14
16
  export class RewardsTable {
15
17
  constructor() {
@@ -4,6 +4,8 @@ import { useScroll } from "./useScroll";
4
4
  import { createStyleSheet } from "../../styling/JSS";
5
5
  /**
6
6
  * @uiName Scroll
7
+ * @exampleGroup Common Components
8
+ * @slots [{"name":"", "title":"Button Content"}]
7
9
  */
8
10
  export class Scroll {
9
11
  constructor() {
@@ -7,7 +7,9 @@ import { getProps } from "../../utils/utils";
7
7
  import deepmerge from "deepmerge";
8
8
  /**
9
9
  * @uiName Share Button
10
+ * @slots [{"name":"", "title":"Button Content"}]
10
11
  * @uiOrder ["medium", "program-id", "*", "pill", "disabled", "hideicon"]
12
+ * @exampleGroup Sharing
11
13
  * @example Facebook Share Button - <sqm-share-button medium="facebook">Share on Facebook</sqm-share-button>
12
14
  * @example Twitter Share Button - <sqm-share-button medium="twitter">Share via Tweet</sqm-share-button>
13
15
  * @example Email Share Button - <sqm-share-button medium="email">Share via Email</sqm-share-button>
@@ -7,6 +7,7 @@ import { useShareCode } from "./useShareCode";
7
7
  import deepmerge from "deepmerge";
8
8
  /**
9
9
  * @uiName Share Code
10
+ * @exampleGroup Referrals
10
11
  * @example Share Code - <sqm-share-code tooltip-text="Copied to Clipboard" tooltip-lifespan="1000"></sqm-share-code>
11
12
  */
12
13
  export class ShareCode {
@@ -7,6 +7,7 @@ import { getProps } from "../../utils/utils";
7
7
  import deepmerge from "deepmerge";
8
8
  /**
9
9
  * @uiName Share Link
10
+ * @exampleGroup Referrals
10
11
  * @example Share Link - <sqm-share-link tooltip-text="Copied to Clipboard" tooltip-lifespan="1000"></sqm-share-link>
11
12
  */
12
13
  export class ShareLink {
@@ -5,6 +5,8 @@ import { getProps } from "../../utils/utils";
5
5
  /**
6
6
  * @uiName Stat Container
7
7
  * @slots [{"name":"","title":"Stats"}]
8
+ * @exampleGroup Statistics
9
+ * @example Container with Three Stats - <sqm-stat-container space="xxx-large" display="flex"><sqm-big-stat flex-reverse="true" alignment="left" stat-type="/rewardBalance/CREDIT/POINT/value/global">Points Balance</sqm-big-stat><sqm-big-stat flex-reverse="true" alignment="left" stat-type="/integrationRewardsCountFiltered/AVAILABLE/global">Giftcards Earned</sqm-big-stat><sqm-big-stat flex-reverse="true" alignment="left" stat-type="/referralsCount">Referrals</sqm-big-stat></sqm-stat-container>
8
10
  */
9
11
  export class StatContainer {
10
12
  constructor() {
@@ -2,7 +2,10 @@ import { Component, h, Prop } from "@stencil/core";
2
2
  import { TabView } from "./sqm-tab-view";
3
3
  /**
4
4
  * @uiName Tab
5
+ * @slots [{"name":"", "title":"Tab Content"}]
5
6
  * @validParents ["sqm-tabs"]
7
+ * @exampleGroup Layout
8
+ * @example Tab - <sqm-tab header="Example">This is an example tab. Add your own content here.</sqm-tab>
6
9
  */
7
10
  export class Tab {
8
11
  render() {
@@ -17,7 +17,8 @@ export const ManyTabs = () => (h("div", { style: { maxWidth: "700px", margin: "a
17
17
  <sqm-tabs>
18
18
  <sqm-tab header="General">This is the general tab</sqm-tab>
19
19
  <sqm-tab header="Custom">This is the custom tab</sqm-tab>
20
- <sqm-tab header="Advanced">This is the advanced tab</sqm-tab> <sqm-tab header="General">This is the general tab</sqm-tab>
20
+ <sqm-tab header="Advanced">This is the advanced tab</sqm-tab>
21
+ <sqm-tab header="General">This is the general tab</sqm-tab>
21
22
  <sqm-tab header="Custom">This is the custom tab</sqm-tab>
22
23
  <sqm-tab header="Advanced">This is the advanced tab</sqm-tab>
23
24
  <sqm-tab header="General">This is the general tab</sqm-tab>
@@ -5,6 +5,11 @@ import { TabsView } from "./sqm-tabs-view";
5
5
  import { useTabs } from "./useTabs";
6
6
  /**
7
7
  * @uiName Tab Group
8
+ * @slots [{"name":"", "title":"Tabs","validChildren":["sqm-tab"]}]
9
+ * @exampleGroup Layout
10
+ * @example Generic Tab Group - <sqm-tabs><sqm-tab header="Tab 1">This is the first tab</sqm-tab><sqm-tab header="Tab 2">This is the second tab</sqm-tab><sqm-tab header="Tab 3">This is the third tab</sqm-tab></sqm-tabs>
11
+ * @example Referral Tab Group - <sqm-tabs><sqm-tab header="Leaderboard"><sqm-leaderboard usersheading="Referrer" statsheading="Referrals" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topStartedReferrers" show-rank anonymous-user="Anonymous User"><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/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></sqm-tab><sqm-tab header="Referral history"><sqm-referral-table><sqm-referral-table-user-column column-title="User" anonymous-user="Anonymous User" deleted-user="Deleted User"></sqm-referral-table-user-column><sqm-referral-table-status-column column-title="Referral status" converted-status-text="Converted" in-progress-status-text="In Progress"></sqm-referral-table-status-column><sqm-referral-table-rewards-column column-title="Rewards" expiring-text="Expiring in" fuel-tank-text="Your code is" pending-for-text="{status} for {date}" reward-received-text="Reward received on" status-long-text="{status, select, AVAILABLE {Reward expiring on} CANCELLED {Reward cancelled on} PENDING {Available on} EXPIRED {Reward expired on} other {Not available} }" status-text="{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }"></sqm-referral-table-rewards-column><sqm-referral-table-date-column column-title="Date referred" date-shown="dateReferralStarted"></sqm-referral-table-date-column><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_referral2.png" empty-state-header="View your referral details" empty-state-text="Refer a friend to view the status of your referrals and rewards earned"></sqm-empty></sqm-referral-table></sqm-tab></sqm-tabs>
12
+ * @example Loyalty Tab Group - <sqm-tabs placement="top"> <sqm-tab header="Leaderboard"> <sqm-leaderboard usersheading="Users" statsheading="Points Earned" rankheading="Rank" rank-type="rowNumber" leaderboard-type="topPointEarners" show-rank anonymous-user="Anonymous User" > <sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644000223/squatch-assets/empty_leaderboard2.png" empty-state-header="View your rank in the leaderboard" empty-state-text="Be the first to earn points and reach the top of the leaderboard" ></sqm-empty ></sqm-leaderboard> </sqm-tab> <sqm-tab header="Reward history"> <sqm-rewards-table ><sqm-rewards-table-reward-column available-text="{availableAmount} remaining" column-title="Reward" copy-text="Copied!" redeemed-text="{redeemedAmount} redeemed" > </sqm-rewards-table-reward-column> <sqm-rewards-table-source-column anonymous-user="Anonymous User" column-title="Source" deleted-user="Deleted User" referral-text="{rewardSource, select, FRIEND_SIGNUP {Referral to} REFERRED {Referred by} other {}}" reward-exchange-text="Reward Exchange" reward-source-text="{rewardSource, select, MANUAL {Manual} AUTOMATED {{programName}} other {}}" > </sqm-rewards-table-source-column><sqm-rewards-table-status-column column-title="Status" expiry-text="Expires on " status-text="{status, select, AVAILABLE {Available} CANCELLED {Cancelled} PENDING {Pending} EXPIRED {Expired} REDEEMED {Redeemed} other {Not available} }"></sqm-rewards-table-status-column><sqm-rewards-table-date-column column-title="Date received" date-shown="dateGiven"></sqm-rewards-table-date-column><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_reward2.png" empty-state-header="View your rewards" empty-state-text="Refer friends and complete tasks to view the details of your rewards"></sqm-empty></sqm-rewards-table></sqm-tab><sqm-tab header="Redeem"><sqm-reward-exchange-list back-text="Back" button-text="Exchange Rewards" cancel-text="Cancel" choose-amount-title="Select" choose-reward-title="Rewards" confirmation-title="Confirm" continue-text="Continue" continue-to-confirmation-text="Continue to confirmation" done-text="Done" reward-title="Choose a reward" not-available-error="{unavailableReasonCode, select, US_TAX {US Tax limit} INSUFFICIENT_REDEEMABLE_CREDIT {{sourceValue} required} AVAILABILITY_PREDICATE {Not available} other {{unavailableReasonCode}} }" not-enough-error="Not enough {sourceUnit} to redeem for this reward" query-error="Unable to load reward exchange list. Please try again" redeem-text="Redeem" redeem-title="Confirm and redeem" redemption-error="An error occured trying to redeem this reward. Please try again" redemption-success-text="Redeemed {sourceValue} for {destinationValue}" select-text="Select amount to receive" source-amount-message="{ruleType, select, FIXED_GLOBAL_REWARD {{sourceValue}} other {{sourceMinValue} to {sourceMaxValue}}}" tooltiptext="Copied" reward-name-title="Reward" reward-amount-title="Reward Amount" cost-title="Cost to Redeem" reward-redeemed-text="Reward redeemed" skeleton-card-num="8" promo-code="Promo Code" tooltip-text="Copied!"><sqm-empty empty-state-image="https://res.cloudinary.com/saasquatch/image/upload/v1644360953/squatch-assets/empty_exchange2.png" empty-state-header="Redeem rewards" empty-state-text="Use your points to redeem rewards once they become available"></sqm-empty></sqm-reward-exchange-list></sqm-tab></sqm-tabs>
8
13
  */
9
14
  export class Tabs {
10
15
  constructor() {
@@ -10,6 +10,7 @@ import { useTaskCard } from "./useTaskCard";
10
10
  /**
11
11
  * @uiName Task Card
12
12
  * @uiOrder ["reward-amount", "reward-unit", "card-title", "description", "repeatable", "finite", "show-progress-bar", "stat-type", "progress-source", "goal", "steps", "progress-bar-unit", "show-expiry", "reward-duration", "button-text", "button-link", "open-new-tab", "ended-message", "expiry-message", "starts-on-message", "event-key", "*"]
13
+ * @exampleGroup Rewards
13
14
  */
14
15
  export class TaskCard {
15
16
  constructor() {
@@ -49,6 +49,13 @@ const vanillaStyle = `
49
49
  `;
50
50
  /**
51
51
  * @uiName Text
52
+ * @slots [{"name":"", "title":"Text"}]
53
+ * @exampleGroup Typography
54
+ * @example H1 - <sqm-text><h1>H1 Header Text</h1></sqm-text>
55
+ * @example H2 - <sqm-text><h2>H2 Header Text</h2></sqm-text>
56
+ * @example H3 - <sqm-text><h3>H3 Header Text</h3></sqm-text>
57
+ * @example H4 - <sqm-text><h4>H4 Header Text</h4></sqm-text>
58
+ * @example Paragraph - <sqm-text><p>Paragraph Text</p></sqm-text>
52
59
  */
53
60
  export class Text {
54
61
  constructor() {
@@ -6,6 +6,7 @@ import { TimelineEntryView } from "./sqm-timeline-entry-view";
6
6
  /**
7
7
  * @uiName Timeline Entry
8
8
  * @validParents ["sqm-timeline"]
9
+ * @exampleGroup Common Components
9
10
  * @example Timeline Entry - <sqm-timeline-entry reward="$50" unit="visa giftcard" desc="You refer a friend" icon="circle" > </sqm-timeline-entry>
10
11
  */
11
12
  export class TimelineReward {
@@ -4,6 +4,7 @@ import { useChildElements } from "../../tables/useChildElements";
4
4
  /**
5
5
  * @uiName Program Timeline
6
6
  * @slots [{"name":"","title":"Timeline","validChildren":["sqm-timeline-entry"]}]
7
+ * @exampleGroup Common Components
7
8
  * @examples Program Timeline - <sqm-timeline icon="circle"> <sqm-timeline-entry reward="$50" unit="visa giftcard" desc="You refer a friend" icon="circle" > </sqm-timeline-entry> <sqm-timeline-entry reward="$200" unit="visa giftcard" desc="Our sales team qualifies your friend as a good fit for our Enterprise plan" icon="circle" > </sqm-timeline-entry> <sqm-timeline-entry reward="$1000" unit="visa giftcard" desc="Your friend purchases an Enterprise plan" icon="circle" > </sqm-timeline-entry></sqm-timeline>
8
9
  */
9
10
  export class Timeline {
@@ -4,6 +4,8 @@ import { getProps } from "../../utils/utils";
4
4
  import { PortalSectionView } from "./sqm-portal-section-view";
5
5
  /**
6
6
  * @uiName Titled Section
7
+ * @slots [{"name":"label", "title":"Label"},{"name":"content", "title":"Content"}]
8
+ * @exampleGroup Layout
7
9
  */
8
10
  export class TitledSection {
9
11
  constructor() {
@@ -6,6 +6,8 @@ import { UserNameView } from "./sqm-user-name-view";
6
6
  import { useUserName } from "./useUserName";
7
7
  /**
8
8
  * @uiName User Name
9
+ * @exampleGroup Common Components
10
+ * @example User Name Display - <sqm-user-name fallback="Anonymous User"></sqm-user-name>
9
11
  */
10
12
  export class UserName {
11
13
  constructor() {
@@ -12368,7 +12368,8 @@ const ManyTabs = () => (h("div", { style: { maxWidth: "700px", margin: "auto" },
12368
12368
  <sqm-tabs>
12369
12369
  <sqm-tab header="General">This is the general tab</sqm-tab>
12370
12370
  <sqm-tab header="Custom">This is the custom tab</sqm-tab>
12371
- <sqm-tab header="Advanced">This is the advanced tab</sqm-tab> <sqm-tab header="General">This is the general tab</sqm-tab>
12371
+ <sqm-tab header="Advanced">This is the advanced tab</sqm-tab>
12372
+ <sqm-tab header="General">This is the general tab</sqm-tab>
12372
12373
  <sqm-tab header="Custom">This is the custom tab</sqm-tab>
12373
12374
  <sqm-tab header="Advanced">This is the advanced tab</sqm-tab>
12374
12375
  <sqm-tab header="General">This is the general tab</sqm-tab>