UseFingerprintOptions

Defined in: packages/fingerprint/src/react/useFingerprint.ts:17

What useFingerprint takes.

Properties

dimensions

dimensions: readonly Dimension[]

Defined in: packages/fingerprint/src/react/useFingerprint.ts:21

Every dimension the items carry values for.

---

form?

optional form?: Partial<FingerprintForm>

Defined in: packages/fingerprint/src/react/useFingerprint.ts:30

Overrides fields of the form formFromItems derives from the data.

---

initialViewId?

optional initialViewId?: string

Defined in: packages/fingerprint/src/react/useFingerprint.ts:28

The view shown first. Defaults to the first.

---

items

items: readonly Item[]

Defined in: packages/fingerprint/src/react/useFingerprint.ts:19

One per mark (below the cap), unique ids. Treated as immutable: pass a new array to change it.

---

maxMarks?

optional maxMarks?: number

Defined in: packages/fingerprint/src/react/useFingerprint.ts:34

Above this many items, marks stand for several. Defaults to 600.

---

seed?

optional seed?: string

Defined in: packages/fingerprint/src/react/useFingerprint.ts:32

Seeds the form’s free fields. Same seed, same picture. Defaults to “fingerprint”.

---

unit?

optional unit?: string

Defined in: packages/fingerprint/src/react/useFingerprint.ts:36

What one item is, for the description and announcements. Defaults to “items”.

---

views?

optional views?: readonly View[]

Defined in: packages/fingerprint/src/react/useFingerprint.ts:26

The ways of looking, in switcher order. Defaults to one view per dimension, each driving colour, shape and arrangement from that dimension alone.