Skip to content

Separate HtmlBlockMixin base to use in About, StaticTab, CourseInfo #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
salman2013 merged 6 commits into from
Dec 30, 2025
Merged

Separate HtmlBlockMixin base to use in About, StaticTab, CourseInfo #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
23abea7
chore: separate htmlblockmixin base
salman2013 Dec 15, 2025
a620dd0
fix: fix quality issues
salman2013 Dec 15, 2025
50c1d82
fix: fix quality issues
salman2013 Dec 15, 2025
3ea0136
fix: fix import
salman2013 Dec 15, 2025
c2a6482
fix: remove unused pylint warning
salman2013 Dec 30, 2025
a06972c
fix: quality issue
salman2013 Dec 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion xblocks_contrib/html/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
Init for the HtmlBlock.
"""

from .html import HtmlBlock
from .html import HtmlBlock, HtmlBlockMixin
16 changes: 12 additions & 4 deletions xblocks_contrib/html/html.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,13 +143,12 @@ def stringify_children(node):
# This makes our block more resilient. It won't crash in test environments
# where the user service might not be available.
@XBlock.wants("user")
class HtmlBlock(LegacyXmlMixin, XBlock):
class HtmlBlockMixin(LegacyXmlMixin, XBlock):
"""
The HTML XBlock.
The HTML XBlock mixin.
This provides the base class for all Html-ish blocks (including the HTML XBlock).
"""

# Indicates that this XBlock has been extracted from edx-platform.
is_extracted = True
display_name = String(
display_name=_("Display Name"),
help=_("The display name for this component."),
Expand Down Expand Up @@ -565,3 +564,12 @@ def definition_to_xml(self, resource_fs):
def non_editable_metadata_fields(self):
"""`use_latex_compiler` should not be editable in the Studio settings editor."""
return super().non_editable_metadata_fields + [HtmlBlock.xml_attributes, HtmlBlock.use_latex_compiler]


class HtmlBlock(HtmlBlockMixin): # pylint: disable=abstract-method
"""
The HTML XBlock.
"""

# Indicates that this XBlock has been extracted from edx-platform.
is_extracted = True