FocusOverlayOptions

Defined in: ui/Input.ts:79

Focus overlay configuration for mobile/touch interactions FocusOverlayOptions

Example

const overlaySettings = {
  activeFilter: ['mobile', 'touch'],
  marginTop: 60,
  scale: 2.5,
  backing: { active: true, color: 0x0 }
};

Properties

activeFilter?

optional activeFilter: boolean | () => boolean | ("mobile" | "touch" | "desktop")[]

Defined in: ui/Input.ts:85

Custom filter for when to show overlay

---

backing

backing: object

Defined in: ui/Input.ts:91

Backing configuration

active

active: boolean

options

options: Partial<ColorOptions>

---

desktop

desktop: boolean

Defined in: ui/Input.ts:83

---

marginTop

marginTop: number

Defined in: ui/Input.ts:89

Top margin for the overlay

---

mobile

mobile: boolean

Defined in: ui/Input.ts:81

Enable overlay for specific platforms

---

scale

scale: number

Defined in: ui/Input.ts:87

Scale factor for the overlay

---

touch

touch: boolean

Defined in: ui/Input.ts:82