shoelace/src/components/split-panel/split-panel.test.ts

import { dragElement } from '../../internal/test';
import { expect, fixture, html, oneEvent } from '@open-wc/testing';
import { queryByTestId } from '../../internal/test/data-testid-helpers';
import { resetMouse } from '@web/test-runner-commands';
import type SlSplitPanel from './split-panel';

const DIVIDER_WIDTH_IN_PX = 4;

const getPanel = (splitPanel: SlSplitPanel, testid: string): HTMLElement => {
  const startPanel = queryByTestId<HTMLElement>(splitPanel, testid);
  expect(startPanel).not.to.be.null;
  return startPanel!;
};

const getPanelWidth = (splitPanel: SlSplitPanel, testid: string) => {
  const panel = getPanel(splitPanel, testid);
  const { width } = panel.getBoundingClientRect();
  return width;
};

const getPanelHeight = (splitPanel: SlSplitPanel, testid: string) => {
  const panel = getPanel(splitPanel, testid);
  const { height } = panel.getBoundingClientRect();
  return height;
};

const getDivider = (splitPanel: SlSplitPanel): Element => {
  const divider = splitPanel.shadowRoot?.querySelector('[part="divider"]');
  expect(divider).not.to.be.null;
  return divider!;
};

describe('<sl-split-panel>', () => {
  afterEach(async () => {
    await resetMouse();
  });

  it('should render a component', async () => {
    const splitPanel = await fixture(html` <sl-split-panel></sl-split-panel> `);

    expect(splitPanel).to.exist;
  });

  it('should be accessible', async () => {
    const splitPanel = await fixture(html`<sl-split-panel>
      <div slot="start">Start</div>
      <div slot="end">End</div>
    </sl-split-panel>`);

    await expect(splitPanel).to.be.accessible();
  });

  it('should show both panels', async () => {
    const splitPanel = await fixture(html`<sl-split-panel>
      <div slot="start">Start</div>
      <div slot="end">End</div>
    </sl-split-panel>`);

    expect(splitPanel).to.contain.text('Start');
    expect(splitPanel).to.contain.text('End');
  });

  describe('panel sizing horizontal', () => {
    it('has two evenly sized panels by default', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel>
        <div slot="start" data-testid="start-panel">Start</div>
        <div slot="end" data-testid="end-panel">End</div>
      </sl-split-panel>`);

      const startPanelWidth = getPanelWidth(splitPanel, 'start-panel');
      const endPanelWidth = getPanelWidth(splitPanel, 'end-panel');

      expect(startPanelWidth).to.be.equal(endPanelWidth);
    });

    it('changes the sizing of the panels based on the position attribute', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel position="25">
        <div slot="start" data-testid="start-panel">Start</div>
        <div slot="end" data-testid="end-panel">End</div>
      </sl-split-panel>`);

      const startPanelWidth = getPanelWidth(splitPanel, 'start-panel');
      const endPanelWidth = getPanelWidth(splitPanel, 'end-panel');

      expect(startPanelWidth * 3).to.be.equal(endPanelWidth - DIVIDER_WIDTH_IN_PX);
    });

    it('updates the position in pixels to the correct result', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel position="25">
        <div slot="start" data-testid="start-panel">Start</div>
        <div slot="end" data-testid="end-panel">End</div>
      </sl-split-panel>`);

      splitPanel.position = 10;

      const startPanelWidth = getPanelWidth(splitPanel, 'start-panel');

      expect(startPanelWidth).to.be.equal(splitPanel.positionInPixels - DIVIDER_WIDTH_IN_PX / 2);
    });

    it('emits the sl-reposition	event on position change', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel>
        <div slot="start">Start</div>
        <div slot="end">End</div>
      </sl-split-panel>`);

      const repositionPromise = oneEvent(splitPanel, 'sl-reposition');
      splitPanel.position = 10;
      return repositionPromise;
    });

    it('can be resized using the mouse', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel>
        <div slot="start">Start</div>
        <div slot="end">End</div>
      </sl-split-panel>`);

      const positionInPixels = splitPanel.positionInPixels;

      const divider = getDivider(splitPanel);

      await dragElement(divider, -30);

      const positionInPixelsAfterDrag = splitPanel.positionInPixels;
      expect(positionInPixelsAfterDrag).to.be.equal(positionInPixels - 30);
    });

    it('cannot be resized if disabled', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel disabled>
        <div slot="start">Start</div>
        <div slot="end">End</div>
      </sl-split-panel>`);

      const positionInPixels = splitPanel.positionInPixels;

      const divider = getDivider(splitPanel);

      await dragElement(divider, -30);

      const positionInPixelsAfterDrag = splitPanel.positionInPixels;
      expect(positionInPixelsAfterDrag).to.be.equal(positionInPixels);
    });

    it('snaps to predefined positions', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel>
        <div slot="start">Start</div>
        <div slot="end">End</div>
      </sl-split-panel>`);

      const positionInPixels = splitPanel.positionInPixels;
      splitPanel.snap = `${positionInPixels - 40}px`;

      const divider = getDivider(splitPanel);

      await dragElement(divider, -30);

      const positionInPixelsAfterDrag = splitPanel.positionInPixels;
      expect(positionInPixelsAfterDrag).to.be.equal(positionInPixels - 40);
    });
  });

  describe('panel sizing vertical', () => {
    it('has two evenly sized panels by default', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel vertical style="height: 400px;">
        <div slot="start" data-testid="start-panel">Start</div>
        <div slot="end" data-testid="end-panel">End</div>
      </sl-split-panel>`);

      const startPanelHeight = getPanelHeight(splitPanel, 'start-panel');
      const endPanelHeight = getPanelHeight(splitPanel, 'end-panel');

      expect(startPanelHeight).to.be.equal(endPanelHeight);
    });

    it('changes the sizing of the panels based on the position attribute', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel position="25" vertical style="height: 400px;">
        <div slot="start" data-testid="start-panel">Start</div>
        <div slot="end" data-testid="end-panel">End</div>
      </sl-split-panel>`);

      const startPanelHeight = getPanelHeight(splitPanel, 'start-panel');
      const endPanelHeight = getPanelHeight(splitPanel, 'end-panel');

      expect(startPanelHeight * 3).to.be.equal(endPanelHeight - DIVIDER_WIDTH_IN_PX);
    });

    it('updates the position in pixels to the correct result', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel position="25" vertical style="height: 400px;">
        <div slot="start" data-testid="start-panel">Start</div>
        <div slot="end" data-testid="end-panel">End</div>
      </sl-split-panel>`);

      splitPanel.position = 10;

      const startPanelHeight = getPanelHeight(splitPanel, 'start-panel');

      expect(startPanelHeight).to.be.equal(splitPanel.positionInPixels - DIVIDER_WIDTH_IN_PX / 2);
    });

    it('emits the sl-reposition	event on position change ', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel vertical style="height: 400px;">
        <div slot="start">Start</div>
        <div slot="end">End</div>
      </sl-split-panel>`);

      const repositionPromise = oneEvent(splitPanel, 'sl-reposition');
      splitPanel.position = 10;
      return repositionPromise;
    });

    it('can be resized using the mouse ', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel vertical style="height: 400px;">
        <div slot="start">Start</div>
        <div slot="end">End</div>
      </sl-split-panel>`);

      const positionInPixels = splitPanel.positionInPixels;

      const divider = getDivider(splitPanel);

      await dragElement(divider, 0, -30);

      const positionInPixelsAfterDrag = splitPanel.positionInPixels;
      expect(positionInPixelsAfterDrag).to.be.equal(positionInPixels - 30);
    });

    it('cannot be resized if disabled', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel disabled vertical style="height: 400px;">
        <div slot="start">Start</div>
        <div slot="end">End</div>
      </sl-split-panel>`);

      const positionInPixels = splitPanel.positionInPixels;

      const divider = getDivider(splitPanel);

      await dragElement(divider, 0, -30);

      const positionInPixelsAfterDrag = splitPanel.positionInPixels;
      expect(positionInPixelsAfterDrag).to.be.equal(positionInPixels);
    });

    it('snaps to predefined positions', async () => {
      const splitPanel = await fixture<SlSplitPanel>(html`<sl-split-panel vertical style="height: 400px;">
        <div slot="start">Start</div>
        <div slot="end">End</div>
      </sl-split-panel>`);

      const positionInPixels = splitPanel.positionInPixels;
      splitPanel.snap = `${positionInPixels - 40}px`;

      const divider = getDivider(splitPanel);

      await dragElement(divider, 0, -30);

      const positionInPixelsAfterDrag = splitPanel.positionInPixels;
      expect(positionInPixelsAfterDrag).to.be.equal(positionInPixels - 40);
    });
  });
});