This is documentation for the next SDK version. For up-to-date documentation, see the latest version (SDK 52).
Expo SymbolsA library that allows access to native symbols.
This library is currently in beta and subject to breaking changes.
expo-symbols provides access to the SF Symbols library on iOS.
Installation
- npx expo install expo-symbolsIf you are installing this in an existing React Native app, start by installing expo in your project. Then, follow the additional instructions as mentioned by the library's README under "Installation in bare React Native projects" section.
Usage
import { SymbolView, SymbolViewProps, SFSymbol } from 'expo-symbols';
import { StyleSheet, View } from 'react-native';
export default function App() {
return (
<View style={styles.container}>
<SymbolView name="airpods.chargingcase" style={styles.symbol} type="hierarchical" />
</View>
);
}
const styles = StyleSheet.create({
container: {
flex: 1,
backgroundColor: '#fff',
alignItems: 'center',
justifyContent: 'center',
},
symbol: {
width: 35,
height: 35,
margin: 5,
},
});
API
import { SymbolView } from 'expo-symbols';
Component
SymbolView
Type: React.Element<SymbolViewProps>
colors
string | string[] | nullAn array of colors to use when the SymbolType is palette.
fallback
React.ReactNodeFallback to render on Android and Web where SF Symbols are not available.
resizeMode
ContentMode • Default: 'scaleToAspectFit'Determines how the image should be resized to fit its container.
Inherited Props
Types
AnimationEffect
| Name | Type | Description |
|---|---|---|
| direction (optional) | 'up' | 'down' | The direction of the animation. |
| type | AnimationType | The type of animation to apply to the symbol. |
| wholeSymbol (optional) | boolean | Whether the entire symbol should animate or just the individual layers. Default: false |
AnimationSpec
The animation configuration to apply to the symbol.
| Name | Type | Description |
|---|---|---|
| effect (optional) | AnimationEffect | The effect to apply to the symbol. |
| repeatCount (optional) | number | The number of times the animation should repeat. |
| repeating (optional) | boolean | If the animation should repeat. |
| speed (optional) | number | The duration of the animation in seconds. |
| variableAnimationSpec (optional) | VariableAnimationSpec | An object that specifies how the symbol’s layers should animate. |
AnimationType
Literal Type: string
The type of animation to apply to the symbol.
Acceptable values are: 'bounce' | 'pulse' | 'scale'
ContentMode
Literal Type: string
Determines how the image should be resized to fit its container.
Acceptable values are: 'scaleToFill' | 'scaleAspectFit' | 'scaleAspectFill' | 'redraw' | 'center' | 'top' | 'bottom' | 'left' | 'right' | 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight'
SymbolScale
Literal Type: string
The scale of the symbol to render.
Acceptable values are: 'default' | 'unspecified' | 'small' | 'medium' | 'large'
SymbolType
Literal Type: string
Determines the symbol variant to use.
-
'monochrome'- Creates a color configuration that specifies that the symbol image uses its monochrome variant. -
'hierarchical'- Creates a color configuration with a color scheme that originates from one color. -
'palette'- Creates a color configuration with a color scheme from a palette of multiple colors. -
'multicolor'- Creates a color configuration that specifies that the symbol image uses its multicolor variant, if one exists.
Acceptable values are: 'monochrome' | 'hierarchical' | 'palette' | 'multicolor'
SymbolWeight
Literal Type: string
The weight of the symbol to render.
Acceptable values are: 'unspecified' | 'ultraLight' | 'thin' | 'light' | 'regular' | 'medium' | 'semibold' | 'bold' | 'heavy' | 'black'
VariableAnimationSpec
A variable color animation draws attention to a symbol by changing the opacity of the symbol’s layers.
You can choose to apply the effect to layers either cumulatively or iteratively.
For cumulative animations, each layer’s opacity remains changed until the end of the animation cycle.
For iterative animations, each layer’s opacity changes briefly before returning to its original state.
These effects are compounding, each value set to true will add an additional effect.
| Name | Type | Description |
|---|---|---|
| cumulative (optional) | boolean | This effect enables each successive variable layer, and the layer remains enabled until the end of the animation cycle. This effect cancels the iterative variant. |
| dimInactiveLayers (optional) | boolean | An effect that dims inactive layers of a symbol. This effect draws inactive layers with reduced, but nonzero, opacity. |
| hideInactiveLayers (optional) | boolean | An effect that hides inactive layers of a symbol. This effect hides inactive layers completely, rather than drawing them with reduced, but nonzero, opacity. |
| iterative (optional) | boolean | An effect that momentarily enables each layer of a symbol in sequence. |
| nonReversing (optional) | boolean | An effect that doesn’t reverse each time it repeats. |
| reversing (optional) | boolean | An effect that reverses each time it repeats. |