mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-01 04:07:14 +08:00
19af83d39e
This commit introduces the concept of themeable site settings,
which is a new tool for theme authors that lives alongside theme
modifiers and theme settings. Here is a quick summary:
* Theme settings - These are custom settings used to control UI and functionality within your theme or component and provide configuration options. These cannot change core Discourse functionality.
* Theme modifiers - Allows a theme or a component to modify selected server-side functionality of core Discourse as an alternative to building a plugin.
* Themeable site settings (new) - Allows a theme (not components) to override a small subset of core site settings, which generally control parts of the UI and other minor functionality. This allows themes to have a greater control over the full site experience.
Themeable site settings will be shown for all themes, whether the theme
changes
the value or not, and have a similar UI to custom theme settings.
We are also introducing a new page at
`/admin/config/theme-site-settings` that
allows admins to see all possible themeable site settings, and which
themes
are changing the value from the default.
### Configuration
Theme authors can configure initial values themeable site settings using
a section in the `about.json` file like so:
```json
"theme_site_settings": {
"search_experience": "search_field"
}
```
These values will not change when the theme updates, because we cannot
know if admins have manually changed them.
### Limitations
Themeable site settings are only really intended to control elements of
the UI, and when retrieving their value we require a theme ID, so these
limitations apply:
- Themeable site settings cannot be used in Sidekiq jobs
- Themeable site settings cannot be used in markdown rules
- Themeable site settings will be cached separately to client site
settings using theme ID as a key
- Themeable site settings will override keys on the `siteSettings`
service on the client using the application preloader
- `SiteSetting.client_settings_json` will not include themeable site
settings, instead you can call `SiteSetting.theme_site_settings_json`
with a theme ID
### Initial settings
There are only two site settings that will be themeable to begin with:
* `enable_welcome_banner`
* `search_experience`
And our new Horizon theme will take advantage of both. Over time, more
settings that control elements of the UI will be exposed this way.
62 lines
2.1 KiB
Ruby
62 lines
2.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# Responsible for resolving all possible theme site settings for
|
|
# a given theme, including details about the setting type, valid values,
|
|
# and description, for use in the theme editor.
|
|
#
|
|
# The value of the setting will either be the value stored in the
|
|
# ThemeSiteSetting table, or the default value of the site setting.
|
|
#
|
|
# Example output for a single setting, there will be an array of these:
|
|
#
|
|
# {
|
|
# :setting=>:search_experience,
|
|
# :default=>"search_icon",
|
|
# :description=>"The default position and appearance of search on desktop devices",
|
|
# :type=>"enum",
|
|
# :valid_values=>[
|
|
# {
|
|
# :name=>"search.experience.search_field", :value=>"search_field"
|
|
# }, {
|
|
# :name=>"search.experience.search_icon", :value=>"search_icon"
|
|
# }
|
|
# ],
|
|
# :translate_names=>true,
|
|
# :value=>"search_icon"
|
|
# }
|
|
class ThemeSiteSettingResolver
|
|
attr_reader :theme
|
|
|
|
def initialize(theme:)
|
|
@theme = theme
|
|
end
|
|
|
|
def resolved_theme_site_settings
|
|
stored_theme_site_settings =
|
|
theme.theme_site_settings.to_a.select do |setting|
|
|
setting.name.to_sym.in?(SiteSetting.themeable_site_settings)
|
|
end
|
|
|
|
SiteSetting
|
|
.themeable_site_settings
|
|
.each_with_object([]) do |setting, settings|
|
|
setting_hash = SiteSetting.setting_metadata_hash(setting)
|
|
|
|
# If the setting has been saved in the DB, it means the theme has changed
|
|
# it in about.json on import, or the admin has changed it manually later on.
|
|
stored_setting =
|
|
stored_theme_site_settings.find { |db_setting| db_setting.name == setting.to_s }
|
|
if !stored_setting.nil?
|
|
setting_hash[:value] = stored_setting.setting_rb_value
|
|
else
|
|
# Otherwise if there is no value in the DB, we use the default value of
|
|
# the site setting, since we do not insert a DB value if the about.json
|
|
# value is the same as the default site setting value.
|
|
setting_hash[:value] = setting_hash[:default]
|
|
end
|
|
|
|
settings << setting_hash
|
|
end
|
|
.sort_by { |setting_hash| setting_hash[:setting] }
|
|
end
|
|
end
|
