API Reference / @gtkx/react / SchemaRef

Type Alias: SchemaRef<K>

SchemaRef<K> = object

Defined in: react/dist/hooks/use-setting.d.ts:5

A typed reference to a GSettings schema: its id, path, and the mapping of typed keys to their setting names.

Type Parameters

K

K extends object = Record<string, unknown>

Properties

__keys__?

optional __keys__?: K

Defined in: react/dist/hooks/use-setting.d.ts:14

Phantom field carrying the value type K; never populated at runtime.

---

id

id: string

Defined in: react/dist/hooks/use-setting.d.ts:6

---

keys

keys: { [P in keyof K]: string }

Defined in: react/dist/hooks/use-setting.d.ts:10

Maps each typed key of K to its corresponding GSettings key name.

---

path

path: string | null

Defined in: react/dist/hooks/use-setting.d.ts:8

The schema's object path, or null to use the schema's default path.