Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Device manager: generic settings subsection component (PSG-636) #9147

Merged
merged 14 commits into from
Aug 9, 2022
1 change: 1 addition & 0 deletions res/css/_components.pcss
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
@import "./components/views/messages/_MBeaconBody.pcss";
@import "./components/views/messages/shared/_MediaProcessingError.pcss";
@import "./components/views/settings/devices/_DeviceTile.pcss";
@import "./components/views/settings/shared/_SettingsSubsection.pcss";
@import "./components/views/spaces/_QuickThemeSwitcher.pcss";
@import "./structures/_AutoHideScrollbar.pcss";
@import "./structures/_BackdropPanel.pcss";
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
Copyright 2022 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

.mx_SettingsSubsection {
width: 100%;
box-sizing: border-box;
}

.mx_SettingsSubsection_heading {
padding-bottom: $spacing-8;
}

.mx_SettingsSubsection_description {
width: 100%;
box-sizing: inherit;
line-height: $font-24px;
margin-bottom: $spacing-32;
color: $secondary-content;
}

.mx_SettingsSubsection_content {
width: 100%;
}
2 changes: 1 addition & 1 deletion res/css/views/settings/tabs/_SettingsTab.pcss
Original file line number Diff line number Diff line change
Expand Up @@ -103,5 +103,5 @@ limitations under the License.
grid-template-columns: 1fr;
grid-gap: $spacing-32;

padding: 0 $spacing-16;
padding: $spacing-16 0;
}
37 changes: 37 additions & 0 deletions src/components/views/settings/shared/SettingsSubsection.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*
Copyright 2022 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import React from "react";

import Heading from "../../typography/Heading";

export interface SettingsSubsectionProps {
heading: string;
description?: string | React.ReactNode;
children?: React.ReactNode;
}

const SettingsSubsection: React.FC<SettingsSubsectionProps> = ({ heading, description, children }) => (
<div className="mx_SettingsSubsection">
<Heading className="mx_SettingsSubsection_heading" size='h3'>{ heading }</Heading>
{ !!description && <div className="mx_SettingsSubsection_description">{ description }</div> }
<div className="mx_SettingsSubsection_content">
{ children }
</div>
</div>
);

export default SettingsSubsection;
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,17 @@ limitations under the License.
import React from 'react';

import { _t } from "../../../../../languageHandler";
import SettingsSubsection from '../../shared/SettingsSubsection';
import SettingsTab from '../SettingsTab';

const SessionManagerTab: React.FC = () => {
return <SettingsTab heading={_t('Sessions')} />;
return <SettingsTab heading={_t('Sessions')}>
<SettingsSubsection
heading={_t('Current session')}
// TODO session content coming here
// in next PR
Comment on lines +27 to +28
Copy link
Member

@turt2live turt2live Aug 8, 2022

Choose a reason for hiding this comment

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

Suggested change
// TODO session content coming here
// in next PR
// TODO(kerrya): session content coming here
// in next PR

or some sort of way to know who to track down if for some reason the TODO sits there for decades :)

alternative would be an issue link: "TODO: Implement as part of [link]"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This one is already done in my next open PR #9151, but will do for future

/>
</SettingsTab>;
};

export default SessionManagerTab;
1 change: 1 addition & 0 deletions src/i18n/strings/en_EN.json
Original file line number Diff line number Diff line change
Expand Up @@ -1563,6 +1563,7 @@
"Where you're signed in": "Where you're signed in",
"Manage your signed-in devices below. A device's name is visible to people you communicate with.": "Manage your signed-in devices below. A device's name is visible to people you communicate with.",
"Sessions": "Sessions",
"Current session": "Current session",
"Sidebar": "Sidebar",
"Spaces to show": "Spaces to show",
"Spaces are ways to group rooms and people. Alongside the spaces you're in, you can use some pre-built ones too.": "Spaces are ways to group rooms and people. Alongside the spaces you're in, you can use some pre-built ones too.",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
Copyright 2022 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import React from 'react';
import { render } from '@testing-library/react';

import SettingsSubsection from '../../../../../src/components/views/settings/shared/SettingsSubsection';

describe('<SettingsSubsection />', () => {
const defaultProps = {
heading: 'Test',
children: <div>test settings content</div>,
};
const getComponent = (props = {}): React.ReactElement =>
(<SettingsSubsection {...defaultProps} {...props} />);

it('renders without description', () => {
const { container } = render(getComponent());
expect(container).toMatchSnapshot();
});

it('renders with plain text description', () => {
const { container } = render(getComponent({ description: 'This describes the subsection' }));
expect(container).toMatchSnapshot();
});

it('renders with react element description', () => {
const description = <p>This describes the section <a href='/#'>link</a></p>;
const { container } = render(getComponent({ description }));
expect(container).toMatchSnapshot();
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`<SettingsSubsection /> renders with plain text description 1`] = `
<div>
<div
class="mx_SettingsSubsection"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
>
Test
</h3>
<div
class="mx_SettingsSubsection_description"
>
This describes the subsection
</div>
<div
class="mx_SettingsSubsection_content"
>
<div>
test settings content
</div>
</div>
</div>
</div>
`;

exports[`<SettingsSubsection /> renders with react element description 1`] = `
<div>
<div
class="mx_SettingsSubsection"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
>
Test
</h3>
<div
class="mx_SettingsSubsection_description"
>
<p>
This describes the section
<a
href="/#"
>
link
</a>
</p>
</div>
<div
class="mx_SettingsSubsection_content"
>
<div>
test settings content
</div>
</div>
</div>
</div>
`;

exports[`<SettingsSubsection /> renders without description 1`] = `
<div>
<div
class="mx_SettingsSubsection"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
>
Test
</h3>
<div
class="mx_SettingsSubsection_content"
>
<div>
test settings content
</div>
</div>
</div>
</div>
`;