Image#

Import#

import { Image } from 'bumbag-native';

Usage#

Editable example

Image fit#

Setting a fit prop to "contain" means that the whole image will fit in the bounds and it will not lose its scale.

Editable example

Setting a fit prop to "cover" means that the image will fill the bounds and it will not lose its scale.

Editable example

Setting a fit prop to "repeat" means that the image will repeat to cover the frame of the view. The image will keep it's size and aspect ratio. (iOS only)

Editable example

Setting a fit prop to "center" means that the image will scale down so that it is completely visible, if bigger than the area of the view. The image will not be scaled up.

Editable example

Props#

Image Props#

fit

"contain"
  | "center"
  | "cover"
  | "stretch"
  | "repeat"

How the image fits its bounds

Inherits React Native's Image props

style

false
  | ImageStyle
  | RegisteredStyle<ImageStyle>
  | RecursiveArray<false
  | ImageStyle
  | RegisteredStyle<ImageStyle>>

Style

onLayout (event: LayoutChangeEvent) => void

onLayout function

Invoked on mount and layout changes with

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

onError

(error: NativeSyntheticEvent<ImageErrorEventData>) => void

Invoked on load error with {nativeEvent: {error}}

onLoad

(event: NativeSyntheticEvent<ImageLoadEventData>) => void

Invoked when load completes successfully { source: { url, height, width } }.

onLoadEnd () => void

Invoked when load either succeeds or fails

onLoadStart () => void

Invoked on load start

progressiveRenderingEnabled boolean

borderRadius number

borderTopLeftRadius number

borderTopRightRadius number

borderBottomLeftRadius number

borderBottomRightRadius number

resizeMode

"contain"
  | "center"
  | "cover"
  | "stretch"
  | "repeat"

Determines how to resize the image when the frame doesn't match the raw image dimensions.

'cover': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding).

'contain': Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding).

'stretch': Scale width and height independently, This may change the aspect ratio of the src.

'repeat': Repeat the image to cover the frame of the view. The image will keep it's size and aspect ratio. (iOS only)

'center': Scale the image down so that it is completely visible, if bigger than the area of the view. The image will not be scaled up.

resizeMethod "auto" | "resize" | "scale"

The mechanism that should be used to resize the image when the image's dimensions differ from the image view's dimensions. Defaults to auto.

  • auto: Use heuristics to pick between resize and scale.

  • resize: A software operation which changes the encoded image in memory before it gets decoded. This should be used instead of scale when the image is much larger than the view.

  • scale: The image gets drawn downscaled or upscaled. Compared to resize, scale is faster (usually hardware accelerated) and produces higher quality images. This should be used if the image is smaller than the view. It should also be used if the image is slightly bigger than the view.

More details about resize and scale can be found at http://frescolib.org/docs/resizing-rotating.html.

source number | ImageURISource | ImageURISource[] Required

The image source (either a remote URL or a local file resource).

This prop can also contain several remote URLs, specified together with their width and height and potentially with scale/other URI arguments. The native side will then choose the best uri to display based on the measured size of the image container. A cache property can be added to control how networked request interacts with the local cache.

The currently supported formats are png, jpg, jpeg, bmp, gif, webp (Android only), psd (iOS only).

loadingIndicatorSource ImageURISource

similarly to source, this property represents the resource used to render the loading indicator for the image, displayed until image is ready to be displayed, typically after when it got downloaded from network.

testID string

A unique identifier for this element to be used in UI Automation testing scripts.

defaultSource number | ImageURISource

A static image to display while downloading the final image off the network.

blurRadius number

blurRadius: the blur radius of the blur filter added to the image

capInsets Insets

When the image is resized, the corners of the size specified by capInsets will stay a fixed size, but the center content and borders of the image will be stretched. This is useful for creating resizable rounded buttons, shadows, and other resizable assets. More info on Apple documentation

onProgress

(event: NativeSyntheticEvent<ImageProgressEventDataIOS>) => void

Invoked on download progress with {nativeEvent: {loaded, total}}

onPartialLoad () => void

Invoked when a partial load of the image is complete. The definition of what constitutes a "partial load" is loader specific though this is meant for progressive JPEG loads.

fadeDuration number

