mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-14 23:27:06 +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.
|
||
|---|---|---|
| .. | ||
| admin_notices | ||
| discourse_id | ||
| experiments | ||
| flags | ||
| notifications | ||
| problem_check | ||
| site_setting | ||
| spam_rule | ||
| themes | ||
| user | ||
| anonymous_shadow_creator.rb | ||
| badge_granter.rb | ||
| base_bookmarkable.rb | ||
| category_hashtag_data_source.rb | ||
| color_scheme_revisor.rb | ||
| destroy_task.rb | ||
| email_settings_exception_handler.rb | ||
| email_settings_validator.rb | ||
| email_style_updater.rb | ||
| external_upload_manager.rb | ||
| group_action_logger.rb | ||
| group_mentions_updater.rb | ||
| group_message.rb | ||
| handle_chunk_upload.rb | ||
| hashtag_autocomplete_service.rb | ||
| heat_settings_updater.rb | ||
| inline_uploads.rb | ||
| notification_emailer.rb | ||
| post_action_notifier.rb | ||
| post_alerter.rb | ||
| post_bookmarkable.rb | ||
| post_owner_changer.rb | ||
| push_notification_pusher.rb | ||
| random_topic_selector.rb | ||
| registered_bookmarkable.rb | ||
| search_indexer.rb | ||
| sidebar_section_links_updater.rb | ||
| sidebar_site_settings_backfiller.rb | ||
| site_setting_update_existing_users.rb | ||
| site_settings_task.rb | ||
| staff_action_logger.rb | ||
| tag_hashtag_data_source.rb | ||
| theme_settings_migrations_runner.rb | ||
| themes_install_task.rb | ||
| topic_bookmarkable.rb | ||
| topic_status_updater.rb | ||
| topic_timestamp_changer.rb | ||
| tracked_topics_updater.rb | ||
| trust_level_granter.rb | ||
| user_action_manager.rb | ||
| user_activator.rb | ||
| user_anonymizer.rb | ||
| user_authenticator.rb | ||
| user_destroyer.rb | ||
| user_merger.rb | ||
| user_notification_renderer.rb | ||
| user_notification_schedule_processor.rb | ||
| user_password_expirer.rb | ||
| user_silencer.rb | ||
| user_stat_count_updater.rb | ||
| user_suspender.rb | ||
| user_updater.rb | ||
| username_changer.rb | ||
| username_checker_service.rb | ||
| web_hook_emitter.rb | ||
| wildcard_domain_checker.rb | ||
| wildcard_url_checker.rb | ||
| word_watcher.rb | ||
