Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-24 07:30:12 +01:00
Code Issues Releases Wiki Activity

Harmonized color and font settings for social cards with Insiders

Browse Source
This commit is contained in:
squidfunk 2023-05-08 16:59:16 +02:00
parent 2735c87d9a
commit 09feabc579
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
2 changed files with 74 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
material/plugins/social/plugin.py
View File

@ -58,8 +58,17 @@ class SocialPluginConfig(Config):
# Options for social cards # Options for social cards
cards = opt.Type(bool, default = True) cards = opt.Type(bool, default = True)
cards_dir = opt.Type(str, default = "assets/images/social") cards_dir = opt.Type(str, default = "assets/images/social")
cards_color = opt.Type(dict, default = dict()) cards_layout_options = opt.Type(dict, default = {})
cards_font = opt.Optional(opt.Type(str))
# Deprecated options
cards_color = opt.Deprecated(
message =
"Deprecated, use 'cards_layout_options.background_color' "
"and 'cards_layout_options.color' with 'default' layout"
)
cards_font = opt.Deprecated(
message = "Deprecated, use 'cards_layout_options.font_family'"
)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ -76,6 +85,24 @@ class SocialPlugin(BasePlugin[SocialPluginConfig]):
if not self.config.cards: if not self.config.cards:
return return
# Move color options
if "cards_color" in self.config:
# Move background color to new option
value = self.config.cards_color.get("fill")
if value:
self.config.cards_layout_options["background_color"] = value
# Move color to new option
value = self.config.cards_color.get("text")
if value:
self.config.cards_layout_options["color"] = value
# Move font family to new option
if "cards_font" in self.config:
value = self.config.cards_font
self.config.cards_layout_options["font_family"] = value
# Check if required dependencies are installed # Check if required dependencies are installed
if not dependencies: if not dependencies:
log.error( log.error(
@ -111,7 +138,13 @@ class SocialPlugin(BasePlugin[SocialPluginConfig]):
self.color = colors.get(primary, self.color) self.color = colors.get(primary, self.color)
# Retrieve color overrides # Retrieve color overrides
self.color = { **self.color, **self.config.cards_color } self.color = {
**self.color,
**{
"fill": self.config.cards_layout_options.get("background_color"),
"text": self.config.cards_layout_options.get("color")
}
}
# Retrieve custom_dir path # Retrieve custom_dir path
for user_config in config.user_configs: for user_config in config.user_configs:
@ -406,7 +439,7 @@ class SocialPlugin(BasePlugin[SocialPluginConfig]):
# Retrieve font # Retrieve font
def _load_font(self, config): def _load_font(self, config):
name = self.config.cards_font name = self.config.cards_layout_options.get("font_family")
if not name: if not name:
# Retrieve from theme (default: Roboto) # Retrieve from theme (default: Roboto)

41
src/plugins/social/plugin.py
View File

@ -58,8 +58,17 @@ class SocialPluginConfig(Config):
# Options for social cards # Options for social cards
cards = opt.Type(bool, default = True) cards = opt.Type(bool, default = True)
cards_dir = opt.Type(str, default = "assets/images/social") cards_dir = opt.Type(str, default = "assets/images/social")
cards_color = opt.Type(dict, default = dict()) cards_layout_options = opt.Type(dict, default = {})
cards_font = opt.Optional(opt.Type(str))
# Deprecated options
cards_color = opt.Deprecated(
message =
"Deprecated, use 'cards_layout_options.background_color' "
"and 'cards_layout_options.color' with 'default' layout"
)
cards_font = opt.Deprecated(
message = "Deprecated, use 'cards_layout_options.font_family'"
)
# ----------------------------------------------------------------------------- # -----------------------------------------------------------------------------
@ -76,6 +85,24 @@ class SocialPlugin(BasePlugin[SocialPluginConfig]):
if not self.config.cards: if not self.config.cards:
return return
# Move color options
if "cards_color" in self.config:
# Move background color to new option
value = self.config.cards_color.get("fill")
if value:
self.config.cards_layout_options["background_color"] = value
# Move color to new option
value = self.config.cards_color.get("text")
if value:
self.config.cards_layout_options["color"] = value
# Move font family to new option
if "cards_font" in self.config:
value = self.config.cards_font
self.config.cards_layout_options["font_family"] = value
# Check if required dependencies are installed # Check if required dependencies are installed
if not dependencies: if not dependencies:
log.error( log.error(
@ -111,7 +138,13 @@ class SocialPlugin(BasePlugin[SocialPluginConfig]):
self.color = colors.get(primary, self.color) self.color = colors.get(primary, self.color)
# Retrieve color overrides # Retrieve color overrides
self.color = { **self.color, **self.config.cards_color } self.color = {
**self.color,
**{
"fill": self.config.cards_layout_options.get("background_color"),
"text": self.config.cards_layout_options.get("color")
}
}
# Retrieve custom_dir path # Retrieve custom_dir path
for user_config in config.user_configs: for user_config in config.user_configs:
@ -406,7 +439,7 @@ class SocialPlugin(BasePlugin[SocialPluginConfig]):
# Retrieve font # Retrieve font
def _load_font(self, config): def _load_font(self, config):
name = self.config.cards_font name = self.config.cards_layout_options.get("font_family")
if not name: if not name:
# Retrieve from theme (default: Roboto) # Retrieve from theme (default: Roboto)