types

@shopify/shop-minis-platform-sdk / components/Picker/types

HasValue

Properties

value

value: string | number

---

PickerProps\<T>

Extends

• PickerProps

Type Parameters

Type Parameter
T extends HasValue

Properties

accessibilityActions?

optional accessibilityActions: readonly Readonly\<object>[]

Provides an array of custom actions available for accessibility.

Inherited from

CommunityPickerProps.accessibilityActions

accessibilityElementsHidden?

optional accessibilityElementsHidden: boolean

A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.

Platform

ios

Inherited from

CommunityPickerProps.accessibilityElementsHidden

accessibilityHint?

optional accessibilityHint: string

An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

Inherited from

CommunityPickerProps.accessibilityHint

accessibilityIgnoresInvertColors?

optional accessibilityIgnoresInvertColors: boolean

https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios

Platform

ios

Inherited from

CommunityPickerProps.accessibilityIgnoresInvertColors

accessibilityLabel?

optional accessibilityLabel: string

Overrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.

Inherited from

CommunityPickerProps.accessibilityLabel

accessibilityLabelledBy?

optional accessibilityLabelledBy: string | string[]

A reference to another element nativeID used to build complex forms. The value of accessibilityLabelledBy should match the nativeID of the related element.

Platform

android

Inherited from

CommunityPickerProps.accessibilityLabelledBy

accessibilityLanguage?

optional accessibilityLanguage: string

By using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios

Platform

ios

Inherited from

CommunityPickerProps.accessibilityLanguage

accessibilityLiveRegion?

optional accessibilityLiveRegion: "none" | "polite" | "assertive"

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.

Platform

android

Inherited from

CommunityPickerProps.accessibilityLiveRegion

accessibilityRole?

optional accessibilityRole: AccessibilityRole

Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.

Inherited from

CommunityPickerProps.accessibilityRole

accessibilityState?

optional accessibilityState: AccessibilityState

Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.

Inherited from

CommunityPickerProps.accessibilityState

accessibilityValue?

optional accessibilityValue: AccessibilityValue

Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).

Inherited from

CommunityPickerProps.accessibilityValue

accessibilityViewIsModal?

optional accessibilityViewIsModal: boolean

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

Platform

ios

Inherited from

CommunityPickerProps.accessibilityViewIsModal

accessible?

optional accessible: boolean

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

Inherited from

CommunityPickerProps.accessible

aria-busy?

optional aria-busy: boolean

alias for accessibilityState

see https://reactnative.dev/docs/accessibility#accessibilitystate

Inherited from

CommunityPickerProps.aria-busy

aria-checked?

optional aria-checked: boolean | "mixed"

Inherited from

CommunityPickerProps.aria-checked

aria-disabled?

optional aria-disabled: boolean

Inherited from

CommunityPickerProps.aria-disabled

aria-expanded?

optional aria-expanded: boolean

Inherited from

CommunityPickerProps.aria-expanded

aria-hidden?

optional aria-hidden: boolean

A value indicating whether the accessibility elements contained within this accessibility element are hidden.

Inherited from

CommunityPickerProps.aria-hidden

aria-label?

optional aria-label: string

Alias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424

Inherited from

CommunityPickerProps.aria-label

aria-labelledby?

optional aria-labelledby: string

Represents the nativeID of the associated label text. When the assistive technology focuses on the component with this props, the text is read aloud.

Platform

android

Inherited from

CommunityPickerProps.aria-labelledby

aria-live?

optional aria-live: "polite" | "assertive" | "off"

Inherited from

CommunityPickerProps.aria-live

aria-modal?

optional aria-modal: boolean

Inherited from

CommunityPickerProps.aria-modal

aria-selected?

optional aria-selected: boolean

Inherited from

CommunityPickerProps.aria-selected

aria-valuemax?

optional aria-valuemax: number

Inherited from

CommunityPickerProps.aria-valuemax

aria-valuemin?

optional aria-valuemin: number

Inherited from

CommunityPickerProps.aria-valuemin

aria-valuenow?

optional aria-valuenow: number

Inherited from

CommunityPickerProps.aria-valuenow

aria-valuetext?

optional aria-valuetext: string

Inherited from

CommunityPickerProps.aria-valuetext

children?

optional children: ReactNode

Inherited from

CommunityPickerProps.children

collapsable?

optional collapsable: boolean

Views that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.

Inherited from

CommunityPickerProps.collapsable

enabled?

optional enabled: boolean

If set to false, the picker will be disabled, i.e. the user will not be able to make a selection.

Platform

android

Inherited from

CommunityPickerProps.enabled

focusable?

optional focusable: boolean

Whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.

Inherited from

CommunityPickerProps.focusable

handleDismiss()

handleDismiss: () => void

