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

Wrapping component to show/hide UI based on UIFeature setting #7585

Merged
merged 5 commits into from
Jan 25, 2022
Merged
Show file tree
Hide file tree
Changes from 2 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
31 changes: 31 additions & 0 deletions src/components/views/settings/UiFeatureSettingWrapper.tsx
Original file line number Diff line number Diff line change
@@ -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 from 'react';

import SettingsStore from '../../../settings/SettingsStore';
import { UIFeature } from '../../../settings/UIFeature';

interface Props {
uiFeature: UIFeature;
roomId?: string;
t3chguy marked this conversation as resolved.
Show resolved Hide resolved
}
t3chguy marked this conversation as resolved.
Show resolved Hide resolved
const UiFeatureSettingWrapper: React.FC<Props> = ({ children, uiFeature, roomId }) => {
const settingValue = SettingsStore.getValue(uiFeature, roomId);
return settingValue && children ? <>{ children }</> : null;
};

export default UiFeatureSettingWrapper;
41 changes: 41 additions & 0 deletions test/components/views/settings/UiFeatureSettingWrapper-test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import React from 'react';
t3chguy marked this conversation as resolved.
Show resolved Hide resolved
import { mount } from 'enzyme';

import SettingsStore from '../../../../src/settings/SettingsStore';
import UiFeatureSettingWrapper from '../../../../src/components/views/settings/UiFeatureSettingWrapper';
import { UIFeature } from '../../../../src/settings/UIFeature';

jest.mock('../../../../src/settings/SettingsStore');

describe('<UiFeatureSettingWrapper>', () => {
const defaultProps = {
uiFeature: UIFeature.Flair,
children: <div>test</div>,
roomId: 'testabc',
};
const getComponent = (props = {}) => mount(<UiFeatureSettingWrapper {...defaultProps} {...props} />);

beforeEach(() => {
(SettingsStore.getValue as jest.Mock).mockClear().mockReturnValue(true);
});

it('renders children when setting is truthy', () => {
const component = getComponent();

expect(component).toMatchSnapshot();
expect(SettingsStore.getValue).toHaveBeenCalledWith(defaultProps.uiFeature, defaultProps.roomId);
});

it('returns null when setting is truthy but children are undefined', () => {
const component = getComponent({ children: undefined });

expect(component.html()).toBeNull();
});

it('returns null when setting is falsy', () => {
(SettingsStore.getValue as jest.Mock).mockReturnValue(false);
const component = getComponent();

expect(component.html()).toBeNull();
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`<UiFeatureSettingWrapper> renders children when setting is truthy 1`] = `
<UiFeatureSettingWrapper
roomId="testabc"
uiFeature="UIFeature.flair"
>
<div>
test
</div>
</UiFeatureSettingWrapper>
`;