fansunited-widget-poll

v1.2.0

Published

22 days ago

Downloads

196

0High
0Medium
0Low

fansunited

Poll Management Widget

Welcome to Fans United Poll Management Widget. The widget allows staff members with sufficient permissions to create, update and delete Polls. You can use this widget as it is and embed it in your platform, or you can use the Management Panel. With creating a poll, users can answer a single question and win prizes. With successful installation, you can create, edit and delete a poll.

Installation and usage

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

npm  install  fansunited-widget-poll

or:

yarn  add  fansunited-widget-poll

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

import  'fansunited-widget-poll/style.css';
import { PollManager } from  'fansunited-widget-poll';

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

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

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

Props

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

Fans United Poll 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 Poll 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-poll/style.css';
import { PollManager } from  'fansunited-widget-poll';

const  labels = {
	userNotFound:  'User not found. Please try again',
	noPollsFound: "No polls games were found. You can create one by clicking the button 'Create'",
	signOut:  'Sign out',
	timeFormat:  'DD.MM.YYYY, HH:mm',
	getPollsErrorMessage: 'There was a problem with fetching list of polls',
	title:  'Title',
	status:  'Status',
	votes:  'Votes',
	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',
	minimumVotes: 'Minimum votes',
	minimumVotesPlaceholder: 'Enter the minimum votes for polls',
	description: 'Description',
	descriptionPlaceholder: 'Describe your poll',
	images: 'Images',
	rules: 'Rules',
	rulesPlaceholder: 'Describe your rules for voting in the poll',
	adContent: 'Ad content',
	adContentPlaceholder: 'Place your ad content',
	optionImages: 'Option images',
	main: 'Main',
	cover: 'Cover',
	mobile: 'Mobile',
	active: 'Active',
	inactive: 'Inactive',
	statusDescription: "When poll is Inactive, then users are not allowed to vote",
	optionsDescription: 'Describe the options that users will select from the poll. Ensure to provide a minimum of 2 options. Title for each is required',
	titlePlaceholder: 'Provide a title for your poll',
	optionTitlePlaceholder: 'Type the title of the option',
	optionDescriptionPlaceholder: 'Type the description 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 poll',
	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 poll type. You can set the types in our Management Portal by going to Features, then clicking on the Poll page',
	noType: "No type",
	deleteLabel: 'Delete',
	cancelLabel: 'Cancel',
	confirmationQuestionLabel: 'Are you sure you want to delete',
	typeContentPlaceholder: "Type the content's type",
	previewPoll: 'Preview poll',
	getFootballEntitiesErrorMessage: "There was a problem with fetching football's data",
	createPollMessage: 'You have successfully created poll',
	createPollErrorMessage: 'There was a problem creating poll. Please try again',
	titleRequiredFieldValidationMessage: 'Title field is required!',
	optionsFieldValidationMessage: "Options must have titles",
	tagsInvalidFieldValidationMessage: 'Tag entity is required!',
	getPollErrorMessage: 'There was a problem with fetching poll data. Please try again',
	deletePollMessage: 'You have successfully deleted poll',
	deletePollErrorMessage: 'There was a problem with deleting poll. Please try again',
	updatePollMessage: 'You have successfully updated the poll',
	updatePollErrorMessage: 'There was a problem updating the poll. 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',
	embedCode: 'Embed Code',
	embedCodePlaceholder: 'Place your embed code here',
	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 (
<PollManager
	fansUnitedApiKey={'your-api-key'}
	fansUnitedClientId={'your-client-id'}
	labels={labels}/>
);
}

Here is all information about LabelsModel:

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Poll Management Widget

Installation and usage

Notes

Props

Translation