LLQuizWidget

🚧

Pre-requisite

Make sure you initialise React Native SDK.

LLQuizWidget

LLQuizWidget is a quiz based widget UI component. This widget UI supports two kinds of widget:

1. WidgetKind.TEXT_QUIZ
2. WidgetKind.IMAGE_QUIZ

import { LLQuizWidget } from '@livelike/react-native';
import { WidgetKind } from '@livelike/javascript';

export function MyWidgetContainer() {
  return (
    <LLQuizWidget
      programId="xxxxx"
      widgetId="yyyyy"
      widgetKind={WidgetKind.IMAGE_QUIZ}
    />
  );
}

Hooks used by LLQuizWidget

• useWidgetInteractiveTimeout
• useWidgetExpiryEffect

LLQuizWidget Props

📘

Customisation

Refer customisation core concepts to understand different level of component customisation.

programId

This is the Id of the program in which a given widget is published

widgetId

widgetKind

onDismiss

Function that gets invoked whenever user dismisses the widget by clicking on dismiss Icon.
Pass onDismiss prop (with no op function) to make widget dismissible.

interactiveTimeout

Interactive timeout in epoch. Once the timeout gets elapsed, widget transition into Timed Out phase where it is in disabled state.
When setting interactiveTimeout as null, this overrides widget interactive timeout (that is set from producer suite) and widget becomes always interactive.

onInteractiveTimeout

Function that gets invoked whenever interactive timer gets elapsed. When interactiveTimeout is set to null, onInteractiveTimeout function would never be called.

WidgetComponent

This is the core widget component that is responsible for loading widget details and rendering other part of widget UI (passed as children).
Refer LLCoreWidget docs for more details.

WidgetComponentStyles

WidgetComponentStyles prop that could be used to modify styles of default rendered LLCoreWidget component.

HeaderComponent

Refer LLWidgetHeader docs for more details.

Example usage:

import { LLQuizWidget, LLWidgetHeaderProps } from '@livelike/react-native';
import { WidgetKind } from '@livelike/javascript';

function MyHeaderComponent(props: LLWidgetHeaderProps){
  // your custom widget header component
}

function MyWidget() {
  return (
    <LLQuizWidget
      programId="xxxxx"
      widgetId="yyyyy"
      widgetKind={WidgetKind.IMAGE_QUIZ}
      HeaderComponent={MyHeaderComponent}
    />
  );
}

HeaderComponentStyles

HeaderComponentStyles prop that could be used to modify styles of default rendered LLWidgetHeader component.

FooterComponent

Refer LLWidgetFooter docs for more details.

Example usage:

import { LLQuizWidget, LLWidgetFooterProps } from '@livelike/react-native';
import { WidgetKind } from '@livelike/javascript';

function MyFooterComponent(props: LLWidgetFooterProps){
  // your custom widget footer component
}

function MyWidget() {
  return (
    <LLQuizWidget
      programId="xxxxx"
      widgetId="yyyyy"
      widgetKind={WidgetKind.IMAGE_QUIZ}
      FooterComponent={MyFooterComponent}
    />
  );
}

FooterComponentStyles

FooterComponentStyles prop that could be used to modify styles of default rendered LLWidgetHeader component.

BodyComponent

Refer LLQuizWidgetBody in below section for more details.

BodyComponentStyles

BodyComponentStyles prop that could be used to modify styles of default rendered LLQuizWidgetBody component.

LLQuizWidgetBody

This is a body component for a quiz widget responsible for rendering quiz choice details and its interaction.

Hooks used by LLQuizWidgetBody

• useStyles
• useWidgetChoices
• useWidgetActions

LLQuizWidgetBody Props

📘

Customisation

Refer customisation core concepts to understand different level of component customisation.

widgetId

styles

styles prop that could be used to modify styles of LLVoteWidgetBody component.

ChoiceOptionComponent

Refer LLWidgetChoiceOptionin below section for more details.

ChoiceOptionComponentStyles

ChoiceOptionComponentStyles prop that could be used to modify styles of default rendered LLWidgetChoiceOption component.

LLWidgetChoiceOption

LLWidgetChoiceOption is a container component that renders quiz widget choice option using LLWidgetOption as its presentational component. It derives all the choice details and interaction handler needed by LLWidgetOption component.

Hooks used by LLWidgetChoiceOption

• useWidgetResultState
• useWidgetChoices
• useInteractedWidgetOption
• useIsWidgetOptionDisabled

LLWidgetChoiceOption Props

📘

Customisation

Refer customisation core concepts to understand different level of component customisation.

widgetId

optionIndex

Index of the widget option

selectedOptionIndex

Index of the selected widget option

onOptionChange

Function that gets invoked with option index whenever vote option is selected.

OptionComponent

Presentational component for option component.

OptionComponentStyles

OptionComponentStyles prop that could be used to modify styles of default rendered LLWidgetOption component.