Matrix/element-web-Github
1
0
Fork 0
mirror of https://github.com/vector-im/element-web.git synced 2024-11-16 05:04:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Device manager - add settings subsection heading component (#9387)

Browse Source 
* add settings subsection heading component

* use named export

* newline
This commit is contained in:
Kerry 2022-10-11 20:12:02 +02:00 committed by GitHub
parent 51d5005efa
commit 03182d03be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 211 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
res/css/_components.pcss
View File

@ -40,6 +40,7 @@
@import "./components/views/settings/devices/_SecurityRecommendations.pcss";
@import "./components/views/settings/devices/_SelectableDeviceTile.pcss";
@import "./components/views/settings/shared/_SettingsSubsection.pcss";
@import "./components/views/settings/shared/_SettingsSubsectionHeading.pcss";
@import "./components/views/spaces/_QuickThemeSwitcher.pcss";
@import "./components/views/typography/_Caption.pcss";
@import "./structures/_AutoHideScrollbar.pcss";

4
res/css/components/views/settings/shared/_SettingsSubsection.pcss
View File

@ -19,10 +19,6 @@ limitations under the License.
box-sizing: border-box;
}
.mx_SettingsSubsection_heading {
padding-bottom: $spacing-8;
}
.mx_SettingsSubsection_description {
width: 100%;
box-sizing: inherit;

27
res/css/components/views/settings/shared/_SettingsSubsectionHeading.pcss Normal file
View File

@ -0,0 +1,27 @@
/*
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_SettingsSubsectionHeading {
display: flex;
flex-direction: row;
padding-bottom: $spacing-8;
gap: $spacing-8;
}
.mx_SettingsSubsectionHeading_heading {
flex: 1 1 100%;
}

11
src/components/views/settings/shared/SettingsSubsection.tsx
View File

@ -16,17 +16,22 @@ limitations under the License.
import React, { HTMLAttributes } from "react";
import Heading from "../../typography/Heading";
import { SettingsSubsectionHeading } from "./SettingsSubsectionHeading";
export interface SettingsSubsectionProps extends HTMLAttributes<HTMLDivElement> {
heading: string;
heading: string | React.ReactNode;
description?: string | React.ReactNode;
children?: React.ReactNode;
}
const SettingsSubsection: React.FC<SettingsSubsectionProps> = ({ heading, description, children, ...rest }) => (
<div {...rest} className="mx_SettingsSubsection">
<Heading className="mx_SettingsSubsection_heading" size='h3'>{ heading }</Heading>
{ typeof heading === 'string'
? <SettingsSubsectionHeading heading={heading} />
: <>
{ heading }
</>
}
{ !!description && <div className="mx_SettingsSubsection_description">{ description }</div> }
<div className="mx_SettingsSubsection_content">
{ children }

31
src/components/views/settings/shared/SettingsSubsectionHeading.tsx Normal file
View File

@ -0,0 +1,31 @@
/*
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, { HTMLAttributes } from "react";
import Heading from "../../typography/Heading";
export interface SettingsSubsectionHeadingProps extends HTMLAttributes<HTMLDivElement> {
heading: string;
children?: React.ReactNode;
}
export const SettingsSubsectionHeading: React.FC<SettingsSubsectionHeadingProps> = ({ heading, children, ...rest }) => (
<div {...rest} className="mx_SettingsSubsectionHeading">
<Heading className="mx_SettingsSubsectionHeading_heading" size='h3'>{ heading }</Heading>
{ children }
</div>
);

36
test/components/views/settings/devices/__snapshots__/CurrentDeviceSection-test.tsx.snap
View File

@ -120,11 +120,15 @@ exports[`<CurrentDeviceSection /> handles when device is falsy 1`] = `
class="mx_SettingsSubsection"
data-testid="current-session-section"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Current session
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Current session
</h3>
</div>
<div
class="mx_SettingsSubsection_content"
/>
@ -138,11 +142,15 @@ exports[`<CurrentDeviceSection /> renders device and correct security card when
class="mx_SettingsSubsection"
data-testid="current-session-section"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Current session
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Current session
</h3>
</div>
<div
class="mx_SettingsSubsection_content"
>
@ -258,11 +266,15 @@ exports[`<CurrentDeviceSection /> renders device and correct security card when
class="mx_SettingsSubsection"
data-testid="current-session-section"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Current session
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Current session
</h3>
</div>
<div
class="mx_SettingsSubsection_content"
>

36
test/components/views/settings/devices/__snapshots__/SecurityRecommendations-test.tsx.snap
View File

@ -6,11 +6,15 @@ exports[`<SecurityRecommendations /> renders both cards when user has both unver
class="mx_SettingsSubsection"
data-testid="security-recommendations-section"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Security recommendations
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Security recommendations
</h3>
</div>
<div
class="mx_SettingsSubsection_description"
>
@ -109,11 +113,15 @@ exports[`<SecurityRecommendations /> renders inactive devices section when user
class="mx_SettingsSubsection"
data-testid="security-recommendations-section"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Security recommendations
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Security recommendations
</h3>
</div>
<div
class="mx_SettingsSubsection_description"
>
@ -212,11 +220,15 @@ exports[`<SecurityRecommendations /> renders unverified devices section when use
class="mx_SettingsSubsection"
data-testid="security-recommendations-section"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Security recommendations
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Security recommendations
</h3>
</div>
<div
class="mx_SettingsSubsection_description"
>

11
test/components/views/settings/shared/SettingsSubsection-test.tsx
View File

@ -27,6 +27,17 @@ describe('<SettingsSubsection />', () => {
const getComponent = (props = {}): React.ReactElement =>
(<SettingsSubsection {...defaultProps} {...props} />);
it('renders with plain text heading', () => {
const { container } = render(getComponent());
expect(container).toMatchSnapshot();
});
it('renders with react element heading', () => {
const heading = <h3>This is the heading</h3>;
const { container } = render(getComponent({ heading }));
expect(container).toMatchSnapshot();
});
it('renders without description', () => {
const { container } = render(getComponent());
expect(container).toMatchSnapshot();

82
test/components/views/settings/shared/__snapshots__/SettingsSubsection-test.tsx.snap
View File

@ -5,11 +5,15 @@ exports[`<SettingsSubsection /> renders with plain text description 1`] = `
<div
class="mx_SettingsSubsection"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Test
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Test
</h3>
</div>
<div
class="mx_SettingsSubsection_description"
>
@ -26,16 +30,45 @@ exports[`<SettingsSubsection /> renders with plain text description 1`] = `
</div>
`;
exports[`<SettingsSubsection /> renders with plain text heading 1`] = `
<div>
<div
class="mx_SettingsSubsection"
>
<div
class="mx_SettingsSubsectionHeading"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Test
</h3>
</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"
<div
class="mx_SettingsSubsectionHeading"
>
Test
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Test
</h3>
</div>
<div
class="mx_SettingsSubsection_description"
>
@ -59,15 +92,13 @@ exports[`<SettingsSubsection /> renders with react element description 1`] = `
</div>
`;
exports[`<SettingsSubsection /> renders without description 1`] = `
exports[`<SettingsSubsection /> renders with react element heading 1`] = `
<div>
<div
class="mx_SettingsSubsection"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
>
Test
<h3>
This is the heading
</h3>
<div
class="mx_SettingsSubsection_content"
@ -79,3 +110,28 @@ exports[`<SettingsSubsection /> renders without description 1`] = `
</div>
</div>
`;
exports[`<SettingsSubsection /> renders without description 1`] = `
<div>
<div
class="mx_SettingsSubsection"
>
<div
class="mx_SettingsSubsectionHeading"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Test
</h3>
</div>
<div
class="mx_SettingsSubsection_content"
>
<div>
test settings content
</div>
</div>
</div>
</div>
`;

24
test/components/views/settings/tabs/user/__snapshots__/SessionManagerTab-test.tsx.snap
View File

@ -81,11 +81,15 @@ exports[`<SessionManagerTab /> renders current session section with a verified s
class="mx_SettingsSubsection"
data-testid="current-session-section"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Current session
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Current session
</h3>
</div>
<div
class="mx_SettingsSubsection_content"
>
@ -187,11 +191,15 @@ exports[`<SessionManagerTab /> renders current session section with an unverifie
class="mx_SettingsSubsection"
data-testid="current-session-section"
>
<h3
class="mx_Heading_h3 mx_SettingsSubsection_heading"
<div
class="mx_SettingsSubsectionHeading"
>
Current session
</h3>
<h3
class="mx_Heading_h3 mx_SettingsSubsectionHeading_heading"
>
Current session
</h3>
</div>
<div
class="mx_SettingsSubsection_content"
>