@usenavii/core 0.3.0 → 0.4.0

package/README.md

@@ -64,6 +64,7 @@ It picks the most unique field automatically: `id` → `email` → `name + creat
 
 ```ts
 createAvatar(seed: string, options?: AvatarOptions): string
+random(options?: AvatarOptions): { svg: string; seed: string }
 selectAvatar(seed: string, options?: AvatarOptions): AvatarSpec
 renderAvatar(spec:  AvatarSpec, options?: AvatarOptions): string
 renderGroup(seeds:  string[],   options?: GroupOptions):  string
@@ -71,7 +72,7 @@ renderGroup(seeds:  string[],   options?: GroupOptions):  string
 seed(fields:  SeedFields): string         // pick most-unique field
 build(spec?:  BuildSpec, opts?): string   // manual mix-and-match (no seed)
 
-Navii.{ create, render, select, group, seed, build }
+Navii.{ create, random, render, select, group, seed, build }
 ```
 
 ### `AvatarOptions`
@@ -85,6 +86,22 @@ Navii.{ create, render, select, group, seed, build }
 | `title`      | accessible label (sets `<title>` + `aria-label`)      | none         |
 | `animated`   | `boolean` — idle float / blink / sway / pulse / twinkle | `false`    |
 
+### `random()` — pick a seed for you
+
+For "spin again" UX, onboarding before the user picks an avatar, dev/demo seeding. Returns the chosen seed so you can persist it:
+
+```ts
+const { svg, seed } = Navii.random({ size: 96 });
+await db.users.update(user.id, { naviiSeed: seed });
+```
+
+Calling `random()` in a React render gives a new avatar every re-render. Stabilize with `useState`:
+
+```tsx
+const [{ seed }] = useState(() => Navii.random());
+return <Navii seed={seed} />;
+```
+
 ### `build()` — direct construction without a seed
 
 Use for brand mascots, logo marks, designer-curated avatars:

package/dist/index.cjs

@@ -950,8 +950,18 @@ function createAvatar(seed2, options = {}) {
   }
   return renderAvatar(selectAvatar(seed2, options), options);
 }
+function random(options = {}) {
+  const seed2 = randomSeed();
+  return { svg: createAvatar(seed2, options), seed: seed2 };
+}
+function randomSeed() {
+  const c = globalThis.crypto;
+  if (c && typeof c.randomUUID === "function") return c.randomUUID();
+  return Math.random().toString(36).slice(2) + Math.random().toString(36).slice(2);
+}
 var Navii = {
   create: createAvatar,
+  random,
   render: renderAvatar,
   select: selectAvatar,
   group: renderGroup,
@@ -964,6 +974,7 @@ exports.build = build;
 exports.createAvatar = createAvatar;
 exports.createRng = createRng;
 exports.cyrb53 = cyrb53;
+exports.random = random;
 exports.renderAvatar = renderAvatar;
 exports.renderAvatarInner = renderAvatarInner;
 exports.renderGroup = renderGroup;