Expand description
Settings widgets.
Structs§
- Categories
List Args - Arguments for a widget function that makes a list of category items that can be selected.
- Category
Header Args - Arguments for a widget function that makes a category header in a settings list.
- Category
Item Args - Arguments for a widget function that makes a category item for a categories list.
- Panel
Args - Arguments for the entire settings editor layout.
- Setting
Args - Arguments for a widget function that makes a setting container.
- Settings
Args - Arguments for a widget function that makes a settings for a category list.
- Settings
Editor W
Settings editor widget.- Settings
Editor State - Represents the current settings data.
- Settings
Search Args - Arguments for a search box widget.
Statics§
- CATEGORIES_
LIST_ FN_ VAR - Categories list.
- CATEGORY_
HEADER_ FN_ VAR - Category header on the settings list.
- CATEGORY_
ITEM_ FN_ VAR - Category in a category list.
- PANEL_
FN_ VAR - Editor layout.
- SETTINGS_
FN_ VAR - Settings list for a category.
- SETTINGS_
SEARCH_ FN_ VAR - Settings search area.
- SETTING_
FN_ VAR - Setting item.
Traits§
- Setting
Builder Editor Ext - Extends
SettingBuilder
to set custom editor metadata. - Setting
Editor Ext - Extends
Setting
to get custom editor metadata. - Settings
CtxExt - Extends
SETTINGS
to provide contextual information in an editor. - Widget
Info Setting Ext - Extends
WidgetInfo
to provide the setting config key for setting widgets.
Functions§
- categories_
list_ fn P
Widget function that convertsCategoriesListArgs
to a category list.- category_
header_ fn P
Widget function that convertsCategoryHeaderArgs
to a category settings header.- category_
item_ fn P
Widget function that convertsCategoryItemArgs
to a category item on a category list.- default_
categories_ list_ fn - Default categories list view on
actual_width > 400
. - default_
categories_ list_ mobile_ fn - Default categories list view on
actual_width <= 400
. - default_
category_ header_ fn - Default category item view.
- default_
category_ item_ fn - Default category item view.
- default_
panel_ fn - Default editor layout on
actual_width > 400
. - default_
panel_ mobile_ fn - Default editor layout on
actual_width <= 400
. - default_
setting_ fn - Default setting item view.
- default_
settings_ fn - Default settings for a category view.
- default_
settings_ search_ fn - Default settings search box.
- handle_
settings_ cmd - Set a
SETTINGS_CMD
handler that shows the settings window. - panel_
fn P
Widget that defines the editor layout, bringing together the other component widgets.- save_
state P
Save and restore settings search and selected category.- setting
P
Identifies thesetting_fn
widget.- setting_
fn P
Widget function that convertsSettingArgs
to a setting editor entry on a settings list.- settings_
editor_ node - Implements the
SettingsEditor!
inner widgets. - settings_
fn P
Widget function that convertsSettingsArgs
to a settings list.- settings_
search_ fn P
Widget function that convertsSettingsSearchArgs
to a search box.