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

Add full width in phone layout option #2195

Merged
merged 1 commit into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
de:
pageflow_scrolled:
editor:
common_content_element_attributes:
fullWidthInPhoneLayout:
label: "Volle Breite im Phone-Layout"
inline_help: |-
Ermöglicht dem Element, auf kleineren Bildschirmen die
volle Breite des Viewports einzunehmen, um den verfügbaren
Platz optimal zu nutzen.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
en:
pageflow_scrolled:
editor:
common_content_element_attributes:
fullWidthInPhoneLayout:
label: "Full width in phone layout"
inline_help: |-
Allow the element to span the full width of the viewport
on smaller screens, maximizing use of available space.
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,42 @@ describe('ContentElement', () => {
});
});

describe('supportsFullWidthInPhoneLayout', () => {
beforeEach(() => {
editor.contentElementTypes.register('headisng', {
supportedWidthRange: ['md', 'xl'],
customMargin: true
});
editor.contentElementTypes.register('imageGallery', {
supportedWidthRange: ['md', 'full'],
customMargin: true
});
editor.contentElementTypes.register('inlineImage', {
supportedWidthRange: ['xxs', 'full']
});
});

it('returns true for types that support full but do not have custom margin', () => {
const entry = factories.entry(
ScrolledEntry,
{},
{
entryTypeSeed: normalizeSeed({
contentElements: [
{id: 4, typeName: 'heading'},
{id: 5, typeName: 'imageGallery'},
{id: 6, typeName: 'inlineImage'}
]
})
}
);

expect(entry.contentElements.get(4).supportsFullWidthInPhoneLayout()).toEqual(false);
expect(entry.contentElements.get(5).supportsFullWidthInPhoneLayout()).toEqual(false);
expect(entry.contentElements.get(6).supportsFullWidthInPhoneLayout()).toEqual(true);
});
});

describe('transientState', () => {
it('stays in sync with transientState attribute', () => {
editor.contentElementTypes.register('someElement', {});
Expand Down
114 changes: 114 additions & 0 deletions entry_types/scrolled/package/spec/entryState/structure-spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -972,6 +972,120 @@ describe('useSectionForegroundContentElements', () => {
}
]);
});

it('does not make fullWidthInPhoneLayout elements full width in desktop layout', () => {
const {result} = renderHookInEntry(
() => useSectionForegroundContentElements({sectionId: 2, layout: 'right', phoneLayout: false}),
{
seed: {
chapters: chaptersSeed,
sections: sectionsSeed,
contentElements: [
{
id: 1,
permaId: 1001,
sectionId: 2,
typeName: 'image',
configuration: {
width: 2,
fullWidthInPhoneLayout: true
}
},
{
id: 2,
permaId: 1002,
sectionId: 2,
typeName: 'image',
configuration: {
position: 'sticky',
width: 1,
fullWidthInPhoneLayout: true
}
}
]
}
}
);

const contentElements = result.current;

expect(contentElements).toMatchObject([
{
id: 1,
position: 'inline',
width: 2
},
{
id: 2,
position: 'sticky',
width: 1
}
]);
});

it('makes fullWidthInPhoneLayout elements full width in phone layout', () => {
const {result} = renderHookInEntry(
() => useSectionForegroundContentElements({sectionId: 2, layout: 'right', phoneLayout: true}),
{
seed: {
chapters: chaptersSeed,
sections: sectionsSeed,
contentElements: [
{
id: 1,
permaId: 1001,
sectionId: 2,
typeName: 'image',
configuration: {
width: 2,
fullWidthInPhoneLayout: true
}
},
{
id: 2,
permaId: 1002,
sectionId: 2,
typeName: 'image',
configuration: {
position: 'sticky',
width: 1,
fullWidthInPhoneLayout: true
}
},
{
id: 3,
permaId: 1003,
sectionId: 2,
typeName: 'image',
configuration: {
width: 1
}
}
]
}
}
);

const contentElements = result.current;

expect(contentElements).toMatchObject([
{
id: 1,
position: 'inline',
width: 3
},
{
id: 2,
position: 'inline',
width: 3
},
{
id: 3,
position: 'inline',
width: 1
}
]);
});
});

