GTKX

API Reference / @gtkx/react / index / useSetting

Function: useSetting() ​

useSetting<K, P, V>(settings, schema, key): [SettingValue<K, P, V>, (value) => void]

Defined in: packages/react/src/hooks/use-setting.ts:17

Reads and writes a single key of a GSettings schema, re-rendering when the stored value changes.

Type Parameters ​

K ​

K extends SettingsSchemaKeys

P ​

P extends string | number | symbol

V ​

V extends SettingsSchemaValues = Record<never, never>

Parameters ​

settings ​

Settings

schema ​

SettingsSchema<K, V>

key ​

P & string

Returns ​

[SettingValue<K, P, V>, (value) => void]

The current value, and a setter that writes a new one back to GSettings.

Throws ​

When the key is not declared in the schema.