fansunited-widget-leaderboard

v1.18.0

Published

a month ago

Fans United management widget for leaderboards.

Downloads

188

0High
0Medium
0Low

fansunited

Leaderboard Management Widget

Welcome to Fans United Leaderboard Management Widget. The widget allows staff members with sufficient permissions to create new template leaderboard. You can use this widget as it is and embed it in your platform, or you can use the Management Panel to create template leaderboard. Leaderboards can be linked to competitions, teams, matches or markets. With successfull installiation, you can create and edit template leaderboard or see the report about specific template.

Installation and usage

The easiest way to use fansunited-widget-leaderboard is to install it from npm as follows:

npm  install  fansunited-widget-leaderboard

or:

yarn  add  fansunited-widget-leaderboard

Here is an example how you can integrate Fans United Leaderboard Management Widget:

import  'fansunited-widget-leaderboard/style.css';
import { LeaderboardManager } from  'fansunited-widget-leaderboard';

const  App = () => {
return (
<LeaderboardManager
	fansUnitedApiKey={'your-api-key'}
	fansUnitedClientId={'your-client-id'} />
);
}

Notes

The widget is bundled as a React component and its usage is as simple as the above example
Don't worry about your project's CSS. The widget's styling is done with Tailwind CSS and all classes are prefixed to avoid collisions with your existing CSS. This means that the widget's CSS will NOT affect yours. One important thing is that you need to import style.css file from package folder:

import 'fansunited-widget-leaderboard/style.css';

N.B: If you are using an entry point for importing all your stylings, you need to import fansunited-widget-leaderboard/style.css there as well

Easy translation in every language. For more information check our Translation heading.

Props

type  LeaderboardManagerProps = {
	fansUnitedApiKey: string;
	fansUnitedClientId: string;
	fansUnitedLanguage?: string;
	fansUnitedEnvironment?: string;
	sportal365Project?: string;
	sportal365Infrastructure?: 'shared' | 'betway';
	labels?: LabelsModel;
};

Fans United Leaderboard Management Widget depends on Fans United JS SDK and Fans United Client API. Thats why fansUnitedApiKey and fansUnitedClientId are required. They will be provided to you from Fans United team. For other optional props here is some information:

fansUnitedLanguage - for our sports APIs FansUnited platform supports different languages. For now they are Bulgarian (bg), English (en), Romanian (ro), Greek (el), Slovak (sk), Serbian (sr) and Hungarian (hu). If no value given it will be set to English (en).
fansUnitedEnvironment - You can run the widget in the following environments: staging, production and watg. If no value given it will be set to production (prod).
labels - you can easily translate all labels, UI messages, descriptions, placeholders and etc. with this prop. By default, Fans United Match Quiz Management Widget is available in English so if no value is given, the widget will be translated in English.
sportal365Project - The Sportal365 project. Used as a request header when communicating with Sportal365 APIs.
sportal365Infrastructure - The Sportal365 infrastructure. Used to determine what authorization should be used when communicating with Sportal365 APIs. If no value given (when sportal365Project props is provided) it will be set to shared .

Translation

You can easily translate Fans United Leaderboard Management Widget in your language! You just need to pass an object to labels prop with concrete keys and values and that's it! Here's an example how you can do it:

import  'fansunited-widget-leaderboard/style.css';
import { LeaderboardManager } from  'fansunited-widget-leaderboard';

const  labels = {
	userNotFound:  'User not found. Please try again.',
	clientConfigErrorMessage:  "There was a problem fetching client's configuration. Please check again your API key and client ID. For more information contact Fans United staff.",
	featureDisabled: "Feature disabled!",
	noPermissionMessage: "You have no permission for this feature!",
	tryAgainButton: "Try again",
	noTemplatesFound:  "No templates were found. You can create a template by clicking the button 'Create template'",
	createTemplate:  'Create template',
	signOut:  'Create template',
	name:  'Name',
	type:  'Type',
	markets: "Markets",
	fromDate:  'From Date',
	toDate:  'To Date',
	actions:  'Actions',
	primaryTemplate:  'Primary',
	customTemplate:  'Custom',
	edit:  'Edit',
	report:  'Report',
	timeFormat:  'DD-MM-YYYY',
	back:  'Back',
	id:  'ID',
	namePlaceholder:  'Please provide a name for your template leaderboard.',
	description:  'Description',
	descriptionPlaceholder:  'Please describe your template leaderboard.',
	templateDuration: "Template leaderboard duration",
	templateDurationDescription: "Users can participate in this template during given period.",
	clear: "Clear",
	clearDurationTimeMessage: "You have cleared your duration template time.",
	marketSelection:  'Market Selection',
	marketSelectionDescription: "Check what market users can predict for the specified template.",
	marketFt1x2:  'Full time',
	marketHt1x2:  'Half time',
	marketBothTeamsScore:  'Both teams score',
	marketDoubleChance:  'Double chance',
	marketHtFt:  'Half time/Full time',
	marketRedCardMatch:  'Red card in match',
	marketPenaltyMatch:  'Pentalty in match',
	marketCornersMatch:  'Corners in match',
	marketCorrectScore:  'Correct score',
	marketCorrectScoreHalfTime:  'Half time correct score',
	marketCorrectScoreAdvanced:  'Advanced correct score',
	marketPlayerScore:  'Player score',
	marketPlayerYellowCard:  'Yellow card for player',
	marketPlayerRedCard:  'Red card for player',
	marketPlayerScoreFirstGoal:  'Player to score first goal',
	marketPlayerScoreTwice:  'Player to score twice',
	marketPlayerScoreHattrick:  'Player to score hattrick',
	marketOverZeroGoals:  'Over zero and a half goals',
	marketOverOneGoals:  'Over one and a half goals',
	marketOverTwoGoals:  'Over two and a half goals',
	marketOverThreeGoals:  'Over three and a half goals',
	marketOverFourGoals:  'Over four and a half goals',
	marketOverFiveGoals:  'Over five and a half goals',
	marketOverSixGoals:  'Over six and a half goals',
	marketOverSixCorners:  'Over six and a half corners',
	marketOverSevenCorners:  'Over seven and a half corners',
	marketOverEightCorners:  'Over eight and a half corners',
	marketOverNineCorners:  'Over nine and a half corners',
	marketOverTenCorners:  'Over ten and a half corners',
	marketOverElevenCorners:  'Over eleven and a half corners',
	marketOverTwelveCorners:  'Over twelve and a half corners',
	marketOverThirteenCorners:  'Over thirteen and a half corners',
	competitionsSelection: "Competitions Selection",
	competitionsSelectionDescription: "Type the name of the competition and select one. You can add as many as you want.",
	teamsSelection: "Teams Selection",
	teamsSelectionDescription: "Type the name of the team and select one. You can add as many as you want.",
	matchesSelection: "Matches Selection",
	matchesSelectionDescription: "Type the name of the team and select one. Then there will be loaded next matches for teams.",
	selectCompetitionsNoCompetitionFound: "No competitions were found. Please try again.",
	selectCompetitionsPlaceholder: "Type the name of your competition",
	selectTeamsNoTeamFound: "No teams were found. Please try again.",
	selectTeamsNoMatchesFound: "No matches were found for these teams",
	selectTeamsPlaceholder: "Type the name of your team",
	loadingMessage: "Loading...",
	loadMore: "Load more",
	exportButton: "Export",
	rules: "Rules",
	rulesDescription: "Describe your rules for participating in template. You can type plain text or html tags.",
	adContent: 'Ad content',
	adContentDescription: 'Place your ad content in the template. It can be plain text or html tags.',
	flagsLabel: "Flags",
	flagsPlaceholder: "Type your flag and hit enter",
	repeatedValueMessage: "You have entered a repeated value. Please enter a different one.",
	images: "Images",
	mainImage: "Main",
	coverImage: "Cover",
	mobileImage: "Mobile",
	imagePlaceholder: "Paste your image as valid URL or as relative path",
	related: "Related",
	relatedDescription: "Choose which games or templates you wish to be related to this template.",
	games: "Games",
	gamesPlaceholder: "Select which games (TOP_X and MATCH_QUIZ) are related to this template",
	templates: "Templates",
	templatesPlaceholder: "Select which templates are related to this template",
	position: "Position",
	points: "Points",
	reportFor: "Report for",
	leaderboardNotAvailable: "There is no leaderboard for this template yet. Please come back later.",
	csvModalTitle: "Enter how many users should be exported",
	csvModalDescription: "Download a .csv file with the first 100 number of users.",
	csvModalPlaceholder: "Export the first X users...",
	cancel: "Cancel",
	csvModalDownloadButton: "Download as CSV file",
	csvModalValidationMessage: "Input value has to be an integer number between 1 and 100",
	csvModalErrorMessage: "There was a problem with fetching game's report data",
	leaderboardErrorMessage: "There was a problem with displaying leaderboard. Please try again.",
	getTemplatesErrorMessage: "There was a problem with fetching templates. Please try again. For more information contact Fans United staff.",
	createTemplateMessage: "You have successfully created a template.",
	editTemplateMessage: "You have successfully edited the template.",
	editTemplateErrorMessage: "There was a problem with editing the template. Please try again.",
	provideNameTemplateErrorMessage: "You need to provide a name to your template!",
	provideDurationTemplateErrorMessage: "You need to provide a duration to your template!",
	durationExceededTemplateErrorMessage: "The template duration should be no longer than a year!",
	createTemplateErrorMessage: "There was a problem with creating the template. Please try again."
	manageWinners: 'Manage winners',
	winners: 'Winners',
	title: 'Title',
	winnersDescription: 'Describe the winners...',
	winner: 'Winner',
	winnerDescription: 'Select the winner of the template',
	insertWinners: 'Insert winners',
	insertWinnersDescription: 'Type information about each winner of the template.',
	note: 'Note',
	notePlaceholder: 'Provide some note for the winner...',
	tags: 'Tags',
	tagsPlaceholder: 'Provide tags for the winner...',
	save: 'Save',
	preview: 'Preview',
	addWinner: 'Add winner',
	removeWinner: 'Remove winner',
	templateWinnersErrorMessage: 'There was a problem with fetching information about template winners. Please try again.',
	templateNoSetWinnersMessage: 'No winners are set for this template.',
	positionAndWinnerRequiredMessage: 'Position and winner are required!',
	sameChosenWinnerMessage: 'You have selected same winners. Each winner has to be unique!',
	createTemplateWinnersMessage: 'You have successfully created winners for the template.',
	createTemplateWinnersErrorMessage: 'There was a problem with creating winners for the template. Please try again.',
	editTemplateWinnersMessage: 'You have successfully edited winners for the template.',
	editTemplateWinnersErrorMessage: 'There was a problem with editing winners for the template. Please try again.',
	relatedEntitiesErrorMessage: "There was a problem with fetching entities. Please try again.",
	labelsHeading: 'Labels',
	customFields: 'Custom fields',
	dynamicFieldsDescription: 'You can create your custom records for easier way to connect your template.',
	keyDynamicFields: 'Key',
	valueDynamicFields: 'Value',
	addRecord: 'Add record',
	dynamicFieldsKeysErrorMessage: 'Only lowercase letters, numbers and underscore are accepted as keys!',
	templateByIdErrorMessage: 'There was a problem retrieving full information about the template.',
	uploadingImageMessage: 'You have successfully uploaded image',
	generateSignedInUrlErrorMessage: 'There was a problem generating signed in URL to store the image in bucket. Please try again',
	uploadingImageErrorMessage: 'There was a problem with uploading image to bucket. Please try again',
	encryptingImageErrorMessage: 'There was a problem with encrypting image before uploading it to bucket. Please try again',
	searchSportal365ImagesErrorMessage: 'There was a problem with searching images from Sportal 365 API. Please try again'
	searchImage: 'Search image',
	clearFromToFilterSportal365ImagesMessage: 'You have cleared from/to filter for Sportal365 search images',
	hideFilters: 'Hide filters',
	showFilters: 'Show filters',
	dateFromTo: 'Date from/to',
	dateFromToPlaceholder: 'Select Date...'
};

const  App = () => {
return (
<LeaderboardManager
	fansUnitedApiKey={'your-api-key'}
	fansUnitedClientId={'your-client-id'}
	labels={labels}/>
);
}

Here is all information about LabelsModel:

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Leaderboard Management Widget

Installation and usage

Notes

Props

Translation