LLPredictionWidget

🚧

Pre-requisite

Make sure you initialise React Native SDK.

LLPredictionWidget

LLPredictionWidget is a prediction based widget UI component. This widget UI supports two kinds of widget:

1. WidgetKind.TEXT_PREDICTION
2. WidgetKind.IMAGE_PREDICTION

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

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

Hooks used by LLPredictionWidget

• useWidgetInteractiveTimeout
• useWidgetExpiryEffect
• usePredictionWidgetEffect

LLPredictionWidget 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

inlineFollowUp

This prop when present would auto render (in place of prediction widget) its corresponding prediction followup widget whenever it is published from producer suite.

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 { LLPredictionWidget, LLWidgetHeaderProps } from '@livelike/react-native';
import { WidgetKind } from '@livelike/javascript';

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

function MyWidget() {
  return (
    <LLPredictionWidget
      programId="xxxxx"
      widgetId="yyyyy"
      widgetKind={WidgetKind.IMAGE_PREDICTION}
      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 { LLPredictionWidget, LLWidgetFooterProps } from '@livelike/react-native';
import { WidgetKind } from '@livelike/javascript';

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

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

FooterComponentStyles

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

BodyComponent

Refer LLVoteWidgetBody in below section for more details.

BodyComponentStyles

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

LLVoteWidgetBody

This is a body component for a vote option based widget responsible for rendering all the option details and its interaction.

Hooks used by LLVoteWidgetBody

• useStyles
• useWidgetOptions
• useWidgetActions

LLVoteWidgetBody 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.

VoteOptionComponent

Refer LLWidgetVoteOption docs for more details.

VoteOptionComponentStyles

VoteOptionComponentStyles prop that could be used to modify styles of default rendered LLWidgetVoteOption component.