Home > kibana-plugin-core-server > UiSettingsParams
UiSettings parameters defined by the plugins.
Signature:
export interface UiSettingsParams | Property | Type | Description |
|---|---|---|
| category | string[] |
used to group the configured setting in the UI |
| deprecation | DeprecationSettings |
optional deprecation information. Used to generate a deprecation warning. |
| description | string |
description provided to a user in UI |
| name | string |
title in the UI |
| optionLabels | Record<string, string> |
text labels for 'select' type UI element |
| options | string[] |
array of permitted values for this setting |
| readonly | boolean |
a flag indicating that value cannot be changed |
| requiresPageReload | boolean |
a flag indicating whether new value applying requires page reloading |
| type | UiSettingsType |
defines a type of UI element UiSettingsType |
| validation | ImageValidation | StringValidation |
|
| value | SavedObjectAttribute |
default value to fall back to if a user doesn't provide any |