Returns

void

hasTVPreferredFocus?

optional hasTVPreferredFocus: boolean

(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.

Platform

ios

Inherited from

CommunityPickerProps.hasTVPreferredFocus

headerText?

optional headerText: string

hitSlop?

optional hitSlop: Insets

This defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with hitSlop={{top: 10, bottom: 10, left: 0, right: 0}} NOTE The touch area never extends past the parent view bounds and the Z-index of sibling views always takes precedence if a touch hits two overlapping views.

Inherited from

CommunityPickerProps.hitSlop

id?

optional id: string

Used to reference react managed views from native code.

Inherited from

CommunityPickerProps.id

importantForAccessibility?

optional importantForAccessibility: "auto" | "yes" | "no" | "no-hide-descendants"

[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.

Inherited from

CommunityPickerProps.importantForAccessibility

isTVSelectable?

optional isTVSelectable: boolean

(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.

Platform

ios

Inherited from

CommunityPickerProps.isTVSelectable

items

items: T[]

itemStyle?

optional itemStyle: StyleProp\<TextStyle>

Style to apply to each of the item labels.

Platform

ios

Inherited from

CommunityPickerProps.itemStyle

mode?

optional mode: "dialog" | "dropdown"

On Android, specifies how to display the selection items when the user taps on the picker:

• 'dialog': Show a modal dialog. This is the default.
• 'dropdown': Shows a dropdown anchored to the picker view

Platform

android

Inherited from

CommunityPickerProps.mode

nativeID?

optional nativeID: string

Used to reference react managed views from native code.

Inherited from

CommunityPickerProps.nativeID

needsOffscreenAlphaCompositing?

optional needsOffscreenAlphaCompositing: boolean

Whether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. This default may be noticeable and undesired in the case where the View you are setting an opacity on has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).

Rendering offscreen to preserve correct alpha behavior is extremely expensive and hard to debug for non-native developers, which is why it is not turned on by default. If you do need to enable this property for an animation, consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame). If that property is enabled, this View will be rendered off-screen once, saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.

Inherited from

CommunityPickerProps.needsOffscreenAlphaCompositing

onAccessibilityAction()?

optional onAccessibilityAction: (event) => void

When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.

Parameters

Parameter	Type
event	AccessibilityActionEvent

Returns

void

Inherited from

CommunityPickerProps.onAccessibilityAction

onAccessibilityEscape()?

optional onAccessibilityEscape: () => void

When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

Returns

void

Platform

ios

Inherited from

CommunityPickerProps.onAccessibilityEscape

onAccessibilityTap()?

optional onAccessibilityTap: () => void

When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.

Returns

void

Platform

ios

Inherited from

CommunityPickerProps.onAccessibilityTap

onLayout()?

optional onLayout: (event) => void

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

Parameters

Parameter	Type
event	LayoutChangeEvent

Returns

void

Inherited from

CommunityPickerProps.onLayout

onMagicTap()?

optional onMagicTap: () => void

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

Returns

void

Platform

ios

Inherited from

CommunityPickerProps.onMagicTap

onMoveShouldSetResponder()?

optional onMoveShouldSetResponder: (event) => boolean

Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

CommunityPickerProps.onMoveShouldSetResponder

onMoveShouldSetResponderCapture()?

optional onMoveShouldSetResponderCapture: (event) => boolean

onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.

However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

CommunityPickerProps.onMoveShouldSetResponderCapture

onPointerCancel()?

optional onPointerCancel: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerCancel

onPointerCancelCapture()?

optional onPointerCancelCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerCancelCapture

onPointerDown()?

optional onPointerDown: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerDown

onPointerDownCapture()?

optional onPointerDownCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerDownCapture

onPointerEnter()?

optional onPointerEnter: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerEnter

onPointerEnterCapture()?

optional onPointerEnterCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerEnterCapture

onPointerLeave()?

optional onPointerLeave: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerLeave

onPointerLeaveCapture()?

optional onPointerLeaveCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerLeaveCapture

onPointerMove()?

optional onPointerMove: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerMove

onPointerMoveCapture()?

optional onPointerMoveCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerMoveCapture

onPointerUp()?

optional onPointerUp: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerUp

onPointerUpCapture()?

optional onPointerUpCapture: (event) => void

Parameters

Parameter	Type
event	PointerEvent

Returns

void

Inherited from

CommunityPickerProps.onPointerUpCapture

onResponderEnd()?

optional onResponderEnd: (event) => void

If the View returns true and attempts to become the responder, one of the following will happen:

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onResponderEnd

onResponderGrant()?

optional onResponderGrant: (event) => void

The View is now responding for touch events. This is the time to highlight and show the user what is happening

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onResponderGrant

onResponderMove()?

optional onResponderMove: (event) => void

The user is moving their finger

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onResponderMove

onResponderReject()?

optional onResponderReject: (event) => void

Something else is the responder right now and will not release it

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onResponderReject

onResponderRelease()?

optional onResponderRelease: (event) => void

Fired at the end of the touch, ie "touchUp"

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onResponderRelease

onResponderStart()?

optional onResponderStart: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onResponderStart

onResponderTerminate()?

optional onResponderTerminate: (event) => void

The responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onResponderTerminate

onResponderTerminationRequest()?

optional onResponderTerminationRequest: (event) => boolean

Something else wants to become responder. Should this view release the responder? Returning true allows release

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

CommunityPickerProps.onResponderTerminationRequest

onStartShouldSetResponder()?

optional onStartShouldSetResponder: (event) => boolean

Does this view want to become responder on the start of a touch?

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

CommunityPickerProps.onStartShouldSetResponder

onStartShouldSetResponderCapture()?

optional onStartShouldSetResponderCapture: (event) => boolean

onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.

However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

boolean

Inherited from

CommunityPickerProps.onStartShouldSetResponderCapture

onTouchCancel()?

optional onTouchCancel: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onTouchCancel

onTouchEnd()?

optional onTouchEnd: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onTouchEnd

onTouchEndCapture()?

optional onTouchEndCapture: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onTouchEndCapture

onTouchMove()?

optional onTouchMove: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onTouchMove

onTouchStart()?

optional onTouchStart: (event) => void

Parameters

Parameter	Type
event	GestureResponderEvent

Returns

void

Inherited from

CommunityPickerProps.onTouchStart

onValueChange()?

optional onValueChange: (itemValue, itemIndex) => void

Callback for when an item is selected. This is called with the following parameters:

• itemValue: the value prop of the item that was selected
• itemIndex: the index of the selected item in this picker

Parameters

Parameter	Type
itemValue	ItemValue
itemIndex	number

Returns

void

Inherited from

CommunityPickerProps.onValueChange

pointerEvents?

optional pointerEvents: "auto" | "none" | "box-none" | "box-only"

In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:

.box-none { pointer-events: none; } .box-none * { pointer-events: all; }

box-only is the equivalent of

.box-only { pointer-events: all; } .box-only * { pointer-events: none; }

But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes, we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.

Inherited from

CommunityPickerProps.pointerEvents

prompt?

optional prompt: string

Prompt string for this picker, used on Android in dialog mode as the title of the dialog.

Platform

android

Inherited from

CommunityPickerProps.prompt

removeClippedSubviews?

optional removeClippedSubviews: boolean

This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).

