creevey 0.9.0-non-webpack.2.fix-capture-element → 0.9.0

package/src/client/shared/components/ImagesView/SlideView.tsx

@@ -0,0 +1,146 @@
+import React, { useCallback, useEffect, useLayoutEffect, useRef, useState } from 'react';
+import { Loader } from '@storybook/components';
+import { styled, withTheme } from '@storybook/theming';
+import { getBorderColor, themeBorderColors, ViewPropsWithTheme } from './common.js';
+import { useApplyScale, useCalcScale, useLoadImages } from '../../helpers.js';
+import { readyForCapture } from '../../../addon/readyForCapture.js';
+
+const Container = styled.div({
+  position: 'relative',
+  display: 'flex',
+});
+
+const Input = styled.input({
+  position: 'absolute',
+  cursor: 'ew-resize',
+  appearance: 'none',
+  background: 'none',
+  boxShadow: 'none',
+  outline: 'none',
+  height: '100%',
+  width: '100%',
+  margin: '0',
+  zIndex: 1,
+
+  '&::-webkit-slider-runnable-track': {
+    height: '100%',
+  },
+  '&::-webkit-slider-thumb': {
+    boxShadow: '0 0 0 0.5px #888',
+    height: '100%',
+    width: '0px',
+    appearance: 'none',
+  },
+
+  '&::-moz-focus-outer': {
+    border: '0',
+  },
+  '&::-moz-range-track': {
+    height: '0',
+  },
+  '&::-moz-range-thumb': {
+    border: 'none',
+    boxShadow: '0 0 0 0.5px #888',
+    height: '100%',
+    width: '0px',
+  },
+});
+
+const ImageContainer = styled.div({
+  position: 'absolute',
+  width: '100%',
+  height: '100%',
+  overflow: 'hidden',
+});
+
+const ImageWrapper = withTheme(
+  styled.div(({ theme }) => ({
+    background: theme.base == 'light' ? theme.color.mediumlight : theme.color.darker,
+    position: 'relative',
+    width: '100%',
+    height: '100%',
+    display: 'flex',
+  })),
+);
+
+const BaseImage = styled.img<{ borderColor: string }>(({ borderColor }) => ({
+  boxSizing: 'border-box',
+  border: `1px solid ${borderColor}`,
+  maxWidth: '100%',
+}));
+
+const Image = styled(BaseImage)({
+  position: 'absolute',
+});
+
+const DiffImage = styled(BaseImage)({
+  opacity: '0',
+});
+
+export const SlideView = withTheme(({ actual, diff, expect, theme }: ViewPropsWithTheme): JSX.Element => {
+  const [step, setStep] = useState(0);
+
+  const expectedImageContainerRef = useRef<HTMLDivElement | null>(null);
+  const expectedImageWrapperRef = useRef<HTMLDivElement | null>(null);
+
+  const expectImageRef = useRef<HTMLImageElement | null>(null);
+  const diffImageRef = useRef<HTMLImageElement | null>(null);
+  const actualImageRef = useRef<HTMLImageElement | null>(null);
+
+  const loaded = useLoadImages(expect, diff, actual);
+  const scale = useCalcScale(diffImageRef, loaded);
+
+  useApplyScale(expectImageRef, scale);
+  useApplyScale(actualImageRef, scale);
+
+  const handleSlide = useCallback((event: React.ChangeEvent<HTMLInputElement>): void => {
+    if (!expectedImageContainerRef.current || !expectedImageWrapperRef.current) return;
+    const offset = Number(event.target.value);
+    expectedImageContainerRef.current.style.right = `${100 - offset}%`;
+    expectedImageWrapperRef.current.style.left = `${100 - offset}%`;
+  }, []);
+
+  useLayoutEffect(() => {
+    if (loaded && diffImageRef.current) setStep(100 / diffImageRef.current.getBoundingClientRect().width);
+  }, [loaded, scale]);
+
+  useLayoutEffect(() => {
+    if (loaded && expectedImageContainerRef.current && expectedImageWrapperRef.current) {
+      expectedImageContainerRef.current.style.right = '100%';
+      expectedImageWrapperRef.current.style.left = '100%';
+    }
+  }, [loaded]);
+
+  useEffect(() => {
+    if (loaded) readyForCapture();
+  }, [loaded]);
+
+  return loaded ? (
+    <Container>
+      <Input data-testid="slider" type="range" min={0} max={100} defaultValue={0} step={step} onChange={handleSlide} />
+      <ImageContainer>
+        <ImageWrapper>
+          <Image
+            ref={actualImageRef}
+            borderColor={getBorderColor(theme, themeBorderColors.actual)}
+            alt="actual"
+            src={actual}
+          />
+        </ImageWrapper>
+      </ImageContainer>
+      <ImageContainer ref={expectedImageContainerRef}>
+        <ImageWrapper ref={expectedImageWrapperRef}>
+          <Image
+            ref={expectImageRef}
+            borderColor={getBorderColor(theme, themeBorderColors.expect)}
+            alt="expect"
+            src={expect}
+          />
+        </ImageWrapper>
+      </ImageContainer>
+      <DiffImage ref={diffImageRef} borderColor={'transparent'} alt="diff" src={diff} />
+    </Container>
+  ) : (
+    <Loader size={64} />
+  );
+});

