#Icon

Bumbag aims to have a low bundle size & be icon agnostic, hence it does not come with a default icon set (apart from status icons).

You will need to bring your own icon set. Below is a guide & example to import the Free Font Awesome icon set.

There are two ways to import icons for the <Icon> component. You can either:

#Import

import { Icon } from 'bumbag-native';

#Usage via Bumbag Theme

Note: Bumbag currently only supports parsing of Font Awesome icons. If you want to use another icon set, you will need to follow the usage via SVG paths instructions. Want to add a parser or an icon set? Open a Pull Request.

First, you will need to inject the icons your app will use into the Bumbag Theme

This example uses @fortawesome/free-solid-svg-icons and @fortawesome/free-regular-svg-icons.

import { Provider as BumbagProvider } from 'bumbag';
import { faIgloo, faSearch, faClipboard, faThumbsUp } from '@fortawesome/free-solid-svg-icons';
import { faAddressBook } from '@fortawesome/free-regular-svg-icons';
const theme = {
icons: {
iconSets: [
{
icons: [faIgloo, faSearch, faClipboard, faThumbsUp],
prefix: 'solid-',
type: 'font-awesome'
},
{
icons: [faAddressBook],
prefix: 'regular-',
type: 'font-awesome'
}
]
}
};
export default () => <BumbagProvider theme={theme}><App/></BumbagProvider>

Then, you can use your icons like so:

Editable example

#Usage via Direct Import

You can also import the icons when you need them:

import { faPen } from '@fortawesome/free-solid-svg-icons'
<Icon icon={faPen} type="font-awesome" />

#Usage with SVG paths

Currently, Bumbag only supports parsing of Font Awesome icons, but if you want to use another icon set, you will need to use SVG paths.

You can supply your SVG paths through the Bumbag Theme or on the icon directly.

#Via the Bumbag Theme

Here is an example for a calendar icon:

import { ThemeProvider } from 'bumbag';
import { faIgloo, faSearch, faClipboard, faThumbsUp } from '@fortawesome/free-solid-svg-icons';
import { faAddressBook } from '@fortawesome/free-regular-svg-icons';
const theme = {
icons: {
icons: {
calendar: {
viewBoxWidth: 16,
viewBoxHeight: 16,
paths: ['M11 3c.6 0 1-.5 1-1V1c0-.6-.4-1-1-1s-1 .4-1 1v1c0 .5.4 1 1 1zm3-2h-1v1c0 1.1-.9 2-2 2s-2-.9-2-2V1H6v1c0 1.1-.9 2-2 2s-2-.9-2-2V1H1c-.6 0-1 .5-1 1v12c0 .6.4 1 1 1h13c.6 0 1-.4 1-1V2c0-.6-.5-1-1-1zM5 13H2v-3h3v3zm0-4H2V6h3v3zm4 4H6v-3h3v3zm0-4H6V6h3v3zm4 4h-3v-3h3v3zm0-4h-3V6h3v3zM4 3c.6 0 1-.5 1-1V1c0-.6-.4-1-1-1S3 .4 3 1v1c0 .5.4 1 1 1z']
}
}
}
};
export default () => (
<ThemeProvider theme={theme}>
<App/>
</ThemeProvider>
);
Editable example

#Via the icon directly

Editable example

#Sizes

Change the size of an icon with the fontSize prop.

Editable example

#Colors

Change the color of an icon with the color prop. It can be any color from the palette, or any other color like #ff0000 or red.

Editable example

#Usage in text

To use icons with text, you can wrap them in a Flex.

This is text with an icon!
Editable example

#Icon Props

color string

Color of the icon. Can be a color from the palette, or any other color.

icon

string
  | IconDefinition
  | { viewBoxHeight: number; viewBoxWidth: number; paths?: string[]; tree?: any[]; }

The name of your icon or parsed icon.

label string

A label for the icon which can be read by screen readers. This is required if a11yHidden is false.

size string

Size of the icon.

type "font-awesome" | "font-awesome-standalone"

useOriginalFill boolean

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

style any

overrides

{
  altitudes?: AltitudesThemeConfig;
  borders?: BordersThemeConfig;
  borderRadii?: BorderRadiiThemeConfig;
  breakpoints?: {
    ...
  }; ... 35 more ...;
  Text?: TextThemeConfig;
}

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.

onLayout (event: LayoutChangeEvent) => void

Invoked on mount and layout changes with

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

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

testID string

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

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

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

#Theming

Icon.styles.base
Icon.iconSets

The icons to inject into Bumbag.

Schema

{
icons: {
iconSets: [
{
icons: Array,
prefix: string
type: string
}
]
}
}

Example

{
icons: {
iconSets: [
{
icons: [
faArrowLeft,
faArrowRight
],
prefix: 'solid-',
type: 'font-awesome'
},
{
icons: [
faIgloo
],
prefix: 'regular-',
type: 'font-awesome'
}
]
}
}
Icon.icons

A map of SVG icons.

Schema

{
icons: {
icons: {
[iconName: string]: {
viewBoxHeight: number,
viewBoxWidth: number,
paths: [string]
}
}
}
}

Example

{
icons: {
icons: {
calendar: {
viewBoxWidth: 16,
viewBoxHeight: 16,
paths: [
'M11 3c.6 0 1-.5 1-1V1c0-.6-.4-1-1-1s-1 .4-1 1v1c0 .5.4 1 1 1zm3-2h-1v1c0 1.1-.9 2-2 2s-2-.9-2-2V1H6v1c0 1.1-.9 2-2 2s-2-.9-2-2V1H1c-.6 0-1 .5-1 1v12c0 .6.4 1 1 1h13c.6 0 1-.4 1-1V2c0-.6-.5-1-1-1zM5 13H2v-3h3v3zm0-4H2V6h3v3zm4 4H6v-3h3v3zm0-4H6V6h3v3zm4 4h-3v-3h3v3zm0-4h-3V6h3v3zM4 3c.6 0 1-.5 1-1V1c0-.6-.4-1-1-1S3 .4 3 1v1c0 .5.4 1 1 1z'
]
}
}
}
}
Icon.iconNames

Icon name aliases which map to the proper icon names (so you can use ).

Note: you are able to add more, but these ones are required.

Schema

{
icons: {
iconNames: {
info: string,
warning: string,
success: string,
danger: string
[key: string]: string
}
}
}

Example

{
icons: {
iconNames: {
info: 'info-circle',
warning: 'exclamation-triangle',
success: 'check-circle',
danger: 'exclamation-circle'
}
}
}
On this page
Copyright © 2021 Jake Moxey