# Lorelei

- Page: https://jiguang132.com/resources/dicebear/docs/lorelei
- Resource: DiceBear (https://jiguang132.com/resources/dicebear.md)
- All guides: https://jiguang132.com/resources/dicebear/docs.md

Line-art portraits with detailed hair, freckles and accessories.

## Install

```bash
npm install @dicebear/core@9.4.2 @dicebear/collection@9.4.2
```

## Generate an avatar

The same seed always produces the same avatar, so a user ID or username works as a seed. Avatars are generated locally without a network service.

```ts
import { createAvatar } from '@dicebear/core';
import { lorelei } from '@dicebear/collection';

// “Lorelei” by Lisa Wischofsky, CC0 1.0
const avatar = createAvatar(lorelei, {
  seed: 'Aria Chen',
  size: 128,
  radius: 50,
});

export const svg = avatar.toString();     // inline SVG markup
export const dataUri = avatar.toDataUri(); // use as an <img> src
```

React component:

```tsx
import { useMemo } from 'react';
import { createAvatar } from '@dicebear/core';
import { lorelei } from '@dicebear/collection';

export function UserAvatar({ seed, size = 64 }: { seed: string; size?: number }) {
  const src = useMemo(() => createAvatar(lorelei, { seed, size }).toDataUri(), [seed, size]);
  return <img src={src} width={size} height={size} alt={`Avatar for ${seed}`} />;
}
```

## Options

Common options: `seed`, `size`, `radius`, `backgroundColor`, `flip`, `rotate`, `scale`.

Style options: `beard`, `beardProbability`, `earrings`, `earringsColor`, `earringsProbability`, `eyebrows`, `eyebrowsColor`, `eyes`, `eyesColor`, `freckles`, `frecklesColor`, `frecklesProbability`, `glasses`, `glassesColor`, `glassesProbability`, `hair`, `hairAccessories`, `hairAccessoriesColor`, `hairAccessoriesProbability`, `hairColor`, `head`, `mouth`, `mouthColor`, `nose`, `noseColor`, `skinColor`.

Full option reference: https://www.dicebear.com/styles/lorelei/

## License and attribution

- Design: Lorelei — Lisa Wischofsky (https://www.figma.com/community/file/1198749693280469639)
- License: CC0 1.0 (https://creativecommons.org/publicdomain/zero/1.0/)
- CC0 1.0: free to use without attribution.
- The DiceBear software is MIT. Its license does not cover the style artwork. Generated SVGs carry license metadata by default; keep it.

---

Index of all JGuang resources: https://jiguang132.com/llms.txt
