LLTextAskWidget
Pre-requisiteMake sure you initialise React Native SDK.
LLTextAskWidget
LLTextAskWidget is a text input based widget UI component where it could be used to get information from your user.
import { LLTextAskWidget } from '@livelike/react-native';
import { WidgetKind } from '@livelike/javascript';
export function MyWidgetContainer() {
return (
<LLTextAskWidget
programId="xxxxx"
widgetId="yyyyy"
/>
);
}Hooks used by LLTextAskWidget
LLTextAskWidgetLLTextAskWidget Props
CustomisationRefer customisation core concepts to understand different level of component customisation.
programId
programId| Type | Default |
|---|---|
| String (Required) | No Default |
This is the Id of the program in which a given widget is published
widgetId
widgetId| Type | Default |
|---|---|
| String (Required) | No Default |
onDismiss
onDismiss| Type | Default |
|---|---|
| Function | No Default |
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
interactiveTimeout| Type | Default |
|---|---|
| Number | No default |
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
onInteractiveTimeout| Type | Default |
|---|---|
| Function | No Default |
Function that gets invoked whenever interactive timer gets elapsed. When interactiveTimeout is set to null, onInteractiveTimeout function would never be called.
WidgetComponent
WidgetComponent| Type | Default |
|---|---|
| Component of type LLCoreWidget | LLCoreWidget |
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| Type | Default |
|---|---|
| StyleSheet of type LLCoreWidgetStyles | No Default, if present styles props would be applied on top of internal LLCoreWidgetStyles |
WidgetComponentStyles prop that could be used to modify styles of default rendered LLCoreWidget component.
HeaderComponent
HeaderComponent| Type | Default |
|---|---|
| Component of type LLWidgetHeader | LLWidgetHeader |
Refer LLWidgetHeader docs for more details.
Example usage:
import { LLTextAskWidget, LLWidgetHeaderProps } from '@livelike/react-native';
function MyHeaderComponent(props: LLWidgetHeaderProps){
// your custom widget header component
}
function MyWidget() {
return (
<LLTextAskWidget
programId="xxxxx"
widgetId="yyyyy"
HeaderComponent={MyHeaderComponent}
/>
);
}HeaderComponentStyles
HeaderComponentStyles| Type | Default |
|---|---|
| StyleSheet of type LLWidgetHeaderStyles | No Default, if present styles props would be applied on top of internal LLWidgetHeaderStyles |
HeaderComponentStyles prop that could be used to modify styles of default rendered LLWidgetHeader component.
FooterComponent
FooterComponent| Type | Default |
|---|---|
| Component of type LLWidgetFooter | LLWidgetFooter |
Refer LLWidgetFooter docs for more details.
Example usage:
import { LLTextAskWidget, LLWidgetFooterProps } from '@livelike/react-native';
function MyFooterComponent(props: LLWidgetFooterProps){
// your custom widget footer component
}
function MyWidget() {
return (
<LLTextAskWidget
programId="xxxxx"
widgetId="yyyyy"
FooterComponent={MyFooterComponent}
/>
);
}FooterComponentStyles
FooterComponentStyles| Type | Default |
|---|---|
| StyleSheet of type LLWidgetFooterStyles | No Default, if present styles props would be applied on top of internal LLWidgetFooterStyles |
FooterComponentStyles prop that could be used to modify styles of default rendered LLWidgetHeader component.
BodyComponent
BodyComponent| Type | Default |
|---|---|
| Component of type LLTextAskWidgetBody | LLTextAskWidgetBody |
Refer LLTextAskWidgetBody in below section for more details.
BodyComponentStyles
BodyComponentStyles| Type | Default |
|---|---|
| StyleSheet of type LLTextAskWidgetBodyStyles | No Default, if present styles props would be applied on top of internal LLTextAskWidgetBodyStyles |
BodyComponentStyles prop that could be used to modify styles of default rendered LLTextAskWidgetBody component.
LLTextAskWidgetBody
This is a body component for a vote option based widget responsible for rendering all the option details and its interaction.
Hooks used by LLTextAskWidgetBody
LLTextAskWidgetBodyLLTextAskWidgetBody Props
LLTextAskWidgetBody PropswidgetId
widgetId| Type | Default |
|---|---|
| String (Required) | No Default |
styles
styles| Type | Default |
|---|---|
| Stylesheet of type LLTextAskWidgetBodyStyles | No Default, if present styles props would be applied on top of internal LLTextAskWidgetBodyStyles. |
styles prop that could be used to modify styles of LLTextAskWidgetBody component.
InputComponent
InputComponent| Type | Default |
|---|---|
| Component of type LLTextAskWidgetInput | LLTextAskWidgetInput |
Component responsible for rendering text input UI.
InputComponentStyles
InputComponentStyles| Type | Default |
|---|---|
| StyleSheet of type LLWidgetOptionStyles | No Default, if present styles props would be applied on top of internal LLWidgetOptionStyles |
InputComponentStyles prop that could be used to modify styles of default rendered LLWidgetVoteOption component.
Updated 27 days ago
