import { DemoData } from "../../global/demo"; import { LeaderboardViewProps } from "./sqm-leaderboard-view"; /** * @uiName Leaderboard * @validParents ["sqm-portal-container","div","sqm-hero","sqm-instant-access-registration","sqb-program-section","sqb-conditional-section"] * @slots [{"name":"empty", "title":"Empty State"}] * @requiredFeatures ["LEADERBOARDS"] * @exampleGroup Leaderboard * @example Referral Started - * @example Referral Converted - * @example Points Earned - * @example Anonymous Leaderboard -

Top Performers

The leaderboard highlights the top performers in real-time. Stay motivated, stay competitive!

* @featureTooltip
Motivate your participants by gamifying your program. Contact Support to upgrade your plan and add a leaderboard.
* @csspart sqm-base - The base container * @csspart sqm-table - The leaderboard table */ export declare class Leaderboard { /** * Filters leaderboard to show only data from this program. Defaults to the program context where this leaderboard is. * If no program ID is set or provided by context, then a global leaderboard is shown. * * @uiName Program * @uiWidget programSelector */ programId?: string; /** * @uiName User column heading */ usersheading: string; /** * @uiName Stats column heading */ statsheading: string; /** * @uiName Rank column heading */ rankheading?: string; /** * @uiName Show leaderboard rank */ showRank: boolean; /** * Restrict the width of the leaderboard (Can be a pixel value or a percentage i.e. "500px", "33%", etc.) * * @uiName Width */ width: string; /** * A JSONata string that formats the rank with the appropriate ordinal suffix (e.g., "st" for 1st, "nd" for 2nd, "rd" for 3rd, and "th" for all others). * * @uiName Rank Suffix */ rankSuffix: string; /** * @uiName Viewing user text */ viewingUserText: string; /** * Hide the Names of users to protect personal identifiable information * * @uiName Hide users names * @default */ hideNames: boolean; /** * @uiName Rank type * @uiType string * @uiEnum ["rowNumber", "rank", "denseRank"] * @uiEnumNames ["Row Number", "Rank", "Dense Rank"] */ rankType: "rowNumber" | "rank" | "denseRank"; /** * @uiName Leaderboard type * @uiType string * @required * @uiEnum ["topStartedReferrers", "topConvertedReferrers", "topPointEarners"] * @uiEnumNames ["Top Started Referrers", "Top Converted Referrers", "Top Point Earners"] */ leaderboardType: "topStartedReferrers" | "topConvertedReferrers" | "topPointEarners"; /** * Title displayed for users without names * @uiName Unknown user text */ anonymousUser: string; /** * @uiName Leaderboard time interval * @uiWidget dateRange * @uiWidgetOptions {"allowPastDates":true, "months": 1} */ interval: string; /** * Control the maximum amount of rows displayed on the leaderboard. * * @uiName Maximum rows number */ maxRows: number; /** * Hide the viewer's leaderboard row if not in the top results. * * @uiName Hide viewing user * @default */ hideViewer: boolean; /** * Changes the background color of the viewing user row in the leaderboard. * @uiName Viewing User Highlight Color * @uiWidget color * @uiGroup Style */ viewingUserHighlightColor?: string; /** * Changes the text color of the viewing user row in the leaderboard. * @uiName Viewing User Text Color * @uiWidget color * @uiGroup Style */ viewingUserHighlightTextColor?: string; /** * Changes the background color of the leaderboard. * @uiName Background Color * @uiWidget color * @uiGroup Style */ background?: string; /** * Changes the border color of the table rows. * @uiName Border Color * @uiWidget color * @uiGroup Style */ borderColor?: string; /** * Text color of the leaderboard. * @uiName Text Color * @uiWidget color * @uiGroup Style */ textColor?: string; /** * Leaderboard border radius in pixels. * @uiName Border Radius * @uiGroup Style */ borderRadius?: number; /** * @undocumented * @uiType object */ demoData?: DemoData; ignored: boolean; constructor(); disconnectedCallback(): void; render(): any; }