netbox/netbox/netbox/preferences.py

83 lines
2.3 KiB
Python

from django.conf import settings
from django.utils.translation import gettext as _
from netbox.registry import registry
from users.preferences import UserPreference
from utilities.paginator import EnhancedPaginator
def get_page_lengths():
return [
(v, str(v)) for v in EnhancedPaginator.default_page_lengths
]
PREFERENCES = {
# User interface
'ui.colormode': UserPreference(
label=_('Color mode'),
choices=(
('light', _('Light')),
('dark', _('Dark')),
),
default='light',
description=_('Preferred default UI theme')
),
'ui.htmx_navigation': UserPreference(
label=_('HTMX Navigation'),
choices=(
('', _('Disabled')),
('true', _('Enabled')),
),
description=_('Enable dynamic UI navigation'),
default=False,
experimental=True
),
'locale.language': UserPreference(
label=_('Language'),
choices=(
('', _('Auto')),
*settings.LANGUAGES,
),
description=_('Forces UI translation to the specified language.')
),
'pagination.per_page': UserPreference(
label=_('Page length'),
choices=get_page_lengths(),
description=_('The default number of objects to display per page'),
coerce=lambda x: int(x)
),
'pagination.placement': UserPreference(
label=_('Paginator placement'),
choices=(
('bottom', _('Bottom')),
('top', _('Top')),
('both', _('Both')),
),
default='bottom',
description=_('Where the paginator controls will be displayed relative to a table')
),
# Miscellaneous
'data_format': UserPreference(
label=_('Data format'),
choices=(
('json', 'JSON'),
('yaml', 'YAML'),
),
description=_('The preferred syntax for displaying generic data within the UI')
),
}
# Register plugin preferences
if registry['plugins']['preferences']:
plugin_preferences = {}
for plugin_name, preferences in registry['plugins']['preferences'].items():
for name, userpreference in preferences.items():
PREFERENCES[f'plugins.{plugin_name}.{name}'] = userpreference
PREFERENCES.update(plugin_preferences)