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

BP-1293: Add theming support to new rich-text editor for basic redactor configuration #240

Open
wants to merge 25 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
94a3604
BP-1293: Adding Redactor overrides in entry
jovana-marceta Oct 30, 2024
19895ee
BP-1293: Extending redactor generator mixins
jovana-marceta Oct 30, 2024
1196aa4
BP-1293: Add redactor generators for buttons and table styles
jovana-marceta Nov 5, 2024
162bab4
BP-1293: Adding redactor checkboxes generator
jovana-marceta Nov 5, 2024
0444e4e
BP-1293: Refactoring redactor styles
jovana-marceta Nov 6, 2024
71f0a1c
Use mixin for row coloring from foundation
jovana-marceta Nov 6, 2024
6f32991
BP-1293: Inherit angular material checkbox background and change alia…
Nov 8, 2024
d58d056
Rename redactor lib
jovana-marceta Nov 12, 2024
22133a9
Move non-theming related variables outside of redactor mixins
jovana-marceta Nov 12, 2024
dead72d
BP-1293: Add redactor layout generator and clean up generator file
jovana-marceta Nov 12, 2024
6768b1a
BP-1293: Inherit table even background from angular material
jovana-marceta Nov 12, 2024
80792fb
BP-1293: Inherit material body text color
jovana-marceta Nov 12, 2024
f4151f9
BP-1293: Make redactor typography generator more redeable
jovana-marceta Nov 13, 2024
b9f241c
BP-1293: Rename folder
jovana-marceta Nov 13, 2024
8d2d02d
BP-1293: Resolve review suggestions
jovana-marceta Nov 14, 2024
5a54b11
BP-1293: Get rid of variables
jovana-marceta Nov 14, 2024
194e84e
rename checkbox variables
jovana-marceta Nov 14, 2024
2bdd9ea
rename toolbar generator
jovana-marceta Nov 14, 2024
6977b0b
BP-1293: Add missing sign on buttons generator variable
jovana-marceta Nov 20, 2024
d4dda13
BP-1293: Get rid of checkboxes duplicated extraction
jovana-marceta Nov 20, 2024
0789b8f
Get rid of toolbar generator duplicated extraction retrieval
jovana-marceta Nov 20, 2024
608e968
Additional buttons and checkboxes file refactoring
jovana-marceta Nov 26, 2024
b4ea198
Make buttons generator more redeable
jovana-marceta Nov 26, 2024
2bb570a
Refactoring checkbox and toolbar generator
jovana-marceta Nov 26, 2024
2102dcc
Fixed indentation for buttons generator
jovana-marceta Nov 26, 2024
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: 2 additions & 0 deletions libs/entry-components/styles/_generator.scss
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
@use 'modules/components/toggle/generator' as toggle;
@use 'modules/default-theme' as default;
@use 'modules/vendors/angular-material/generator' as material-theme;
@use 'modules/vendors/rich-text/generator' as rich-text;
@use 'sass:map';
@use 'partials/theming';

Expand All @@ -23,4 +24,5 @@
@include dialogs.generate-from($merged-theme);
@include checkboxes.generate-from($merged-theme);
@include toggle.generate-from($merged-theme);
@include rich-text.generate-from($merged-theme);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@use 'sass:map';
@use 'necessary-mix/tables-generator' as tables;
@use 'necessary-mix/buttons-generator' as buttons;
@use 'necessary-mix/typography-generator' as typography;
@use 'necessary-mix/checkboxes-generator' as checkboxes;
@use 'necessary-mix/toolbar-generator' as toolbar;

