Fix revert toggle partial rendering

This commits fixes an issue where the `REVERT` label on revert toggle
might render as `REVER` or in a similarly clipped manner due to its
fixed width. The problem is visible when certain fonts fail to load or
browser engines render content non-standardly.

Changes:
- Refactor UI component to have its own separate Vue component with unit
  tests.
- Rework component design to utilize flexbox, enhancing its adaptability
  and simplifying the structure.
- Remove obselete `webkit` directives.
- Refactor SCSS for clearer structure and better SCSS best-practices.
- Use `em` when possible instead of `px` for improved responsiveness.
This commit is contained in:
undergroundwires
2023-08-14 15:28:15 +02:00
parent bc91237d7c
commit 39e650cf11
4 changed files with 511 additions and 132 deletions

View File

@@ -0,0 +1,238 @@
import 'mocha';
import {
Wrapper, shallowMount,
mount,
} from '@vue/test-utils';
import { expect } from 'chai';
import { nextTick, defineComponent } from 'vue';
import ToggleSwitch from '@/presentation/components/Scripts/View/ScriptsTree/SelectableTree/Node/ToggleSwitch.vue';
const DOM_INPUT_TOGGLE_CHECKBOX_SELECTOR = 'input.toggle-input';
const DOM_INPUT_TOGGLE_LABEL_OFF_SELECTOR = 'span.label-off';
const DOM_INPUT_TOGGLE_LABEL_ON_SELECTOR = 'span.label-on';
describe('ToggleSwitch.vue', () => {
describe('initial state', () => {
const testCases = [
{
initialValue: false,
description: 'unchecked for false',
},
{
initialValue: true,
description: 'checked for true',
},
];
testCases.forEach(({ initialValue, description }) => {
it(`renders as ${description}`, () => {
// arrange
const expectedState = initialValue;
// act
const wrapper = mountComponent({
properties: {
modelValue: initialValue,
},
});
const { checkboxElement } = getCheckboxElement(wrapper);
// assert
expect(checkboxElement.checked).to.equal(expectedState);
});
});
});
describe('label rendering', () => {
const testCases = [
{
description: 'off label',
selector: DOM_INPUT_TOGGLE_LABEL_OFF_SELECTOR,
},
{
description: 'on label',
selector: DOM_INPUT_TOGGLE_LABEL_ON_SELECTOR,
},
];
testCases.forEach(({ selector, description }) => {
it(description, () => {
// arrange
const expectedLabel = 'expected-test-label';
// act
const wrapper = mountComponent({
properties: {
label: expectedLabel,
},
});
// assert
const element = wrapper.find(selector);
expect(element.text()).to.equal(expectedLabel);
});
});
});
describe('model updates', () => {
describe('emission on change', () => {
const testCases = [
{
initialValue: true,
newCheckValue: false,
},
{
initialValue: false,
newCheckValue: true,
},
];
testCases.forEach(({ initialValue, newCheckValue }) => {
it(`emits ${newCheckValue} when initial value is ${initialValue} and checkbox value changes`, async () => {
// arrange
const wrapper = mountComponent({
properties: {
modelValue: initialValue,
},
});
const { checkboxWrapper } = getCheckboxElement(wrapper);
// act
await checkboxWrapper.setChecked(newCheckValue);
await nextTick();
// assert
expect(wrapper.emitted().input).to.deep.equal([[newCheckValue]]);
});
});
});
describe('no emission on identical value', () => {
const testCases = [
{
value: true,
description: 'true',
},
{
value: false,
description: 'false',
},
];
testCases.forEach(({ value, description }) => {
it(`does not emit for an unchanged value of ${description}`, async () => {
// arrange
const wrapper = mountComponent({
properties: {
modelValue: value,
},
});
const { checkboxWrapper } = getCheckboxElement(wrapper);
// act
await checkboxWrapper.setChecked(value);
await nextTick();
// assert
expect(wrapper.emitted().input).to.equal(undefined);
});
});
});
});
describe('click propagation', () => {
it('stops propagation `stopClickPropagation` is true', async () => {
// arrange
const { wrapper: parentWrapper, parentClickEventName } = mountToggleSwitchParent(
{ stopClickPropagation: true },
);
const switchWrapper = parentWrapper.getComponent(ToggleSwitch);
// act
switchWrapper.trigger('click');
await nextTick();
// assert
expect(switchWrapper.exists());
const receivedEvents = parentWrapper.emitted(parentClickEventName);
expect(receivedEvents).to.equal(undefined);
});
it('allows propagation `stopClickPropagation` is false', async () => {
// arrange
const { wrapper: parentWrapper, parentClickEventName } = mountToggleSwitchParent(
{ stopClickPropagation: false },
);
const switchWrapper = parentWrapper.getComponent(ToggleSwitch);
// act
switchWrapper.trigger('click');
await nextTick();
// assert
expect(switchWrapper.exists());
const receivedEvents = parentWrapper.emitted(parentClickEventName);
expect(receivedEvents).to.have.lengthOf(1);
});
});
});
function getCheckboxElement(wrapper: Wrapper<Vue>) {
const checkboxWrapper = wrapper.find(DOM_INPUT_TOGGLE_CHECKBOX_SELECTOR);
const checkboxElement = checkboxWrapper.element as HTMLInputElement;
return {
checkboxWrapper,
checkboxElement,
};
}
function mountComponent(options?: {
readonly properties?: {
readonly modelValue?: boolean,
readonly label?: string,
readonly stopClickPropagation?: boolean,
}
}) {
const wrapper = shallowMount(ToggleSwitch as unknown, {
propsData: {
value: options?.properties?.modelValue,
label: options?.properties?.label ?? 'test-label',
stopClickPropagation: options?.properties?.stopClickPropagation,
},
});
return wrapper;
}
function mountToggleSwitchParent(options?: {
readonly stopClickPropagation?: boolean,
}) {
const parentClickEventName = 'parent-clicked';
const parentComponent = defineComponent({
components: {
ToggleSwitch,
},
emits: [parentClickEventName],
template: `
<div @click="handleParentClick">
<ToggleSwitch
:stopClickPropagation="stopClickPropagation"
:label="'test-label'"
/>
</div>
`,
setup(_, { emit }) {
const stopClickPropagation = options?.stopClickPropagation;
function handleParentClick() {
emit(parentClickEventName);
}
return {
handleParentClick,
stopClickPropagation,
};
},
});
const wrapper = mount(
parentComponent as unknown,
{
stubs: { ToggleSwitch: false },
},
);
return {
wrapper,
parentClickEventName,
};
}