2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2026-03-04 01:15:08 +08:00
discourse/app/serializers/theme_serializer.rb
Yuriy Kurant db10d595e7
FEATURE: enhance screenshot support for themes with dark/light modes (#36422)
Enable theme cards to show dark and light mode screenshots.

### Context
Prior to this change, a single screenshot was displayed only.

### Changes
* introduce separate fields: `screenshot_light_url` and
`screenshot_dark_url`
* displays both screenshots (horizontally scrollable)
* limits display of screenshots to the files named `light` and `dark`
only

### Result


https://github.com/user-attachments/assets/4d845f32-9120-49b8-8f05-ba7790ce1629

---------

Co-authored-by: Yuriy Kurant <yuriy@discourse.org>
2025-12-10 11:23:21 +10:00

108 lines
2.9 KiB
Ruby

# frozen_string_literal: true
require "base64"
class ThemeSerializer < BasicThemeSerializer
attributes :color_scheme_id,
:dark_color_scheme_id,
:user_selectable,
:auto_update,
:remote_theme_id,
:settings,
:themeable_site_settings,
:errors,
:supported?,
:enabled?,
:disabled_at,
:theme_fields,
:screenshot_dark_url,
:screenshot_light_url,
:system
has_one :color_scheme, serializer: ColorSchemeSerializer, embed: :object
has_one :user, serializer: UserNameSerializer, embed: :object
has_one :disabled_by, serializer: UserNameSerializer, embed: :object
has_many :child_themes, serializer: BasicThemeSerializer, embed: :objects
has_many :parent_themes, serializer: BasicThemeSerializer, embed: :objects
has_one :remote_theme, serializer: RemoteThemeSerializer, embed: :objects
has_many :translations, serializer: ThemeTranslationSerializer, embed: :objects
def initialize(theme, options = {})
super
@include_theme_field_values = options[:include_theme_field_values] || false
@errors = []
object.theme_fields.each { |o| @errors << o.error if o.error }
end
def theme_fields
ActiveModel::ArraySerializer.new(
object.theme_fields,
each_serializer: ThemeFieldSerializer,
include_value: include_theme_field_values?,
).as_json
end
def include_theme_field_values?
# This is passed into each `ThemeFieldSerializer` to determine if `value` will be serialized.
# We only want to serialize if we are viewing staff_action_logs (for diffing changes), or if
# the theme is a local theme, so the saved values appear in the theme field editor.
@include_theme_field_values || object.remote_theme_id.nil?
end
def child_themes
object.child_themes
end
def parent_themes
object.parent_themes
end
def settings
object.settings.map do |_name, setting|
ThemeSettingsSerializer.new(setting, scope:, root: false)
end
rescue ThemeSettingsParser::InvalidYaml => e
@errors << e.message
nil
end
# Components always return an empty array here
def themeable_site_settings
# UI for editing settings always expects the value + default to be a string
# to compare whether the setting has been changed or not.
object.themeable_site_settings.each do |tss|
tss[:default] = tss[:default].to_s
tss[:value] = tss[:value].to_s
end
end
def include_themeable_site_settings?
!object.component?
end
def include_child_themes?
!object.component?
end
def errors
@errors
end
def include_errors?
@errors.present?
end
def include_disabled_at?
object.component? && !object.enabled?
end
def include_disabled_by?
include_disabled_at?
end
def system
object.system?
end
end