package/src/client/shared/components/ImagesView/SwapView.tsx

@@ -0,0 +1,81 @@
+import React, { useCallback, useEffect, useRef, useState } from 'react';
+import { Loader } from '@storybook/components';
+import { styled, withTheme } from '@storybook/theming';
+import { ViewPropsWithTheme, getBorderColor, themeBorderColors } from './common.js';
+import { useApplyScale, useCalcScale, useLoadImages } from '../../helpers.js';
+import { readyForCapture } from '../../../addon/readyForCapture.js';
+
+type ImageState = keyof typeof themeBorderColors;
+
+const Container = styled.div({
+  position: 'relative',
+  display: 'flex',
+});
+
+const BaseImage = styled.img<{ borderColor: string }>(({ borderColor }) => ({
+  boxSizing: 'border-box',
+  border: `1px solid ${borderColor}`,
+  maxWidth: '100%',
+}));
+
+const Image = styled(BaseImage)({
+  position: 'absolute',
+});
+
+const DiffImage = styled(BaseImage)({
+  cursor: 'pointer',
+  outline: 'none',
+  opacity: 0,
+  zIndex: 1,
+});
+
+export const SwapView = withTheme(({ theme, expect, actual, diff }: ViewPropsWithTheme): JSX.Element => {
+  const [image, setImage] = useState<ImageState>('actual');
+
+  const expectImageRef = useRef<HTMLImageElement | null>(null);
+  const diffImageRef = useRef<HTMLImageElement | null>(null);
+  const actualImageRef = useRef<HTMLImageElement | null>(null);
+
+  const loaded = useLoadImages(expect, diff, actual);
+  const scale = useCalcScale(diffImageRef, loaded);
+
+  useApplyScale(expectImageRef, scale, image);
+  useApplyScale(actualImageRef, scale, image);
+
+  const handleChangeView = useCallback((): void => {
+    setImage((prevImage) => (prevImage == 'actual' ? 'expect' : 'actual'));
+  }, []);
+
+  useEffect(() => {
+    if (loaded) readyForCapture();
+  }, [loaded]);
+
+  return loaded ? (
+    <Container>
+      <Image
+        ref={expectImageRef}
+        borderColor={getBorderColor(theme, themeBorderColors.expect)}
+        alt={'expect'}
+        src={expect}
+        hidden={image != 'expect'}
+      />
+      <DiffImage
+        ref={diffImageRef}
+        borderColor={'transparent'}
+        tabIndex={0}
+        alt="diff"
+        src={diff}
+        onClick={handleChangeView}
+      />
+      <Image
+        ref={actualImageRef}
+        borderColor={getBorderColor(theme, themeBorderColors.actual)}
+        alt={'actual'}
+        src={actual}
+        hidden={image != 'actual'}
+      />
+    </Container>
+  ) : (
+    <Loader size={64} />
+  );
+});

package/src/client/shared/components/ImagesView/common.ts

