fansunited-widget-classic-quiz

v2.4.0

Published

4 days ago

Downloads

470

0High
0Medium
0Low

fansunited

Classic Quiz Management Widget

Welcome to Fans United Classic Quiz Management Widget. The widget allows staff members with sufficient permissions to create new Classic Quizzes. You can use this widget as it is and embed it in your platform, or you can use the Management Panel to create Classic Quizzes. Classic Quiz is a mini-game where users must answer to questions. With successful installation, you can create, edit and delete a Classic Quiz mini-game.

Installation and usage

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

npm  install  fansunited-widget-classic-quiz

or:

yarn  add  fansunited-widget-classic-quiz

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

import  'fansunited-widget-classic-quiz/style.css';
import { ClassicQuizManager } from  'fansunited-widget-classic-quiz';

const  App = () => {
return (
<ClassicQuizManager
	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 Joy UI which is based on headless unstyle react components. 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-classic-quiz/style.css';

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

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

Props

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

Fans United Classic 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 .
hideSignOutButton - By default on the top right corner of the widget will be displayed a sign out button. To hide that button set this prop to true.

Translation

You can easily translate Fans United Classic 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-classic-quiz/style.css';
import { ClassicQuizManager } from  'fansunited-widget-classic-quiz';

const labels = {
	userNotFound: 'User not found. Please try again',
	clientFeaturesNotFoundMessage: "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',
	additionalInformation: 'Additional information',
	pageNo: 'Page No',
	deleteMiniGameTitle: 'Delete Classic Quiz',
	deleteMiniGameDescription: 'Are you sure you want to delete',
	cloneMiniGameTitle: 'Clone Classic Quiz',
	back: 'Back',
	manageMiniGameTitle: 'Manage Classic Quiz',
	manageMiniGameDescription: 'Manage your Classic Quiz here',
	schedule: 'Schedule',
	scheduledTaskNotAvailable: 'To configure scheduled tasks you need to first create your classic quiz',
	changeStatusTo: 'Change status to:',
    at: 'At:',
    deleteScheduledTaskModalTitle: 'Delete scheduled task',
    deleteScheduledTaskModalParagraph: 'Are you sure you want to delete the following scheduled task: ',
	points: 'Points',
	pointsDescription: 'Set the number of points awarded for each correct answer. Points will be added to the user’s profile.',
	maxAttempts: 'Max Attempts',
	maxAttemptsDescription: 'Define how many times a user can attempt the quiz. Leave this field blank for unlimited attempts.',
	scored: 'Scored (true or false)',
	scoredDescription: 'Enable this option to generate standings based on the points earned in the quiz.',
	reports: 'Reports',
	standings: 'Standings',
	classicQuizNotScored: "The Classic Quiz has no available standings, because it's not scored. You need to update the Classic Quiz to be scored.",
	name: 'Name',
	noStandingsAvailable: 'No standings available.',
	noQuestionsReport: 'The questions report is out of date. Please recalculate in order to see the latest data.',
	questionsReport: 'Questions Report',
	recalculate: 'Recalculate',
	questionsReportRecalculationMessage: 'The questions report is successfully recalculated',
	questionsReportRecalculationErrorMessage: 'There was a problem with recalculating questions report. Please try again',
	questionsReportErrorMessage: 'There was a problem with fetching information about questions report. Please try again',
	participations: 'Participations',
	questionsChartErrorMessage: 'There was a problem with fetching information about questions report. Please try again',
	signOut: 'Sign out',
	timeFormat: 'DD.MM.YYYY, HH:mm',
	getClassicQuizzesErrorMessage: 'There was a problem with fetching classic quizzes',
	title: 'Title',
	noGamesFound: "No classic quizzes were found. You can create one by clicking the button 'Create'",
	status: 'Status',
	participants: 'Participants',
	averageScore: 'Average score',
	perfectScore: 'Perfect score',
	creationDate: 'Created at',
	actions: 'Actions',
	create: 'Create',
	edit: 'Edit',
	clone: 'Clone',
	save: 'Save',
	preview: 'Preview',
	close: 'Close',
	add: 'Add',
	copyUrl: 'Copy URL',
	sortBy: 'Sort by:',
	uploadImage: 'Upload image',
	hideMoreImages: 'Hide more images',
	showMoreImages: 'Show more images',
	configuration: 'Configuration',
	contextEntityTag: 'Context entity tag',
	typeContextTagNamePlaceholder: 'Type context tag name...',
	description: 'Description',
	images: 'Images',
	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',
	clearImage: 'Clear image',
	viewImage: 'View image',
	cropImage: 'Crop image',
	aspectRatio: 'Aspect ratio',
	crop: 'Crop',
	reset: 'Reset',
	sportal365Images: 'Sportal365 Images',
	search: 'Search',
	delete: 'Delete',
	additionalFields: 'Additional fields',
	addQuestion: 'Add question',
	addImages: 'Add images',
	addExplanation: 'Add explanation',
	addEmbedCode: 'Add embed code',
	fromDate: 'From Date',
	toDate: 'To Date',
	embedCode: 'Embed Code',
	embedCodeDescription: 'This field allows you to embed any type of content. For example, if you’d like to ask a question like “What happens next?“, you can embed a short YouTube video and provide answer options below.',
	explanation: 'Explanation',
	explanationDescription: 'This optional field allows you to provide users with more information about the correct answer.',
	rules: 'Rules',
	adContent: 'Ad content',
	adContentPlaceholder: 'Place your ad content in Classic Quiz',
	mainImage: 'Main',
	coverImage: 'Cover',
	mobileImage: 'Mobile',
	addOption: 'Add option',
	removeQuestion: 'Remove question',
	groupByStatus: 'Group by status',
	sortByCreatedAtAsc: 'Sort by created at field in ascending order',
	sortByCreatedAtDesc: 'Sort by created at field in descending order',
	sortByUpdatedAtAsc: 'Sort by updated at field in ascending order',
	sortByUpdatedAtDesc: 'Sort by updated at field in descending order',
	options: 'Options',
	active: 'Active',
	incorrect: 'Incorrect',
	inactive: 'Inactive',
	removeOption: 'Remove option',
	expired: 'Expired',
	time: 'Time',
	timeDescription: 'Specify the time (in seconds) that users will have to answer each question.',
	repeatedValueMessage: 'You have entered a repeated value. Please enter a different one.',
	flags: 'Flags',
	flagsPlaceholder: 'Type your flag and hit enter',
	labels: 'Labels',
	customFields: 'Custom fields',
	dynamicFieldsDescription: 'You can create your custom attributes for easier way to connect or describe your Classic Quiz',
	keyDynamicFields: 'Key',
	valueDynamicFields: 'Value',
	question: 'Question',
	questionNumber: 'Question number',
	option: 'Option',
	questions: 'Questions',
	questionsDescription: 'Manage your questions and their corresponding options.',
	correct: 'Correct',
	wrong: 'Wrong',
	skipped: 'Skipped',
	total: 'Total',
	context: 'Context',
	content: 'Content',
	tags: 'Tags',
	entity: 'Entity',
	campaign: 'Campaign',
	id: 'ID',
	idContentPlaceholder: 'Type the ID of your content',
	idCampaignPlaceholder: 'Type the ID of your campaign',
	label: 'Label',
	labelContentPlaceholder: "Type the content's label",
	labelCampaignPlaceholder: "Type the campaign's label",
	type: 'Type',
	typeDescription: 'Select the type of quiz. You can manage different quiz types by configuring them in the settings.',
	previewClassicQuiz: 'Preview Classic Quiz',
	hideFilters: 'Hide filters',
	showFilters: 'Show filters',
	noImagesFound: 'No images found',
	previous: 'Previous',
	next: 'Next',
	browseQuestions: 'Browse questions',
	browseQuestionsNoResults: 'No questions found',
	addToQuiz: 'Add to Quiz',
	sport: 'Sport',
	football: 'Football',
	basketball: 'Basketball',
	tennis: 'Tennis',
	formulaOne: 'Formula 1',
	eSports: 'Esports',
	rugby: 'Rugby',
	difficulty: 'Difficulty',
	easy: 'Easy',
	medium: 'Medium',
	hard: 'Hard',
	competitions: 'Competitions',
	teams: 'Teams',
	players: 'Players',
	addAll: 'Add all',
	exports: 'Exports',
	exportUsersData: 'Export users data',
	category: 'Category',
	action: 'Action',
	exportAllUsers: 'Export all users',
	exportAllUsersDescription: 'Export all users who participated in the quiz.',
	exportUsersPerfectScore: 'Export users with perfect score',
	exportUsersPerfectScoreDescription: 'Export the users who got all the questions right.',
	exportUsersWithSuccessRate: 'Export users with success rate of minimum',
	exportUsersWithSuccessRateDescription: 'Exports the users who got at least _successRate_ of the questions right.',
	exportTop: 'Export top',
	usersExportMessage: 'Users have been exported successfully',
	usersExportErrorMessage: 'There was a problem with exporting users. Please try again',
	getFootballEntitiesErrorMessage: "There was a problem with fetching football's data. Please try again.",
	titleRequiredFieldValidationMessage: 'Title is required!',
	questionRequiredFieldValidationMessage: 'The question itself is required for each question!',
	optionRequiredFieldValidationMessage: 'The option itself is required for each option in each question!',
	correctInvalidFieldValidationMessage: 'One correct option is required for each question!',
	tagsInvalidFieldValidationMessage: 'Tag entity is required!',
	getClassicQuizErrorMessage: 'There was a problem with fetching classic quiz data. Please try again.',
	createClassicQuizMessage: 'You have successfully created Classic Quiz',
	createClassicQuizErrorMessage: 'There was a problem creating Classic Quiz. Please try again',
	updateClassicQuizMessage: 'You have successfully updated Classic Quiz',
	updateClassicQuizErrorMessage: 'There was a problem updating Classic Quiz. Please try again',
	cloneClassicQuizMessage: 'You have successfully cloned Classic Quiz',
	cloneClassicQuizErrorMessage: 'There was a problem cloning Classic Quiz. Please try again',
	urlCopiedToClipboardMessage: 'URL copied to clipboard',
	imageDeletedMessage: 'Image deleted',
	imageResetMessage: 'The initial size of the image has been restored',
	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',
	deleteClassicQuizMessage: 'Classic Quiz deleted successfully!',
	deleteClassicQuizErrorMessage: 'There was a problem with deleting Classic Quiz. Please try again',
	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',
	filledBrowsedQuestionsMessage: 'You have successfully filled your questions',
	filledBrowsedQuestionsErrorMessage: 'You can import maximum 20 questions!'
};

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

Here is all information about LabelsModel:

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Classic Quiz Management Widget

Installation and usage

Notes

Props

Translation