describe('useContentElement', () => {
Expand Down
21 changes: 4 additions & 17 deletions entry_types/scrolled/package/spec/frontend/Layout-spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,7 @@ import {widthName} from 'frontend/layouts/widths';

import {renderInEntry} from 'testHelpers';

import useMediaQuery from 'frontend/useMediaQuery';

jest.mock('frontend/useMediaQuery');

let viewportWidth;

useMediaQuery.mockImplementation(query => {
const match = query.match(/max-width: ([0-9]+)px/);
return viewportWidth <= parseInt(match[1], 10);
})

describe('Layout', () => {
beforeEach(() => { viewportWidth = 1920; });

describe('placeholder', () => {
it('renders in two column variant', () => {
const {getByTestId} = renderInEntry(
Expand Down Expand Up @@ -465,7 +452,7 @@ describe('Layout', () => {
{id: 2, type: 'probe', position: 'side', width: 1},
{id: 3, type: 'probe', position: 'side', width: 2}
];
viewportWidth = 1000;
window.matchMedia.mockViewportWidth(1000);
const {container} = renderInEntry(
<Layout sectionProps={{layout: 'left'}} items={items}>
{(children, {position}) => <div>{position} {children}</div>}
Expand Down Expand Up @@ -496,7 +483,7 @@ describe('Layout', () => {
{id: 2, type: 'probe', position: 'sticky', width: 1},
{id: 3, type: 'probe', position: 'sticky', width: 2}
];
viewportWidth = 1000;
window.matchMedia.mockViewportWidth(1000);
const {container} = renderInEntry(
<Layout sectionProps={{layout: 'left'}} items={items}>
{(children, {position}) => <div>{position} {children}</div>}
Expand Down Expand Up @@ -529,7 +516,7 @@ describe('Layout', () => {
{id: 4, type: 'probe', position: 'side', width: 1},
{id: 5, type: 'probe', position: 'side', width: 2}
];
viewportWidth = 500;
window.matchMedia.mockViewportWidth(500);
const {container} = renderInEntry(
<Layout sectionProps={{layout: 'left'}} items={items}>
{(children, {position, width}) => <div>{position} {widthName(width)} {children}</div>}
Expand Down Expand Up @@ -562,7 +549,7 @@ describe('Layout', () => {
{id: 4, type: 'probe', position: 'sticky', width: 1},
{id: 5, type: 'probe', position: 'sticky', width: 2}
];
viewportWidth = 500;
window.matchMedia.mockViewportWidth(500);
const {container} = renderInEntry(
<Layout sectionProps={{layout: 'left'}} items={items}>
{(children, {position, width}) => <div>{position} {widthName(width)} {children}</div>}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, {useEffect} from 'react';
import React from 'react';

import {frontend} from 'frontend';

Expand All @@ -8,15 +8,17 @@ import '@testing-library/jest-dom/extend-expect'
describe('content element width', () => {
usePageObjects();

it('is passed as resolved value', () => {
beforeAll(() => {
frontend.contentElementTypes.register('test', {
component: function Component({contentElementWidth}) {
return (
<div data-testid="test-component">{contentElementWidth}</div>
)
}
});
});

it('is passed as resolved value', () => {
const {getByTestId} = renderEntry({
seed: {
contentElements: [{
Expand All @@ -31,4 +33,39 @@ describe('content element width', () => {

expect(getByTestId('test-component')).toHaveTextContent(2);
});

it('does not become full in phone layout if fullWidthInPhoneLayout is not set', () => {
window.matchMedia.mockViewportWidth(500);

const {getByTestId} = renderEntry({
seed: {
contentElements: [{
typeName: 'test',
configuration: {
width: 2
}
}]
}
});

expect(getByTestId('test-component')).toHaveTextContent(2);
});

it('becomes full in phone layout if fullWidthInPhoneLayout is set', () => {
window.matchMedia.mockViewportWidth(500);

const {getByTestId} = renderEntry({
seed: {
contentElements: [{
typeName: 'test',
configuration: {
width: 2,
fullWidthInPhoneLayout: true
}
}]
}
});

expect(getByTestId('test-component')).toHaveTextContent(3);
});
});
19 changes: 19 additions & 0 deletions entry_types/scrolled/package/spec/support/matchMediaStub.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
let mockOrientation;
let mockPrefersReducedMotion;
let mockViewportWidth;

Object.defineProperty(window, 'matchMedia', {
writable: true,
value: jest.fn().mockImplementation(query => {
let match;

if (query === '(orientation: portrait)') {
return {
addEventListener: jest.fn(),
Expand All @@ -25,6 +28,20 @@ Object.defineProperty(window, 'matchMedia', {
matches: mockPrefersReducedMotion
};
}
else if ((match = query.match(/^\(max-width: ([0-9]+)px\)$/))) {
return {
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
matches: mockViewportWidth <= parseInt(match[1], 10)
};
}
else if ((match = query.match(/^\(min-width: ([0-9]+)px\)$/))) {
return {
addEventListener: jest.fn(),
removeEventListener: jest.fn(),
matches: mockViewportWidth >= parseInt(match[1], 10)
};
}
else {
return {
addEventListener: jest.fn(),
Expand All @@ -38,7 +55,9 @@ Object.defineProperty(window, 'matchMedia', {
beforeEach(() => {
mockOrientation = 'landscape';
mockPrefersReducedMotion = false;
mockViewportWidth = 1920;
});

window.matchMedia.mockPortrait = () => mockOrientation = 'portrait';
window.matchMedia.mockPrefersReducedMotion = () => mockPrefersReducedMotion = true;
window.matchMedia.mockViewportWidth = (width) => mockViewportWidth = width;
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ export const ContentElement = Backbone.Model.extend({
}
},

supportsFullWidthInPhoneLayout() {
return !this.getType().customMargin &&
this.getType().supportedWidthRange?.[1] === 'full';
},

getEditorPath() {
return this.getType().editorPath?.call(null, this) ||
`/scrolled/content_elements/${this.id}`;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {ConfigurationEditorTabView, SelectInputView, SliderInputView} from 'pageflow/ui';
import {ConfigurationEditorTabView, CheckBoxInputView, SelectInputView, SliderInputView} from 'pageflow/ui';

import {
TypographyVariantSelectInputView
Expand All @@ -22,6 +22,7 @@ ConfigurationEditorTabView.groups.define('ContentElementPosition', function() {
sectionLayout: this.model.parent.section.configuration.get('layout')
});
}

this.input('width', SliderInputView, {
attributeTranslationKeyPrefixes: ['pageflow_scrolled.editor.common_content_element_attributes'],
displayText: value => [
Expand All @@ -40,6 +41,15 @@ ConfigurationEditorTabView.groups.define('ContentElementPosition', function() {
this.model.get('position') === 'full' ? 3 :
0
});

if (contentElement.supportsFullWidthInPhoneLayout()) {
this.input('fullWidthInPhoneLayout', CheckBoxInputView, {
attributeTranslationKeyPrefixes: ['pageflow_scrolled.editor.common_content_element_attributes'],
disabledBinding: 'width',
disabled: () => contentElement.getWidth() === 3,
displayCheckedIfDisabled: true
});
}
});

ConfigurationEditorTabView.groups.define(
Expand Down
Loading
Loading