@@ -0,0 +1,23 @@
+import { Color, Theme } from '@storybook/theming';
+
+export const themeBorderColors = {
+  actual: 'negative',
+  expect: 'positive',
+  diff: 'secondary',
+};
+
+const isColor = (theme: Theme, color: string): color is keyof Color => color in theme.color;
+
+export function getBorderColor(theme: Theme, color: string): string {
+  return isColor(theme, color) ? theme.color[color] : color;
+}
+
+export interface ViewProps {
+  actual: string;
+  diff: string;
+  expect: string;
+}
+
+export interface ViewPropsWithTheme extends ViewProps {
+  theme: Theme;
+}

package/src/client/shared/components/ImagesView/index.ts

@@ -0,0 +1,5 @@
+export { ImagesView } from './ImagesView.js';
+export { BlendView } from './BlendView.js';
+export { SideBySideView } from './SideBySideView.js';
+export { SlideView } from './SlideView.js';
+export { SwapView } from './SwapView.js';

package/src/client/shared/components/PageFooter/PageFooter.tsx

@@ -0,0 +1,44 @@
+import React from 'react';
+import { Button } from '@storybook/components';
+import { styled, withTheme } from '@storybook/theming';
+import { Paging } from './Paging.js';
+
+export interface PageFooterProps {
+  canApprove: boolean;
+  retriesCount: number;
+  retry: number;
+  onRetryChange: (retry: number) => void;
+  onApprove: () => void;
+}
+
+const Container = withTheme(
+  styled.div(({ theme }) => ({
+    display: 'flex',
+    padding: '20px',
+    justifyContent: 'space-between',
+    background: theme.background.content,
+  })),
+);
+
+const StyledButton = styled(Button)({
+  transform: 'none',
+});
+
+export function PageFooter({
+  canApprove,
+  retriesCount,
+  retry,
+  onRetryChange,
+  onApprove,
+}: PageFooterProps): JSX.Element {
+  return (
+    <Container>
+      <Paging activePage={retry} onPageChange={onRetryChange} pagesCount={retriesCount} />
+      {canApprove ? (
+        <StyledButton secondary outline onClick={onApprove}>
+          {'Approve'}
+        </StyledButton>
+      ) : null}
+    </Container>
+  );
+}

package/src/client/shared/components/PageFooter/Paging.tsx

@@ -0,0 +1,105 @@
+import React from 'react';
+import { Button, Icons } from '@storybook/components';
+import { styled } from '@storybook/theming';
+import { noop } from '../../../../types.js';
+
+export interface PagingProps {
+  activePage: number;
+  onPageChange: (pageNumber: number) => void;
+  pagesCount: number;
+}
+
+export type ItemType = number | '.' | 'forward';
+
+const StyledButton = styled(Button)({
+  transform: 'none',
+  marginLeft: '8px',
+});
+
+export function Paging(props: PagingProps): JSX.Element {
+  const renderItem = (item: ItemType, index: number): JSX.Element => {
+    switch (item) {
+      case '.': {
+        return (
+          <StyledButton disabled key={`dots${index < 5 ? 'Left' : 'Right'}`}>
+            {'...'}
+          </StyledButton>
+        );
+      }
+      case 'forward': {
+        const disabled = props.activePage === props.pagesCount;
+        return (
+          <StyledButton
+            outline
+            disabled={disabled}
+            onClick={
+              disabled
+                ? noop
+                : () => {
+                    goToPage(props.activePage + 1);
+                  }
+            }
+            key="forward"
+          >
+            <span>
+              Next <Icons icon="arrowright" />
+            </span>
+          </StyledButton>
+        );
+      }
+      default: {
+        return (
+          <StyledButton
+            outline
+            secondary={props.activePage === item}
+            key={item}
+            onClick={() => {
+              goToPage(item);
+            }}
+          >
+            {item}
+          </StyledButton>
+        );
+      }
+    }
+  };
+
+  const goToPage = (pageNumber: number): void => {
+    if (1 <= pageNumber && pageNumber !== props.activePage && pageNumber <= props.pagesCount) {
+      props.onPageChange(pageNumber);
+    }
+  };
+
+  return <div>{getItems(props.activePage, props.pagesCount).map(renderItem)}</div>;
+}
+
+function getItems(active: number, total: number): ItemType[] {
+  const result: ItemType[] = [];
+
+  const left = Math.max(Math.min(active - 2, total - 4), 1);
+  const right = Math.min(Math.max(5, active + 2), total);
+
+  const hasLeftDots = left > 3;
+  const from = hasLeftDots ? left : 1;
+
+  const hasRightDots = right < total - 2;
+  const to = hasRightDots ? right : total;
+
+  if (hasLeftDots) {
+    result.push(1, '.');
+  }
+
+  for (let i = from; i <= to; ++i) {
+    result.push(i);
+  }
+
+  if (hasRightDots) {
+    result.push('.');
+  }
+
+  if (hasRightDots && isFinite(total)) {
+    result.push(total);
+  }
+
+  return result.concat('forward');
+}

