react-native-starsystem/dist/Avatar/Avatar.d.ts

Starbem React Native UI Toolkit

import React from 'react';
import { StyleProp, ViewStyle, TextStyle, ImageSourcePropType, ImageStyle } from 'react-native';
import { StarFunctionComponent } from '../helpers';
import { IconObject } from '../Icon';
import { ImageProps } from '../Image';
export declare const avatarSizes: {
    small: number;
    medium: number;
    large: number;
    xlarge: number;
};
declare type AvatarIcon = IconObject & {
    iconStyle?: StyleProp<TextStyle>;
};
export declare type AvatarProps = {
    /** Component for enclosing element (eg: TouchableHighlight, View, etc). */
    Component?: typeof React.Component;
    /** Callback function when pressing component. */
    onPress?(): void;
    /** Callback function when long pressing component. */
    onLongPress?(): void;
    /** Styling for outer container. */
    containerStyle?: StyleProp<ViewStyle>;
    /** Image source to be displayed on avatar. */
    source?: ImageSourcePropType;
    /** Style for avatar image. */
    avatarStyle?: ImageStyle;
    /** Makes the avatar circular. */
    rounded?: boolean;
    /** Renders title in the placeholder. */
    title?: string;
    /** Style for the title. */
    titleStyle?: StyleProp<TextStyle>;
    /** Style for the view outside image or icon. */
    overlayContainerStyle?: StyleProp<TextStyle>;
    /** Opacity when pressed. */
    activeOpacity?: number;
    /** Displays an icon as the main content of the Avatar. **Cannot be used alongside title**. When used with the `source` prop it will be used as the placeholder. */
    icon?: AvatarIcon;
    /** Extra styling for icon component. */
    iconStyle?: StyleProp<TextStyle>;
    /** Size of the avatar. */
    size?: ('small' | 'medium' | 'large' | 'xlarge') | number;
    /** Adds style to the placeholder wrapper. */
    placeholderStyle?: StyleProp<ViewStyle>;
    /** Custom placeholder element (by default, it's the title). */
    renderPlaceholderContent?: React.ReactElement<{}>;
    /** Optional properties to pass to the avatar e.g "resizeMode". */
    imageProps?: Partial<ImageProps>;
    /** Custom ImageComponent for Avatar. */
    ImageComponent?: React.ComponentClass;
};
export declare const Avatar: StarFunctionComponent<AvatarProps>;
export {};