expo-govatar

A mobile / wasm port of Govatar

Generate funny avatars

Install

For bare React Native projects, you must ensure that you have installed and configured the expo package before continuing.

Bun

bun add @kuzulabz/expo-govatar

Yarn

yarn add @kuzulabz/expo-govatar

NPM

npm install @kuzulabz/expo-govatar

Usage

Full example

import { generateAvatar } from '@kuzulabz/govatar';

const username = 'KuzuLabz';
const base64String = await generateAvatar({username});
const imageUri = `data:image/png;base64,${base64String}`;

Web

Web requires these extra steps:

Metro Config

Add config.resolver.assetExts.push('wasm'); to your metro config file.

Load WASM

import { loadGovatarWeb, loadGovatarWebAsync } from '@kuzulabz/govatar';

// for example, in App.tsx
loadGovatarWeb();

// or asyncronously
await loadGovatarWebAsync();

API

Functions

generateAvatar({username?: string, gender?: GenderType = 'MALE'}): Promise<string>

Generate an avatar

• username<optional>: A username or text
• gender<optional>: GenderType (default: normal)
• returns: base64 string

Types

GenderType

A selectable gender:

• MALE
• FEMALE