fansunited-widget-either-or

v1.3.0

Published

a month ago

Downloads

220

0High
0Medium
0Low

fansunited

Either/Or Management Widget

Welcome to Fans United Either/Or Management Widget. The widget allows staff members with sufficient permissions to create, update and delete Either/Or mini-games. You can use this widget as it is and embed it in your platform, or you can use the Management Panel. Either/Or is a mini-game where users receives two options and he needs to answer which is one more or less for a specified time. With successful installation, you can create, edit and delete a Either/Or mini-game.

Installation and usage

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

npm  install  fansunited-widget-either-or

or:

yarn  add  fansunited-widget-either-or

Here is an example how you can integrate Fans United Either/Or Management Widget:

import  'fansunited-widget-either-or/style.css';
import { EitherOrManager } from  'fansunited-widget-either-or';

const  App = () => {
return (
<EitherOrManager
	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-either-or/style.css';

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

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

Props

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

Fans United Either/Or 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 left 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 Either/Or 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-either-or/style.css';
import { EitherOrManager } from  'fansunited-widget-either-or';

const  labels = {
	userNotFound:  'User not found. Please try again',
	noGamesFound: "No Either/Or games were found. You can create one by clicking the button 'Create'",
	signOut:  'Sign out',
	timeFormat:  'DD.MM.YYYY, HH:mm',
	getEitherOrsErrorMessage: 'There was a problem with fetching list of Either/Or games',
	title:  'Title',
	status:  'Status',
	creationDate:  'Created at',
	actions:  'Actions',
	create: 'Create',
	edit: 'Edit',
	save: 'Save',
	preview: 'Preview',
	close: 'Close',
	filterBy: 'Filter by:',
	sortBy: 'Sort by:',
	clearStatus: 'Clear status',
	contextEntityTag: 'Context entity tag',
	typeContextTagNamePlaceholder: 'Type context tag name...',
	showMoreImages: 'Show more images',
	hideMoreImages: 'Hide more images',
	uploadImage: 'Upload image',
	groupByStatus: 'Group by status',
	copyUrl: 'Copy URL',
	copied: 'Copied',
	add: 'Add',
	configuration: 'Configuration',
	titlePlaceholder: 'Provide a title for your Either/Or',
	description: 'Description',
	descriptionPlaceholder: 'Describe your Either/Or',
	images: 'Images',
	rules: 'Rules',
	rulesPlaceholder: 'Describe your rules for participating in Either/Or',
	adContent: 'Ad content',
	adContentPlaceholder: 'Place your ad content in Either/Or',
	optionImages: 'Option images',
	main: 'Main',
	cover: 'Cover',
	mobile: 'Mobile',
	imagePlaceholder: 'Paste your image as valid URL or as relative path',
	active: 'Active',
	inactive: 'Inactive',
	statusDescription: "When Either/Or is Inactive, then users are not allowed to participate",
	winningCondition: 'Winning condition',
	winningConditionDescription: "Winning condition determines the correct choice out of a pair of options presented to the user. When is set to 'More,' the user must select the option that has a greater value to win. Conversely, if is set to 'Less,' the winning choice is the one with the lesser value",
	more: 'More',
	less: 'Less',
	time: 'Time',
	timeDescription: 'Enter the time limit for answering questions by users. Time is in seconds',
	lives: 'Lives',
	livesDescription: 'Enter how many lives the user will have during a game',
	points: 'Points',
	pointsDescription: 'Set the threshold of consecutive correct answers after which points are awarded and define the amount of points received from this step onwards.Valid value for correct steps is between 0-50 and for score 1-100',
	pointNumber: 'Point number',
	pointsCorrectSteps: 'Correct steps',
	pointsCorrectStepsPlaceholder: 'Set the number of correct steps needed in a row to earn points',
	pointsScore: 'Score',
	pointsScorePlaceholder: 'Set the points awarded per correct answer within the streak',
	optionsDescription: 'Describe the options that users will select from during the game. Ensure to provide a minimum of 5 and a maximum of 100 options',
	optionsValue: 'Value',
	optionsValuePlaceholder: 'Type the value of the option',
	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 Either/Or',
	keyDynamicFields: 'Key',
	valueDynamicFields: 'Value',
	options: 'Options',
	optionNumber: 'Option number',
	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 Either/Or type. You can set the types in our Management Portal by going to Features, then clicking on the Either/Or page',
	noType: "No type",
	deleteLabel: 'Delete',
	cancelLabel: 'Cancel',
	confirmationQuestionLabel: 'Are you sure you want to delete',
	typeContentPlaceholder: "Type the content's type",
	previewEitherOr: 'Preview Either/Or',
	getFootballEntitiesErrorMessage: "There was a problem with fetching football's data",
	createEitherOrMessage: 'You have successfully created Either/Or',
	createEitherOrErrorMessage: 'There was a problem creating Either/Or. Please try again',
	titleRequiredFieldValidationMessage: 'Title field is required!',
	livesFieldValidationMessage: "The value for 'lives' field is invalid. The valid one is withing the range of 1-20",
	timeFieldValidationMessage: "The value for 'time' field is invalid. The valid one is withing the range of 1-20",
	pointsFieldValidationMessage: "Points contain value where score or correct steps is an invalid one",
	optionsFieldValidationMessage: "Options must not contain any repeated IDs",
	tagsInvalidFieldValidationMessage: 'Tag entity is required!',
	getEitherOrErrorMessage: 'There was a problem with fetching Either/Or data. Please try again',
	deleteEitherOrMessage: 'You have successfully deleted Either/Or',
	deleteEitherOrErrorMessage: 'There was a problem with deleting Either/Or. Please try again',
	updateEitherOrMessage: 'You have successfully updated Either/Or',
	updateEitherOrErrorMessage: 'There was a problem updating Either/Or. Please try again',
	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',
	clear: 'Clear'
	searchSportal365ImagesErrorMessage: 'There was a problem with searching images from Sportal 365 API. Please try again'
	searchImages: 'Search images',
	clearFromToFilterSportal365ImagesMessage: 'You have cleared from/to filter for Sportal365 search images',
	hideFilters: 'Hide filters',
	showFilters: 'Show filters',
	dateFromTo: 'Date from/to',
	dateFromToPlaceholder: 'Select Date...',
	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',
	exportAllUsers: "Export all users",
	usersExportMessage: "All users have been exported successfully",
	usersExportErrorMessage: "There was a problem with exporting users. Please try again"

};

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

Here is all information about LabelsModel:

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Either/Or Management Widget

Installation and usage

Notes

Props

Translation