@mixin generate-from($theme) {
@include typography.generate-from($theme);
@include tables.generate-from($theme);
@include buttons.generate-from($theme);
@include checkboxes.generate-from($theme);
@include toolbar.generate-from($theme);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
@use 'sass:map';
@use '@angular/material' as mat;

$default-material-button: map.get(mat.define-typography-config(), 'button');

@mixin generate-from($theme) {
$theming-primary: map.get($theme, 'general', 'colors', 'primary');
$theming-font-family: map.get($theme, 'general', 'fonts', 'buttons', 'family');
Copy link
Member

Choose a reason for hiding this comment

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

Another variable to isolate map.get($theme, 'general', 'fonts', 'buttons') would make other variables shorter and more readable.

$theming-font-weight: map.get($theme, 'general', 'fonts', 'buttons', 'weight');
$theming-font-size: map.get($theme, 'general', 'fonts', 'buttons', 'size');

$primary-color: if($theming-primary == '' or $theming-primary == null, mat.get-color-from-palette(mat.$primary-palette, 500), $theming-primary);
Copy link
Member

Choose a reason for hiding this comment

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

@Cvetanovic please communicate with @jovana-marceta where she has found this shorter IF syntax for Scss because I was not able to find it the latest official docs (which doesn't mean it's not working).

$font-family: if($theming-font-family == '' or $theming-font-family == null, map.get($default-material-button, 'font-family'), $theming-font-family);
$font-weight: if($theming-font-weight == '' or $theming-font-weight == null, map.get($default-material-button, 'font-weight'), $theming-font-weight);
$font-size: if($theming-font-size == '' or $theming-font-size == null, map.get($default-material-button, 'font-size'), $theming-font-size);

.enigmatry-redactor-content {
button, .rx-content button {
background-color: $primary-color;
font: {
family: $font-family;
weight: $font-weight;
size: $font-size;
}
}

.rx-toolbar-buttons .rx-button {
&.active, &:hover {
background: $primary-color;
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
@use 'sass:map';
@use '@angular/material' as mat;

$redactor-checkboxes-selector: '[data-rx-type = 'todoitem'] ';

@mixin generate-from($theme) {
$theming-accent-color: map.get($theme, 'general', 'colors', 'accent');

.enigmatry-redactor-content {

$checkbox-color: if($theming-accent-color == '' or $theming-accent-color == null,
Copy link
Member

Choose a reason for hiding this comment

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

I understood we need to check for empty string and null for variables coming from AM, but this is our theme which leads me to the fact something's maybe not right on your machine, @jovana-marceta .
@Cvetanovic please switch to this branch and try testing this if condition without empty string and communicate with Jovana (and me eventually) whether is working and what exactly isn't since we expect null value if unset and not an empty string.

mat.get-color-from-palette(mat.$primary-palette, 500), $theming-accent-color);

.rx-editor #{$redactor-checkboxes-selector} input:checked::before {
border-color: $checkbox-color;
background-color: $checkbox-color;
}

@if map.get($theme, 'general', 'checkboxes') {
.rx-editor #{$redactor-checkboxes-selector} input::before {
background-color: map.get($theme, 'general', 'checkboxes', 'background');
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
@use 'sass:map';
@use '@angular/material' as mat;
@use 'scss-foundation/src/modules/lists/row-coloring' as list;

$redactor-th-selector: 'thead th';
$body-typography: map.get(mat.define-typography-config(), 'body-1');
$caption-typography: map.get(mat.define-typography-config(), 'caption');

@mixin generate-from($theme) {
$theming-table: map.get($theme, 'tables', 'rows', 'odd-even-background');
$theming-table-header: map.get($theme, 'tables', 'header', 'font-size');
$theming-fonts: map.get($theme, 'general', 'fonts');

.enigmatry-redactor-content {
table {
@if $theming-table {
tr {
@include list.odd-row-coloring(map.get($theming-table, 'odd'));
@include list.even-row-coloring(map.get($theming-table, 'even'));
}
}
@else {
tr {
@include list.even-row-coloring(mat.get-color-from-palette(mat.$grey-palette, 100));
@include list.odd-row-coloring(mat.get-color-from-palette(mat.$grey-palette, 50));
}
}

@if $theming-table-header {
th {
font-family: map.get($theme, 'general', 'fonts', 'body', 'family');
font-size: $theming-table-header;
}
}
}

table, table td {
/* stylelint-disable-next-line scss/at-if-no-null */
@if $theming-fonts and map.has-key($theming-fonts, 'body') and map.get($theming-fonts, 'body', 'size') != null {
Copy link
Member

Choose a reason for hiding this comment

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

Will it fail compiling if we just check directly size from body (without has key and previous check)?
We would then get rid of duplicated retrieval.

Copy link
Member

Choose a reason for hiding this comment

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

Still legit.

font-size: map.get($theming-fonts, 'body', 'size');
}
@else {
font-size: map.get($body-typography, 'font-size');
}

#{$redactor-th-selector} {
/* stylelint-disable-next-line scss/at-if-no-null */
@if map.has-key($theme, 'tables') and map.has-key(map.get($theme, 'tables', 'header'), 'font-size')
Copy link
Member

Choose a reason for hiding this comment

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

The same applies for this one.

and $theming-table-header != null {
font-size: $theming-table-header;
}
@else {
font-size: map.get($caption-typography, 'font-size');
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
@use 'sass:map';

@mixin generate-from($theme) {
$input-background: map.get($theme, 'general', 'inputs', 'background');
$input-background: if($input-background == null, transparent, $input-background);

.enigmatry-redactor-content {
.rx-main-container, .rx-toolbox-container {
background: $input-background;
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/* stylelint-disable selector-max-compound-selectors, scss/at-if-no-null */
@use 'sass:map';
@use '@angular/material' as mat;

$body-typography: map.get(mat.define-typography-config(), 'body-1');
$hero-typography: map.get(mat.define-typography-config(), 'headline-1');
$title-typography: map.get(mat.define-typography-config(), 'subtitle-1');
$caption-typography: map.get(mat.define-typography-config(), 'caption');

@function get-typography($theme, $key, $default-config) {
$theming-fonts: map.get($theme, 'general', 'fonts');
$font-config: map.get($theming-fonts, $key);

@if $font-config != null and $font-config != '' {
@return $font-config;
}
@else {
@return $default-config;
}
}

@function get-font-property($config, $property, $default-value) {
$value: map.get($config, $property);

Copy link
Member

Choose a reason for hiding this comment

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

This is too much duplication and hard to follow. Maybe an option to change this is to replace with the following:

  • pseudocode -
    Get the body.
    Check if body is null, if it is, created default settings and return.
    If it's not, try getting individual settings, the way it's already done, but without constant and the same null checks + syntax will be way shorter once you have body,

@if $value != null and $value != '' {
@return $value;
}
@else {
@return $default-value;
}
}

@mixin generate-from($theme) {
$body-config: get-typography($theme, 'body', $body-typography);
$hero-config: get-typography($theme, 'hero-titles', $hero-typography);
$title-config: get-typography($theme, 'titles', $title-typography);

.enigmatry-redactor-content {
.rx-editor, .rx-content, .rx-content p {
color: get-font-property($body-config, 'color', map.get($body-typography, 'color'));
font-family: get-font-property($body-config, 'family', map.get($body-typography, 'font-family'));
font-size: get-font-property($body-config, 'size', map.get($body-typography, 'font-size'));
letter-spacing: get-font-property($body-config, 'letter-spacing', map.get($body-typography, 'letter-spacing'));
}

.rx-editor, .rx-content, .rx-content {
h1, h2, h3, h4 {
font-family: get-font-property($hero-config, 'family', map.get($hero-typography, 'font-family'));
letter-spacing: get-font-property($hero-config, 'letter-spacing', map.get($hero-typography, 'letter-spacing'));
}

h5, h6 {
font-family: get-font-property($title-config, 'family', map.get($title-typography, 'font-family'));
letter-spacing: get-font-property($title-config, 'letter-spacing', map.get($title-typography, 'letter-spacing'));
}
}
}
}
1 change: 1 addition & 0 deletions libs/entry-components/styles/partials/theming.scss
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
@use 'core/components';
@use 'vendors/overrides';
1 change: 1 addition & 0 deletions libs/entry-components/styles/partials/vendors/_index.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@use 'overrides/rich-text';
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@use 'rich-text';
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@use 'scss-foundation/src/modules/display/items';
@use '@angular/material' as mat;

$redactor-link-selectors: 'a, a:visited, a:focus, a:hover';

.enigmatry-redactor-content .rx-content {
#{$redactor-link-selectors} {
@include items.fully-align(center, center);
display: inline-flex;
cursor: pointer;
}

button, #{$redactor-link-selectors} {
@include items.fully-align(center, flex-start);
height: 36px;
margin: 8px 8px 8px 0;
padding: 0 16px;
border: none;
text-decoration: none;
}

a:hover {
background-color: mat.get-color-from-palette(mat.$grey-palette, 100);
}

button {
@include mat.elevation(4);
height: 36px;
border-radius: 4px;
color: #FFF;

&:hover {
@include mat.elevation(8);
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
@use '@angular/material' as mat;

$checkbox-width: 18px;
$checkbox-height: 18px;
$border-radius: 2px;

$redactor-todoitem-selector: '.rx-editor [data-rx-type = 'todoitem']';

.enigmatry-redactor-content #{$redactor-todoitem-selector} {
input {
width: $checkbox-width;
height: $checkbox-height;
}

input::before, input:checked::before {
width: $checkbox-width;
height: $checkbox-height;
border-width: 2px;
border-radius: $border-radius;
border-color: rgb(0 0 0 / .54);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
@use 'sass:map';
@use '@angular/material' as mat;

.enigmatry-redactor-content {
.rx-button-icon svg {
fill: rgb(0 0 0 / .54);
}

.rx-main-container {
border-color: rgb(0 0 0 / .38);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
@use 'general';
@use 'tables';
@use 'buttons';
@use 'forms';
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/* stylelint-disable selector-max-compound-selectors, selector-max-type, selector-max-combinators */
.enigmatry-redactor-content table {
th {
font-weight: 500;
}

p {
margin: 0;
}

td {
border: 1px solid rgb(0 0 0 / .12);
}

tr:first-child {
th, td {
border-top: none;
}
}

tr:last-child td {
border-bottom: none;
}

th, td {
border: {
right: none;
left: none;
}
}
}