fansunited-widget-match-quiz v2.0.0

Match Quiz Management Widget

Welcome to Fans United Match Quiz Management Widget. The widget allows staff members with sufficient permissions to create new Match Quiz games/editions. You can use this widget as it is and embed it in your platform, or you can use the Management Panel to create games. Match Quiz is a game where users must predict a specified number of fixtures for one match for a prize. With successful installation, you can create and edit a Match Quiz game or see the report about specific game.

Installation and usage

The easiest way to use Fans United Match Quiz Widget is to install it from npm as follows:

npm  install  fansunited-widget-match-quiz

or:

yarn  add  fansunited-widget-match-quiz

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

import  'fansunited-widget-match-quiz/style.css';
import { MatchQuizManager } from  'fansunited-widget-match-quiz';

const  App = () => {

return <MatchQuizManager 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-match-quiz/style.css';

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

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

Props

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

Fans United Match Quiz 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 Match Quiz 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-match-quiz/style.css';
import { MatchQuizManager } from  'fansunited-widget-match-quiz';

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',
	noGamesFound: "No games were found. You can create a game by clicking the button 'Create game'",
	signOut:  'Sign out',
	name: 'Name',
	status: 'Status',
	participants: 'Participants',
	acceptUntil: 'Accept Until',
	actions: 'Actions',
	pending: 'Pending',
	settled: 'Settled',
	live: 'Live',
	open: 'Open',
	canceled: 'Canceled',
	closed: 'Closed',
	edit: 'Edit',
	timeFormat: 'DD-MM-YYYY HH:mm',
	previous: 'Previous',
	next: 'Next',
	id: 'ID',
	description: 'Description',
	matchSelection: 'Match selection',
	matchSelectionDescription: 'Search for a match by competitions or teams. When you choose a match the defaults market will be displayed.',
	marketSelection: 'Market Selection',
	chosenMarkets: 'Chosen markets',
	otherMarkets: 'Other markets',
	marketSelectionCreateGameDescription: 'Drag and drop what market users can predict for the specified match. The default markets are automatically dropped in chosen markets.',
	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',
	marketPlayerScoreFirstGoal: 'Player to score first goal',
	marketOverZeroGoals: 'Over zero goals',
	marketOverOneGoals: 'Over one goals',
	marketOverTwoGoals: 'Over two goals',
	marketOverThreeGoals: 'Over three goals',
	marketOverFourGoals: 'Over four goals',
	marketOverFiveGoals: 'Over five goals',
	marketOverSixGoals: 'Over six goals',
	marketOverSixCorners: 'Over six corners',
	marketOverSevenCorners: 'Over seven corners',
	marketOverEightCorners: 'Over eight corners',
	marketOverNineCorners: 'Over nine corners',
	marketOverTenCorners: 'Over ten corners',
	marketOverElevenCorners: 'Over eleven corners',
	marketOverTwelveCorners: 'Over twelve corners',
	marketOverThirteenCorners: 'Over thirteen corners',
	gameStatus: 'Game status',
	timeTiebreaker: 'Time tiebreaker',
	timeTiebreakerDescription: `When enabled the game's leaderboard will have a classic user ranking (1,2,3). In case of same points, the user who placed their predictions eariler will be infront. When disabled the current game's leaderboard behavour is used - when 2 or more people have same points, the ranking will be 1,1,3,4,5,5,7,8.`,
	rules: 'Rules',
	adContent: 'Ad content',
	adContentDescription: 'Place your ad content in the game. It can be plain text or html tags.',
	flags: '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',
	related: 'Related',
	games: 'Games',
	templates: 'Templates',
	cutoffTime: 'Cutoff time',
	createCutoffTimeDescription: 'Predictions will be accepted until this time. If not provided it will be automatically generated 15 minutes from the first match played.',
	editCutoffTimeDescription: "Predictions will be accepted until this time. You need to provide a cutoff time to be able to edit the game. Keep in mind that cutoff time should be ATLEAST 15 minutes before match's kickoff time.",
	back: 'Back',
	loadMore: 'Load more',
	exportButton: 'Export',
	position: 'Position',
	points: 'Points',
	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...',
	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",
	createGameMessage: 'You have successfully created a game.',
	editGameMessage: 'You have successfully edited a game.',
	createGameErrorMessage:  'There was a problem with creating the game. Please try again.',
	editGameErrorMessage:  'There was a problem with editing the game. Please try again.',
	leaderboardErrorMessage:  'There was a problem with displaying leaderboard. Please try again.',
	manageWinners: 'Manage winners',
	title: 'Title',
	winnersDescription: 'Describe the winners...',
	note: 'Note',
	tags: 'Tags',
	tagsPlaceholder: 'Provide tags for the winner...',
	save: 'Save',
	preview: 'Preview',
	positionAndWinnerRequiredMessage: 'Position and winner are required!',
	sameChosenWinnerMessage: 'You have selected same winners. Each winner has to be unique!',
	relatedEntitiesErrorMessage: 'There was a problem with fetching entities. Please try again.',
	labelsHeading: 'Labels',
	customFields: 'Custom fields',
	keyDynamicFields: 'Key',
	valueDynamicFields: 'Value',
	gameByIdErrorMessage: 'There was a problem retrieving full information about the game.',
	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',
	hideFilters: 'Hide filters',
	showFilters: 'Show filters',
	exportAllUsers: 'Export all users',
	usersExportMessage: 'All users have been exported successfully',
	usersExportErrorMessage: 'There was a problem with exporting users. Please try again',
	marketCorrectScoreHalfTime: 'Correct score at half-time',
	marketCorrectScoreAdvanced: 'Advanced correct score',
	schedule: 'Schedule',
	scheduledTaskNotAvailable: 'To configure scheduled tasks you need to first create your game',
	createScheduledTaskMessage: 'You have successfully created scheduled task',
	createScheduledTaskErrorMessage: 'An error occurred while creating scheduled task. Please try again later',
	updateScheduledTaskMessage: 'You have successfully updated scheduled task',
	updateScheduledTaskErrorMessage: 'An error occurred while updating scheduled task. Please try again later',
	deleteScheduledTaskMessage: 'You have successfully deleted scheduled task',
	deleteScheduledTaskErrorMessage: 'An error occurred while deleting scheduled task. Please try again later',
	changeStatusTo: 'Change status to:',
	at: 'At:',
	deleteScheduledTaskModalTitle: 'Delete scheduled task',
	deleteScheduledTaskModalParagraph: 'Are you sure you want to delete the following scheduled task: ',
	delete: 'Delete',
	close: 'Close',
	configuration: 'Configuration',
	branding: 'Branding',
	urls: 'URLs',
	primaryUrl: 'Primary URL',
	secondaryUrl: 'Secondary URL',
	privacyPolicyUrl: 'Privacy Policy URL',
	termsAndConditionsUrl: 'Terms and Conditions URL',
	additionalUrl: 'Additional URL',
	colors: 'Colors',
	primaryColor: 'Primary Color',
	secondaryColor: 'Secondary Color',
	contentColor: 'Content Color',
	backgroundColor: 'Background Color',
	borderColor: 'Border Color',
	additionalColor: 'Additional Color',
	mainLogo: 'Main Logo',
	mobileLogo: 'Mobile Logo',
	backgroundImage: 'Background Image',
	mobileBackgroundImage: 'Mobile Background Image',
	additionalImage: 'Additional Image',
	hideMoreImages: 'Hide more images',
	showMoreImages: 'Show more images',
	uploadImage: 'Upload Image',
	sportal365Images: 'Sportal365 Images',
	create: 'Create',
	createdAt: 'Created at',
	additionalInformation: 'Additional information',
	sortOrder: 'Sort order',
  ascending: 'Ascending',
  descending: 'Descending',
	itemsPerPage: 'Items per page',
	clone: 'Clone',
	pageNo: 'Page No',
	winnersErrorMessage: 'There was a problem with fetching information about game winners. Please try again.',
	createWinnersMessage: 'You have successfully created winners for the game.',
	createWinnersErrorMessage: 'There was a problem with creating winners for the game. Please try again.',
	editWinnersMessage: 'You have successfully edited winners for the game.',
	editWinnersErrorMessage: 'There was a problem with editing winners for the game. Please try again.',
	configureWinners: 'Configure Winners',
	noStandingsAvailable: 'No standings available',
	predictions: 'Predictions',
	nicknameAndName: 'Nickname & Name',
	clearWinner: 'Clear winner',
	search: 'Search',
	clearImage: 'Clear image',
	copyUrl: 'Copy URL',
	viewImage: 'View image',
	cropImage: 'Crop image',
	aspectRatio: 'Aspect ratio',
	crop: 'Crop',
	reset: 'Reset',
	urlCopiedToClipboardMessage: 'URL copied to clipboard',
	imageDeletedMessage: 'Image deleted',
	imageResetMessage: 'The initial size of the image has been restored',
	fromDate: 'From Date',
	toDate: 'To Date',
	manageGameTitle: 'Manage Match Quiz',
	manageGameDescription: 'Manage your Match Quiz game here',
	cloneGameTitle: 'Clone Match Quiz game',
	provideTitleGameErrorMessage: 'You need to provide a title to your game!',
	filters: 'Filters',
	competitionsSelectionPlaceholder: 'Search for competitions by their name',
	teamsSelectionPlaceholder: 'Search for teams by their name',
	searchCompetitionsErrorMessage: 'There was a problem searching for competitions',
	searchTeamsErrorMessage: 'There was a problem searching for teams',
	searchMatches: 'Search matches',
	getMatchesErrorMessage: 'An error occurred while fetching the matches. Please try again.',
	gameParticipationsReportErrorMessage: 'There was a problem with fetching information about game participation. Please try again',
	reports: 'Reports',
	performanceByDay: 'Performance by day',
	participations: 'Participations',
	standings: 'Standings',
	noProfileInformationAvailableMessage: 'There is no profile information available',
	showDetails: 'Show details',
	noMatchesFound: 'No matches are found for the provided filters',
	sortingFilterTooltip: 'Sort by earliest match kickoff time. Descending order shows games with the latest kickoffs first (newest to oldest). Ascending order shows games with the earliest kickoffs first (oldest to newest).',
	noSetWinnersMessage: 'No winners are set for this game.',
	getGamesErrorMessage: 'There was a problem retrieving information about the games.',
	titleRequiredFieldValidationMessage: 'Title field is required!',
	fixturesRequiredValidationMessage: 'You need to provide at least one fixture',
	selectedMatch: 'Selected match',
	usersLeadsExportMessage: 'All users leads have been exported successfully',
	usersLeadsExportErrorMessage: 'There was a problem with exporting all users leads. Please try again',
	exportAllUsersLeads: 'Export all users leads',
	notVerified: 'Not verified',
	updatedAt: 'Updated at',
	userGamePredictionErrorMessage: "There was a problem with fetching user's game prediction. Please try again",
	predictionBy: 'Prediction by',
	noPredictionAvailable: 'No prediction available',
	market: 'Market',
	correct: 'Correct',
	partiallyCorrect: 'Partially correct',
	incorrect: 'Incorrect',
	void: 'Void',
	match: 'Match',
	outcome: 'Outcome',
	settledAt: 'Settled at',
	resettledAt: 'Resettled at',
	dates: 'Dates',
	prediction: 'Prediction',
	type: 'Type',
	entity: 'Entity',
	relationship: 'Relationship',
	dynamicFieldsKeysValidationMessage: 'Only lowercase letters, numbers and underscore are accepted as keys!',
	scheduledTaskInOpenGameNotAvailable: `This game is already in 'Open' status. Scheduling is only available for games that need to be opened at a future time. Since this game is currently open, no additional scheduling is available.`,
	noDataAvailable: 'No data available to display'
};

const  App = () => {

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

Here is all information about LabelsModel: