Skip to content
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.

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

N°7793 Add common SCSS variables between backoffice and end-user portal #674

Draft
wants to merge 1 commit into
base: support/3.2
Choose a base branch
from

Conversation

steffunky
Copy link
Member

@steffunky steffunky commented Oct 31, 2024

Base information

Question Answer
Related to a SourceForge thead / Another PR / Combodo ticket? N°7793
Type of change? Enhancement

Objective

This feature aims to ease future portal style rework by adding common SCSS variables shared between the portal and the backoffice.
This will ensure that portal and backoffice maintain a similar style and ease overloading both frontends with a single customization.

Proposed solution

This approach adds a set of variables named $common- as opposed to itop backoffice $ibo- that will distribute default values for front ends.

$ibo- variables now consume $common- values that are then fed to the stylesheets.

To avoid breaking existing themes in a maintenance release, not all variables can inherit $common- values.
Up until now $ibo- variables that inherited another $ibo- variable value could be indirectly overloaded with a theme:

Flow 1@1x-50fps

But with how we envisioned the addition of $common variables, it would break the existing themes by breaking the link between $ibo- variables
Flow 2@1x-50fps

In iTop 3.2.1 we'll keep this behavior and add a breaking change in iTop 3.3.0 that will require themes to either overload both $ibo- variables, or overload the $common- variable
Flow 3@1x-50fps

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have tested all changes I made on an iTop instance
  • Is the PR clear and detailed enough so anyone can understand digging in the code?

Checklist of things to do before PR is ready to merge

  • Ensure previous themes are not broken by this change
  • Ensure all variables that can be made common in iTop 3.2.1 are changed in this PR

@steffunky steffunky added internal Work made by Combodo enhancement New feature or request labels Oct 31, 2024
@steffunky steffunky added this to the 3.2.1 milestone Oct 31, 2024
Copy link
Contributor

@Molkobain Molkobain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job, maybe you could duplicate the README.md & _shame.scss (empty) into the common folder as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request internal Work made by Combodo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants