@saasquatch/mint-components 1.5.6-4 → 1.5.6-7

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 (42) hide show
  1. package/dist/collection/components/sqm-big-stat/sqm-big-stat.js +1 -0
  2. package/dist/collection/components/sqm-empty/sqm-empty.js +1 -1
  3. package/dist/collection/components/sqm-leaderboard/sqm-leaderboard.js +1 -1
  4. package/dist/collection/components/sqm-program-explainer/sqm-program-explainer.js +2 -2
  5. package/dist/collection/components/sqm-referral-card/sqm-referral-card.js +1 -1
  6. package/dist/collection/components/sqm-referral-table/sqm-referral-table.js +2 -1
  7. package/dist/collection/components/sqm-reward-exchange-list/sqm-reward-exchange-list.js +1 -1
  8. package/dist/collection/components/sqm-rewards-table/sqm-rewards-table.js +2 -1
  9. package/dist/collection/components/sqm-scroll/sqm-scroll.js +3 -2
  10. package/dist/collection/components/sqm-share-button/sqm-share-button.js +2 -1
  11. package/dist/collection/components/sqm-share-code/sqm-share-code.js +1 -0
  12. package/dist/collection/components/sqm-share-link/sqm-share-link.js +1 -0
  13. package/dist/collection/components/sqm-stat-container/sqm-stat-container.js +1 -1
  14. package/dist/collection/components/sqm-tab/sqm-tab.js +1 -1
  15. package/dist/collection/components/sqm-tabs/sqm-tabs.js +1 -1
  16. package/dist/collection/components/sqm-text/sqm-text.js +8 -0
  17. package/dist/collection/components/sqm-timeline/sqm-timeline.js +1 -1
  18. package/dist/collection/components/sqm-titled-section/sqm-titled-section.js +1 -1
  19. package/dist/collection/components/sqm-user-name/sqm-user-name.js +1 -0
  20. package/dist/types/components/sqm-big-stat/sqm-big-stat.d.ts +1 -0
  21. package/dist/types/components/sqm-empty/sqm-empty.d.ts +1 -1
  22. package/dist/types/components/sqm-leaderboard/sqm-leaderboard.d.ts +1 -1
  23. package/dist/types/components/sqm-program-explainer/sqm-program-explainer.d.ts +2 -2
  24. package/dist/types/components/sqm-referral-card/sqm-referral-card.d.ts +1 -1
  25. package/dist/types/components/sqm-referral-table/sqm-referral-table.d.ts +2 -1
  26. package/dist/types/components/sqm-reward-exchange-list/sqm-reward-exchange-list.d.ts +1 -1
  27. package/dist/types/components/sqm-rewards-table/sqm-rewards-table.d.ts +2 -1
  28. package/dist/types/components/sqm-scroll/sqm-scroll.d.ts +3 -2
  29. package/dist/types/components/sqm-share-button/sqm-share-button.d.ts +2 -1
  30. package/dist/types/components/sqm-share-code/sqm-share-code.d.ts +1 -0
  31. package/dist/types/components/sqm-share-link/sqm-share-link.d.ts +1 -0
  32. package/dist/types/components/sqm-stat-container/sqm-stat-container.d.ts +1 -1
  33. package/dist/types/components/sqm-tab/sqm-tab.d.ts +1 -1
  34. package/dist/types/components/sqm-tabs/sqm-tabs.d.ts +1 -1
  35. package/dist/types/components/sqm-text/sqm-text.d.ts +8 -0
  36. package/dist/types/components/sqm-timeline/sqm-timeline.d.ts +1 -1
  37. package/dist/types/components/sqm-titled-section/sqm-titled-section.d.ts +1 -1
  38. package/dist/types/components/sqm-user-name/sqm-user-name.d.ts +1 -0
  39. package/docs/docs.docx +0 -0
  40. package/docs/raisins.json +1 -1
  41. package/grapesjs/grapesjs.js +1 -1
  42. package/package.json +3 -3
@@ -8,6 +8,7 @@ import { isDemo, useHost } from "@saasquatch/component-boilerplate";
8
8
  *
9
9
  * @uiName Big Stat
10
10
  * @slots [{"name":"","title":"Stat Text"}]
11
+ * @slotEditor richText
11
12
  * @exampleGroup Statistics
12
13
  * @example Points Balance - <sqm-big-stat flex-reverse="true" alignment="left" stat-type="/rewardBalance/CREDIT/POINT/value/global">Points Balance</sqm-big-stat>
