Skip to main content

PictureChoiceFabric component

Component for rendering a list of selectable images or emojis.

📝 Signature​

PictureChoiceFabric(props: {
styles: {
color: string;
outlineSize?: number;
roundness?: number;
scale?: number;
margin?: number;
};
options: IPictureChoiceOption[];
size?: "small" | "medium" | "large";
required?: boolean;
disabled?: boolean;
readOnly?: boolean;
ariaDescribedBy?: string;
tabIndex?: number;
value?: string | Value;
autoSubmit?: boolean;
view?: "live" | "test" | "preview";
onChange?: (value: string) => void;
onFocus?: (e: FocusEvent) => void;
onBlur?: (e: FocusEvent) => void;
onAutoFocus?: (el: HTMLButtonElement | null) => void;
onSubmit?: () => void;
onCancel?: () => void;
}): JSX.Element

📇 Props​

NameTypeOptionalDescription
stylesobjectNoSpecifies the styles for the options. Supports the following styles:
- color: Base color for the buttons;
- outlineSize: Optional outline size in pixels for the buttons;
- roundness: Optional roundness in pixels for the buttons;
- scale: Optional scale factor for the buttons (defaults to 1);
- margin: Optional margin in pixels in between the buttons.
optionsIPictureChoiceOption[]NoSpecifies the options (see IPictureChoiceOption).
size"small" | "medium" | "large"YesSpecifies the size of the options.
requiredbooleanYesSpecifies if the component is required.
disabledbooleanYesSpecifies if the component is disabled.
readOnlybooleanYesSpecifies if the component is read-only.
ariaDescribedBystringYesSpecifies the aria-describedby identifier of the element that describes the component.
tabIndexnumberYesSpecifies the tabindex for the component.
valuestring | ValueYesSpecifies the value for the component. When a string is specified, this is the initial value for the input control. When a Value is supplied, this initial value is retrieved from the Value instance. Changes made in the input control are automatically reflected to the Value instance.
autoSubmitbooleanYesSpecifies if the component gets submitted when the user selects a button.
view"live" | "test" | "preview"YesSpecifies the view in which the component is shown.
onChange(value: string) => voidYesInvoked when the value of the component is changed.
onFocus(e: FocusEvent) => voidYesInvoked when the component gets focus.
onBlur(e: FocusEvent) => voidYesInvoked when the component loses focus.
onAutoFocus(el: HTMLButtonElement | null) => voidYesInvoked when the HTML element of the component is available for auto-focus.
onSubmit() => voidYesInvoked when the user presses the Shift + Enter key combination or the Tab key (this event is often used to go to the next input control in a form).
onCancel() => voidYesInvoked when the user presses the Shift + Tab key combination (this event is often used to go to the previous input control in a form).

↩ī¸ Return value​

Returns the JSX.Element for the component.

👩‍đŸ’ģ Example​

import { PictureChoiceFabric } from "tripetto-runner-fabric/components/picture-choice";

const PictureChoiceFabricExample = () => (
<PictureChoiceFabric
styles={{
color: "green"
}}
options={[
{
id: "1",
emoji: "🙂",
onChange: (selected) => console.log(`Option 1 selected: ${selected}`)
},
{
id: "2",
label: "😀",
onChange: (selected) => console.log(`Option 2 selected: ${selected}`)
}
]}
/>
);

⛓ī¸ Interfaces​


🔗 IPictureChoiceOption​

Describes the interface for a picture choice option.

Type declaration​

interface IPictureChoiceOption {
/* Identifier for the option. */
id: string;

/* Image for the option. */
image?: string;

/* Emoji for the option. */
emoji?: string;

/* Name for the option. */
name?: string;

/* Specifies if the name is visible. */
nameVisible?: boolean;

/* Value for the option. */
value?: string;

/* Description for the option. */
description?: string;

/* URL for the option. */
url?: string;

/* Target for the option URL. */
target?: "self" | "blank";

/* Specifies if the option is disabled. */
disabled?: boolean;

/* Specifies the option slot. */
slot: Slots.Boolean;

/* Tabindex for the option. */
tabIndex?: number;

/* Specifies the onChange function for the option. */
onChange?: (selected: boolean) => void;
}