package/src/client/shared/components/PageHeader/ImagePreview.tsx

@@ -0,0 +1,82 @@
+import React from 'react';
+import { styled, withTheme, Theme } from '@storybook/theming';
+
+const IMG_SIZE = 64;
+const DIAG_LENGTH = (2 * (IMG_SIZE - 8) ** 2) ** (1 / 2);
+
+interface ImageSwapProps {
+  url: string;
+  isActive: boolean;
+  onClick: (imageName: string) => void;
+  imageName: string;
+  theme: Theme;
+  error?: boolean;
+}
+
+const Button = styled.button<{ borderColor?: string }>(({ borderColor }) => ({
+  appearance: 'none',
+  background: 'none',
+  color: 'inherit',
+  font: 'inherit',
+  cursor: 'pointer',
+  outline: 'none',
+  zIndex: 1,
+  margin: '0 10px',
+  border: '2px solid transparent',
+  borderColor: borderColor ?? 'transparent',
+
+  '&:first-of-type': {
+    marginLeft: 0,
+  },
+}));
+
+const Image = withTheme(
+  styled.img<{ hasBorder?: boolean; backgroundColor: string; theme: Theme }>(
+    ({ hasBorder, backgroundColor, theme }) => ({
+      maxHeight: `${IMG_SIZE}px`,
+      width: `${IMG_SIZE}px`,
+      overflow: 'hidden',
+      transform: hasBorder ? 'translateY(2px)' : undefined,
+
+      '&::before': {
+        content: "' '",
+        display: 'block',
+        height: `${IMG_SIZE - 8}px`,
+        width: `${IMG_SIZE - 8}px`,
+        margin: '4px',
+        backgroundColor: backgroundColor,
+        backgroundImage: `linear-gradient(
+      45deg,
+      rgba(0, 0, 0, 0) ${DIAG_LENGTH / 2 - 0.5}px,
+      ${theme.color.medium} ${DIAG_LENGTH / 2 - 0.5}px,
+      ${theme.color.medium} ${DIAG_LENGTH / 2 + 0.5}px,
+      rgba(0, 0, 0, 0) ${DIAG_LENGTH / 2 + 0.5}px
+    ),
+    linear-gradient(
+      315deg,
+      rgba(0, 0, 0, 0) ${DIAG_LENGTH / 2 + 0.2}px,
+      ${theme.color.medium} ${DIAG_LENGTH / 2 + 0.2}px,
+      ${theme.color.medium} ${DIAG_LENGTH / 2 + 1.2}px,
+      rgba(0, 0, 0, 0) ${DIAG_LENGTH / 2 + 1.2}px
+    )`,
+      },
+    }),
+  ),
+);
+
+export const ImagePreview = withTheme(
+  ({ isActive, onClick, imageName, url, theme, error }: ImageSwapProps): JSX.Element => {
+    const handleClick = (): void => {
+      onClick(imageName);
+    };
+
+    return (
+      <Button
+        onClick={handleClick}
+        borderColor={isActive ? theme.barSelectedColor : error ? theme.color.negative : undefined}
+      >
+        <Image hasBorder={isActive || error} src={url} alt={imageName} backgroundColor={theme.background.content} />
+      </Button>
+    );
+  },
+);