Duration of fade in animation in ms. Defaults to 300

width number

Required if loading images via 'uri' from drawable folder on Android. Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120

height number

Required if loading images via 'uri' from drawable folder on Android Explanation: https://medium.com/@adamjacobb/react-native-performance-images-adf5843e120

accessible boolean

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

accessibilityActions

readonly Readonly<{ name: string; label?: string; }>[]

Provides an array of custom actions available for accessibility.

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.

accessibilityRole

"none"
  | "text"
  | "search"
  | "button"
  | "link"
  | "menu"
  | "alert"
  | "checkbox"
  | "radio"
  | "image"
  | "keyboardkey"
  | "adjustable"
  | "imagebutton"
  | "header"
  | "summary"
  | "combobox"
  | ... 10 more ...
  | "toolbar"

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

accessibilityState AccessibilityState

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

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.

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

onAccessibilityAction (event: AccessibilityActionEvent) => void

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

accessibilityLiveRegion "none" | "assertive" | "polite"

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.

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

Controls how view is important for accessibility which is if it fires accessibility events and if it is reported to accessibility services that query the screen. Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.

Possible values: 'auto' - The system determines whether the view is important for accessibility - default (recommended). 'yes' - The view is important for accessibility. 'no' - The view is not important for accessibility. 'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.

accessibilityElementsHidden boolean

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

accessibilityViewIsModal boolean

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

onAccessibilityEscape () => void

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

onAccessibilityTap () => void

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

onMagicTap () => void

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

accessibilityIgnoresInvertColors boolean

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

Inherits Box props

animated boolean

children

string
  | number
  | boolean
  | {}
  | ReactElement<any, string
  | ((props: any) => ReactElement<any, string
  | ...
  | (new (props: any) => Component<any, any, any>)>)
  | (new (props: any) => Component<...>)>
  | ReactNodeArray
  | ReactPortal
  | ((props: BoxProps) => ReactNode)

alignX "right" | "left" | "center"

alignY "top" | "bottom" | "center"

altitude string

variant string

colorMode string

disabled boolean

overrides

{
  altitudes?: AltitudesThemeConfig;
  borders?: BordersThemeConfig;
  borderRadii?: BorderRadiiThemeConfig;
  breakpoints?: {
    ...
  }; ... 39 more ...;
  ToastManager?: ToastManagerThemeConfig;
}

elementRef ((instance: any) => void) | RefObject<any>

themeKey string

Inherits React Native's View props

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.

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.

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

nativeID string

Used to reference react managed views from native code.

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.

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.

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.

focusable boolean

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

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.

isTVSelectable boolean

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

hasTVPreferredFocus boolean

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

tvParallaxProperties

{
  enabled?: boolean;
  shiftDistanceX?: number;
  shiftDistanceY?: number;
  tiltAngle?: number;
  magnification?: number;
  pressMagnification?: number;
  pressDuration?: number;
  pressDelay?: number;
}

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

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.

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.

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.

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.

onStartShouldSetResponder (event: GestureResponderEvent) => boolean

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

onMoveShouldSetResponder (event: GestureResponderEvent) => boolean

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

onResponderEnd (event: GestureResponderEvent) => void

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

onResponderGrant (event: GestureResponderEvent) => void

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

onResponderReject (event: GestureResponderEvent) => void

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

onResponderMove (event: GestureResponderEvent) => void

The user is moving their finger

onResponderRelease (event: GestureResponderEvent) => void

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

onResponderStart (event: GestureResponderEvent) => void

onResponderTerminationRequest (event: GestureResponderEvent) => boolean

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

onResponderTerminate (event: GestureResponderEvent) => 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)

onStartShouldSetResponderCapture (event: GestureResponderEvent) => 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.

onMoveShouldSetResponderCapture (event: GestureResponderEvent) => 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.

onTouchStart (event: GestureResponderEvent) => void

onTouchMove (event: GestureResponderEvent) => void

onTouchEnd (event: GestureResponderEvent) => void

onTouchCancel (event: GestureResponderEvent) => void

onTouchEndCapture (event: GestureResponderEvent) => void

Theming#

Image.styles.base
Image.styles.contain
Image.styles.cover
Copyright © 2021 Jake Moxey