Inherited from

CommunityPickerProps.removeClippedSubviews

renderToHardwareTextureAndroid?

optional renderToHardwareTextureAndroid: boolean

Whether this view should render itself (and all of its children) into a single hardware texture on the GPU.

On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.

Inherited from

CommunityPickerProps.renderToHardwareTextureAndroid

role?

optional role: Role

Indicates to accessibility services to treat UI component like a specific role.

Inherited from

CommunityPickerProps.role

selectedValue?

optional selectedValue: ItemValue

Value matching value of one of the items. Can be a string or an integer.

Inherited from

CommunityPickerProps.selectedValue

shouldRasterizeIOS?

optional shouldRasterizeIOS: boolean

Whether this view should be rendered as a bitmap before compositing.

On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame.

Rasterization incurs an off-screen drawing pass and the bitmap consumes memory. Test and measure when using this property.

Inherited from

CommunityPickerProps.shouldRasterizeIOS

style?

optional style: StyleProp\<TextStyle>

Inherited from

CommunityPickerProps.style

testID?

optional testID: string

Used to locate this view in end-to-end tests.

Inherited from

CommunityPickerProps.testID

tvParallaxMagnification?

optional tvParallaxMagnification: number

(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 1.0.

Platform

ios

Inherited from

CommunityPickerProps.tvParallaxMagnification

tvParallaxProperties?

optional tvParallaxProperties: TVParallaxProperties

(Apple TV only) Object with properties to control Apple TV parallax effects.

Platform

ios

Inherited from

CommunityPickerProps.tvParallaxProperties

tvParallaxShiftDistanceX?

optional tvParallaxShiftDistanceX: number

(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.

Platform

ios

Inherited from

CommunityPickerProps.tvParallaxShiftDistanceX

tvParallaxShiftDistanceY?

optional tvParallaxShiftDistanceY: number

(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.

Platform

ios

Inherited from

CommunityPickerProps.tvParallaxShiftDistanceY

tvParallaxTiltAngle?

optional tvParallaxTiltAngle: number

(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 0.05.

Platform

ios

Inherited from

CommunityPickerProps.tvParallaxTiltAngle