package/src/client/shared/components/PageHeader/PageHeader.tsx

@@ -0,0 +1,123 @@
+import React, { useState } from 'react';
+import { Icons, Tabs } from '@storybook/components';
+import { styled, withTheme, Theme } from '@storybook/theming';
+import { ImagesViewMode, Images } from '../../../../types.js';
+import { getImageUrl } from '../../helpers.js';
+import { ImagePreview } from './ImagePreview.js';
+import { viewModes } from '../../viewMode.js';
+
+interface PageHeaderProps {
+  title: string[];
+  images?: Partial<Record<string, Images>>;
+  errorMessage?: string | null;
+  showViewModes: boolean;
+  showTitle?: boolean;
+  viewMode: ImagesViewMode;
+  imagesWithError?: string[];
+  onImageChange: (name: string) => void;
+  onViewModeChange: (viewMode: ImagesViewMode) => void;
+}
+
+const Container = styled.div({
+  margin: '24px 44px 0',
+});
+
+const ErrorContainer = withTheme(
+  styled.div<{ theme: Theme }>(({ theme }) => ({
+    marginTop: '8px',
+    padding: '8px',
+    background: theme.background.negative,
+    color: theme.color.negative,
+    borderRadius: '2px',
+    display: 'flex',
+    alignItems: 'baseline',
+
+    '& svg': {
+      margin: '0 5px',
+      width: 8,
+      height: 8,
+    },
+
+    '& pre': {
+      margin: '0 4px',
+      padding: 0,
+      lineHeight: '22px',
+    },
+  })),
+);
+
+const H1 = styled.h1({
+  margin: 0,
+  marginBottom: '8px',
+});
+
+const HeaderDivider = withTheme(
+  styled.span<{ theme: Theme }>(({ theme }) => ({
+    padding: '0 8px',
+    color: theme.color.mediumdark,
+  })),
+);
+
+const ImagesEntriesContainer = styled.div({
+  display: 'flex',
+  margin: '16px 0 8px',
+});
+
+export function PageHeader({
+  title,
+  images = {},
+  errorMessage,
+  showViewModes,
+  showTitle,
+  viewMode,
+  imagesWithError = [],
+  onImageChange,
+  onViewModeChange,
+}: PageHeaderProps): JSX.Element | null {
+  const imageEntires = Object.entries(images) as [string, Images][];
+  const [imageName, setImageName] = useState(imageEntires.at(0)?.[0] ?? '');
+
+  const handleImageChange = (name: string): void => {
+    setImageName(name);
+    onImageChange(name);
+  };
+  const handleViewModeChange = (mode: string): void => {
+    onViewModeChange(mode as ImagesViewMode);
+  };
+  const error = errorMessage || imagesWithError.includes(imageName) ? (images[imageName]?.error ?? errorMessage) : null;
+
+  return showTitle || error || imageEntires.length > 1 || showViewModes ? (
+    <Container>
+      {showTitle && (
+        <H1>{title.flatMap((token) => [token, <HeaderDivider key={token}>/</HeaderDivider>]).slice(0, -1)}</H1>
+      )}
+      {error && (
+        <ErrorContainer>
+          <Icons icon="closeAlt" />
+          <pre>{error}</pre>
+        </ErrorContainer>
+      )}
+      {imageEntires.length > 1 ? (
+        <ImagesEntriesContainer>
+          {imageEntires.map(([name, image]: [string, Images]) => (
+            <ImagePreview
+              key={name}
+              imageName={name}
+              url={`${getImageUrl(title, name)}/${image.actual}`}
+              isActive={name === imageName}
+              onClick={handleImageChange}
+              error={imagesWithError.includes(name)}
+            />
+          ))}
+        </ImagesEntriesContainer>
+      ) : null}
+      {showViewModes && (
+        <Tabs selected={viewMode} actions={{ onSelect: handleViewModeChange }}>
+          {viewModes.map((x) => (
+            <div key={x} id={x} title={x} />
+          ))}
+        </Tabs>
+      )}
+    </Container>
+  ) : null;
+}