SPARQL Studio API / SparqlEditor / SettingFieldSchema

Interface: SettingFieldSchema

Defined in: sparql-utils/src/languageServers/types.ts:28

A single configurable field in a LanguageServerSettingsSchema. The property key it is stored under may be dotted (e.g. format.tabSize) to map onto a nested settings object.

Properties

type

type: "string" | "number" | "boolean"

Defined in: sparql-utils/src/languageServers/types.ts:30

Widget/value type: checkbox, number input, or text/select.

---

title?

optional title?: string

Defined in: sparql-utils/src/languageServers/types.ts:32

Human label shown next to the field (defaults to the property key).

---

description?

optional description?: string

Defined in: sparql-utils/src/languageServers/types.ts:34

Optional helper text shown under the field.

---

default?

optional default?: string | number | boolean

Defined in: sparql-utils/src/languageServers/types.ts:36

Default value, used when no value has been applied yet and by the Reset button.

---

enum?

optional enum?: (string | number)[]

Defined in: sparql-utils/src/languageServers/types.ts:38

When set, a string field renders as a <select> of these options.

---

minimum?

optional minimum?: number

Defined in: sparql-utils/src/languageServers/types.ts:40

Bounds for number fields.

---

maximum?

optional maximum?: number

Defined in: sparql-utils/src/languageServers/types.ts:41

---

group?

optional group?: string

Defined in: sparql-utils/src/languageServers/types.ts:43

Optional section heading the field is grouped under (e.g. "Formatting").