13
14
  * @example GiftCards Earned - <sqm-big-stat flex-reverse="true" alignment="left" stat-type="/integrationRewardsCountFiltered/AVAILABLE/global">Giftcards Earned</sqm-big-stat>
@@ -2,7 +2,7 @@ import { Component, h, Host, Prop } from "@stencil/core";
2
2
  import { EmptyStateView } from "./sqm-empty-view";
3
3
  /**
4
4
  * @uiName Empty State Content
5
- * @validParents ["sqm-referral-table","sqm-rewards-table","sqm-leaderboard", "sqm-reward-exchange-list"]
5
+ * @validParents ["sqm-referral-table","sqm-rewards-table","sqm-leaderboard","sqm-reward-exchange-list"]
6
6
  */
7
7
  export class HeroImage {
8
8
  render() {
@@ -7,7 +7,7 @@ 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"}]
10
+ * @slots [{"name":"empty", "title":"Empty State"}]
11
11
  * @exampleGroup Leaderboards
12
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>
13
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>
@@ -5,8 +5,8 @@ import { ProgramExplainerView } from "./sqm-program-explainer-view";
5
5
  /**
6
6
  * @uiName Program Explainer
7
7
  * @exampleGroup Common Components
8
- * @slot [{"name":"", title":"Explainer", "validChildren":["sqm-program-explainer-step"]}]
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
+ * @slots [{"name":"", "title":"Explainer", "validChildren":["sqm-program-explainer-step"]}]
9
+ * @example 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>
10
10
  */
11
11
  export class ProgramExplainer {
12
12
  constructor() {
@@ -5,7 +5,7 @@ import { ReferralCardView } from "./sqm-referral-card-view";
5
5
  /**
6
6
  * @uiName Referral Card
7
7
  * @exampleGroup Referrals
8
- * @slots [{"name":"left","title":"Left Content"},{"name":"right","title":"Right Content"}]
8
+ * @slots [{"name":"left", "title":"Left Content"},{"name":"right", "title":"Right Content"}]
9
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>
10
10
  */
11
11
  export class ReferralCard {
@@ -11,7 +11,8 @@ import { tryMethod, useReferralTable } from "./useReferralTable";
11
11
  /**
12
12
  * @uiName Referral Table
13
13
  * @exampleGroup Referrals
14
- * @slot [{"name":"", "title":"Table Row"}]
14
+ * Dont forget about loading and empty slots
15
+ * @slots [{"name":"", "title":"Table Row"}]
15
16
  */
16
17
  export class ReferralTable {
17
18
  constructor() {
@@ -8,7 +8,7 @@ import { getProps } from "../../utils/utils";
8
8
  import { demoRewardExchange } from "./RewardExchangeListData";
9
9
  /**
10
10
  * @uiName Reward Exchange
11
- * @slot [{"name":"empty", title":"Empty State"}]
11
+ * @slots [{"name":"empty", "title":"Empty State"}]
12
12
  * @exampleGroup Rewards
13
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>
14
14
  */
@@ -11,7 +11,8 @@ import { tryMethod, useRewardsTable } from "./useRewardsTable";
11
11
  /**
12
12
  * @uiName Reward Table
13
13
  * @exampleGroup Rewards
14
- * @slot [{"name":"", "title":"Table Row"}]
14
+ * Dont forget about loading and empty slots
15
+ * @slots [{"name":"", "title":"Table Row"}]
15
16
  */
16
17
  export class RewardsTable {
17
18
  constructor() {
@@ -3,9 +3,10 @@ import { Component, h, Prop, State } from "@stencil/core";
3
3
  import { useScroll } from "./useScroll";
4
4
  import { createStyleSheet } from "../../styling/JSS";
5
5
  /**
6
- * @uiName Scroll
6
+ * @uiName Scroll Button
7
7
  * @exampleGroup Common Components
8
- * @slot [{"name":"", "title":"Button Content"}]
8
+ * @slots [{"name":"", "title":"Button Content"}]
9
+ * @slotEditor richText
9
10
  */
10
11
  export class Scroll {
11
12
  constructor() {
@@ -7,7 +7,8 @@ import { getProps } from "../../utils/utils";
7
7
  import deepmerge from "deepmerge";
8
8
  /**
9
9
  * @uiName Share Button
10
- * @slot [{"name":"", "title":"Button Content"}]
10
+ * @slots [{"name":"", "title":"Button Content"}]
11
+ * @slotEditor richText
11
12
  * @uiOrder ["medium", "program-id", "*", "pill", "disabled", "hideicon"]
12
13
  * @exampleGroup Sharing
13
14
  * @example Facebook Share Button - <sqm-share-button medium="facebook">Share on Facebook</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 {
@@ -4,7 +4,7 @@ import { StatContainerView } from "./sqm-stat-container-view";
4
4
  import { getProps } from "../../utils/utils";
5
5
  /**
6
6
  * @uiName Stat Container
7
- * @slots [{"name":"","title":"Stats"}]
7
+ * @slots [{"name":"", "title":"Stats"}]
8
8
  * @exampleGroup Statistics
9
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>
10
10
  */
@@ -2,7 +2,7 @@ import { Component, h, Prop } from "@stencil/core";
2
2
  import { TabView } from "./sqm-tab-view";
3
3
  /**
4
4
  * @uiName Tab
5
- * @slot [{"name":"", "title":"Tab Content"}]
5
+ * @slots [{"name":"", "title":"Tab Content"}]
6
6
  * @validParents ["sqm-tabs"]
7
7
  * @exampleGroup Layout
8
8
  * @example Tab - <sqm-tab header="Example">This is an example tab. Add your own content here.</sqm-tab>
@@ -5,7 +5,7 @@ import { TabsView } from "./sqm-tabs-view";
5
5
  import { useTabs } from "./useTabs";
6
6
  /**
7
7
  * @uiName Tab Group
8
- * @slot [{"name":"", "title":"Tabs","validChildren":["sqm-tab"]}]
8
+ * @slots [{"name":"", "title":"Tabs","validChildren":["sqm-tab"]}]
9
9
  * @exampleGroup Layout
10
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
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>
@@ -49,6 +49,14 @@ const vanillaStyle = `
49
49
  `;
50
50
  /**
51
51
  * @uiName Text
52
+ * @slots [{"name":"", "title":"Text"}]
53
+ * @slotEditor richText
54
+ * @exampleGroup Typography
55
+ * @example H1 - <sqm-text><h1>H1 Header Text</h1></sqm-text>
56
+ * @example H2 - <sqm-text><h2>H2 Header Text</h2></sqm-text>
57
+ * @example H3 - <sqm-text><h3>H3 Header Text</h3></sqm-text>
58
+ * @example H4 - <sqm-text><h4>H4 Header Text</h4></sqm-text>
59
+ * @example Paragraph - <sqm-text><p>Paragraph Text</p></sqm-text>
52
60
  */
53
61
  export class Text {
54
62
  constructor() {
@@ -5,7 +5,7 @@ import { useChildElements } from "../../tables/useChildElements";
5
5
  * @uiName Program Timeline
6
6
  * @slots [{"name":"","title":"Timeline","validChildren":["sqm-timeline-entry"]}]
7
7
  * @exampleGroup Common Components
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
+ * @example 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>
9
9
  */
10
10
  export class Timeline {
11
11
  constructor() {
@@ -4,7 +4,7 @@ import { getProps } from "../../utils/utils";
4
4
  import { PortalSectionView } from "./sqm-portal-section-view";
5
5
  /**
6
6
  * @uiName Titled Section
7
- * @slot [{"name":"label", title":"Label"},{"name":"content", "title":"Content"}]
7
+ * @slots [{"name":"label", "title":"Label"},{"name":"content", "title":"Content"}]
8
8
  * @exampleGroup Layout
9
9
  */
10
10
  export class TitledSection {
@@ -6,6 +6,7 @@ import { UserNameView } from "./sqm-user-name-view";
6
6
  import { useUserName } from "./useUserName";
7
7
  /**
8
8
  * @uiName User Name
9
+ * @exampleGroup Common Components
9
10
  * @example User Name Display - <sqm-user-name fallback="Anonymous User"></sqm-user-name>
10
11
  */
11
12
  export class UserName {
@@ -4,6 +4,7 @@ import { DemoData } from "../../global/demo";
4
4
  *
5
5
  * @uiName Big Stat
6
6
  * @slots [{"name":"","title":"Stat Text"}]
7
+ * @slotEditor richText
7
8
  * @exampleGroup Statistics
8
9
  * @example Points Balance - <sqm-big-stat flex-reverse="true" alignment="left" stat-type="/rewardBalance/CREDIT/POINT/value/global">Points Balance</sqm-big-stat>
9
10
  * @example GiftCards Earned - <sqm-big-stat flex-reverse="true" alignment="left" stat-type="/integrationRewardsCountFiltered/AVAILABLE/global">Giftcards Earned</sqm-big-stat>
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * @uiName Empty State Content
3
- * @validParents ["sqm-referral-table","sqm-rewards-table","sqm-leaderboard", "sqm-reward-exchange-list"]
3
+ * @validParents ["sqm-referral-table","sqm-rewards-table","sqm-leaderboard","sqm-reward-exchange-list"]
4
4
  */
5
5
  export declare class HeroImage {
6
6
  /**
@@ -2,7 +2,7 @@ import { DemoData } from "../../global/demo";
2
2
  import { LeaderboardViewProps } from "./sqm-leaderboard-view";
3
3
  /**
4
4
  * @uiName Leaderboard
5
- * @slot [{"name":"empty", title":"Empty State"}]
5
+ * @slots [{"name":"empty", "title":"Empty State"}]
6
6
  * @exampleGroup Leaderboards
7
7
  * @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>
8
8
  * @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>
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * @uiName Program Explainer
3
3
  * @exampleGroup Common Components
4
- * @slot [{"name":"", title":"Explainer", "validChildren":["sqm-program-explainer-step"]}]
5
- * @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>
4
+ * @slots [{"name":"", "title":"Explainer", "validChildren":["sqm-program-explainer-step"]}]
5
+ * @example 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>
6
6
  */
7
7
  export declare class ProgramExplainer {
8
8
  ignored: boolean;
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * @uiName Referral Card
3
3
  * @exampleGroup Referrals
4
- * @slots [{"name":"left","title":"Left Content"},{"name":"right","title":"Right Content"}]
4
+ * @slots [{"name":"left", "title":"Left Content"},{"name":"right", "title":"Right Content"}]
5
5
  * @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>
6
6
  */
7
7
  export declare class ReferralCard {
@@ -3,7 +3,8 @@ import { GenericTableViewProps } from "../../tables/GenericTableView";
3
3
  /**
4
4
  * @uiName Referral Table
5
5
  * @exampleGroup Referrals
6
- * @slot [{"name":"", "title":"Table Row"}]
6
+ * Dont forget about loading and empty slots
7
+ * @slots [{"name":"", "title":"Table Row"}]
7
8
  */
8
9
  export declare class ReferralTable {
9
10
  /**
@@ -2,7 +2,7 @@ import { RewardExchangeViewProps } from "./sqm-reward-exchange-list-view";
2
2
  import { DemoData } from "../../global/demo";
3
3
  /**
4
4
  * @uiName Reward Exchange
5
- * @slot [{"name":"empty", title":"Empty State"}]
5
+ * @slots [{"name":"empty", "title":"Empty State"}]
6
6
  * @exampleGroup Rewards
7
7
  * @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>
8
8
  */
@@ -3,7 +3,8 @@ import { GenericTableViewProps } from "../../tables/GenericTableView";
3
3
  /**
4
4
  * @uiName Reward Table
5
5
  * @exampleGroup Rewards
6
- * @slot [{"name":"", "title":"Table Row"}]
6
+ * Dont forget about loading and empty slots
7
+ * @slots [{"name":"", "title":"Table Row"}]
7
8
  */
8
9
  export declare class RewardsTable {
9
10
  /**
@@ -1,7 +1,8 @@
1
1
  /**
2
- * @uiName Scroll
2
+ * @uiName Scroll Button
3
3
  * @exampleGroup Common Components
4
- * @slot [{"name":"", "title":"Button Content"}]
4
+ * @slots [{"name":"", "title":"Button Content"}]
5
+ * @slotEditor richText
5
6
  */
6
7
  export declare class Scroll {
7
8
  ignored: boolean;
@@ -2,7 +2,8 @@ import { ShareButtonViewProps } from "./sqm-share-button-view";
2
2
  import { DemoData } from "../../global/demo";
3
3
  /**
4
4
  * @uiName Share Button
5
- * @slot [{"name":"", "title":"Button Content"}]
5
+ * @slots [{"name":"", "title":"Button Content"}]
6
+ * @slotEditor richText
6
7
  * @uiOrder ["medium", "program-id", "*", "pill", "disabled", "hideicon"]
7
8
  * @exampleGroup Sharing
8
9
  * @example Facebook Share Button - <sqm-share-button medium="facebook">Share on Facebook</sqm-share-button>
@@ -2,6 +2,7 @@ import { ShareLinkViewProps } from "../sqm-share-link/sqm-share-link-view";
2
2
  import { DemoData } from "../../global/demo";
3
3
  /**
4
4
  * @uiName Share Code
5
+ * @exampleGroup Referrals
5
6
  * @example Share Code - <sqm-share-code tooltip-text="Copied to Clipboard" tooltip-lifespan="1000"></sqm-share-code>
6
7
  */
7
8
  export declare class ShareCode {
@@ -2,6 +2,7 @@ import { ShareLinkViewProps } from "./sqm-share-link-view";
2
2
  import { DemoData } from "../../global/demo";
3
3
  /**
4
4
  * @uiName Share Link
5
+ * @exampleGroup Referrals
5
6
  * @example Share Link - <sqm-share-link tooltip-text="Copied to Clipboard" tooltip-lifespan="1000"></sqm-share-link>
6
7
  */
7
8
  export declare class ShareLink {
@@ -1,7 +1,7 @@
1
1
  import { Spacing } from "../../global/mixins";
2
2
  /**
3
3
  * @uiName Stat Container
4
- * @slots [{"name":"","title":"Stats"}]
4
+ * @slots [{"name":"", "title":"Stats"}]
5
5
  * @exampleGroup Statistics
6
6
  * @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>
7
7
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * @uiName Tab
3
- * @slot [{"name":"", "title":"Tab Content"}]
3
+ * @slots [{"name":"", "title":"Tab Content"}]
4
4
  * @validParents ["sqm-tabs"]
5
5
  * @exampleGroup Layout
6
6
  * @example Tab - <sqm-tab header="Example">This is an example tab. Add your own content here.</sqm-tab>
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * @uiName Tab Group
3
- * @slot [{"name":"", "title":"Tabs","validChildren":["sqm-tab"]}]
3
+ * @slots [{"name":"", "title":"Tabs","validChildren":["sqm-tab"]}]
4
4
  * @exampleGroup Layout
5
5
  * @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>
6
6
  * @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>
@@ -1,5 +1,13 @@
1
1
  /**
2
2
  * @uiName Text
3
+ * @slots [{"name":"", "title":"Text"}]
4
+ * @slotEditor richText
5
+ * @exampleGroup Typography
6
+ * @example H1 - <sqm-text><h1>H1 Header Text</h1></sqm-text>
7
+ * @example H2 - <sqm-text><h2>H2 Header Text</h2></sqm-text>
8
+ * @example H3 - <sqm-text><h3>H3 Header Text</h3></sqm-text>
9
+ * @example H4 - <sqm-text><h4>H4 Header Text</h4></sqm-text>
10
+ * @example Paragraph - <sqm-text><p>Paragraph Text</p></sqm-text>
3
11
  */
4
12
  export declare class Text {
5
13
  ignored: boolean;
@@ -2,7 +2,7 @@
2
2
  * @uiName Program Timeline
3
3
  * @slots [{"name":"","title":"Timeline","validChildren":["sqm-timeline-entry"]}]
4
4
  * @exampleGroup Common Components
5
- * @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>
5
+ * @example 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>
6
6
  */
7
7
  export declare class Timeline {
8
8
  ignored: boolean;
@@ -1,7 +1,7 @@
1
1
  import { Spacing } from "../../global/mixins";
2
2
  /**
3
3
  * @uiName Titled Section
4
- * @slot [{"name":"label", title":"Label"},{"name":"content", "title":"Content"}]
4
+ * @slots [{"name":"label", "title":"Label"},{"name":"content", "title":"Content"}]
5
5
  * @exampleGroup Layout
6
6
  */
7
7
  export declare class TitledSection {
@@ -2,6 +2,7 @@ import { DemoData } from "../../global/demo";
2
2
  import { UserNameViewProps } from "./sqm-user-name-view";
3
3
  /**
4
4
  * @uiName User Name
5
+ * @exampleGroup Common Components
5
6
  * @example User Name Display - <sqm-user-name fallback="Anonymous User"></sqm-user-name>
6
7
  */
7
8
  export declare class UserName {
package/docs/docs.docx CHANGED
Binary file