@ndla/ui 34.6.2 → 34.6.4

package/src/Embed/ExternalEmbed.tsx

@@ -0,0 +1,80 @@
+/**
+ * Copyright (c) 2023-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import styled from '@emotion/styled';
+import { OembedMetaData } from '@ndla/types-embed';
+import { useEffect, useRef } from 'react';
+import { useTranslation } from 'react-i18next';
+import { Figure } from '../Figure';
+import { ResourceBox } from '../ResourceBox';
+import { errorSvgSrc } from './ImageEmbed';
+
+interface Props {
+  embed: OembedMetaData;
+  isConcept?: boolean;
+}
+
+const StyledFigure = styled.figure`
+  iframe {
+    height: auto;
+  }
+`;
+
+const ExternalEmbed = ({ embed, isConcept }: Props) => {
+  const { t } = useTranslation();
+  const figRef = useRef<HTMLElement>(null);
+
+  useEffect(() => {
+    const iframe = figRef.current?.querySelector(`iframe`);
+    if (iframe) {
+      const [width, height] = [parseInt(iframe.width), parseInt(iframe.height)];
+      iframe.style.aspectRatio = `${width ? width : 16}/${height ? height : 9}`;
+    }
+  }, []);
+  if (embed.status === 'error') {
+    return (
+      <figure className={isConcept ? '' : 'c-figure'}>
+        <img alt={t('external.error')} src={errorSvgSrc} />
+        <figcaption>{t('external.error')}</figcaption>
+      </figure>
+    );
+  }
+
+  const { embedData, data } = embed;
+
+  if (embedData.type === 'fullscreen') {
+    const image = { src: data.iframeImage?.imageUrl ?? '', alt: data.iframeImage?.alttext?.alttext ?? '' };
+    return (
+      <Figure type="full">
+        <ResourceBox
+          image={image}
+          title={embedData.title ?? ''}
+          url={embedData.url}
+          caption={embedData.caption ?? ''}
+          buttonText={t('license.other.itemImage.ariaLabel')}
+        />
+      </Figure>
+    );
+  }
+
+  const fullColumnClass = isConcept ? 'c-figure--full-column' : '';
+  const classes = `c-figure ${fullColumnClass} c-figure--resize`;
+
+  return (
+    <StyledFigure
+      ref={figRef}
+      className={classes}
+      //@ts-ignore
+      // eslint-disable-next-line react/no-unknown-property
+      resizeiframe="true"
+      dangerouslySetInnerHTML={{ __html: data.oembed.html ?? '' }}
+    />
+  );
+};
+
+export default ExternalEmbed;

package/src/Embed/FootnoteEmbed.tsx

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2023-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import { FootnoteMetaData } from '@ndla/types-embed';
+import { useTranslation } from 'react-i18next';
+
+interface Props {
+  embed: FootnoteMetaData;
+}
+const FootnoteEmbed = ({ embed }: Props) => {
+  const { t } = useTranslation();
+  if (embed.status === 'error') {
+    return <div>{t('error')}</div>;
+  }
+
+  return (
+    <span id={`ref${embed.data.entryNum}`} className="c-footnotes__ref">
+      <sup>
+        <a href={`#note${embed.data.entryNum}`} target="_self">{`[${embed.data.entryNum}]`}</a>
+      </sup>
+    </span>
+  );
+};
+
+export default FootnoteEmbed;

package/src/Embed/H5pEmbed.tsx

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) 2023-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import styled from '@emotion/styled';
+import { H5pMetaData } from '@ndla/types-embed';
+import { useEffect, useRef } from 'react';
+import { useTranslation } from 'react-i18next';
+import { errorSvgSrc } from './ImageEmbed';
+
+interface Props {
+  embed: H5pMetaData;
+  isConcept?: boolean;
+}
+
+const StyledFigure = styled.figure`
+  iframe {
+    height: auto;
+  }
+`;
+
+const H5pEmbed = ({ embed, isConcept }: Props) => {
+  const { t } = useTranslation();
+
+  const iframeRef = useRef<HTMLIFrameElement>(null);
+  const figRef = useRef<HTMLElement>(null);
+
+  useEffect(() => {
+    const iframe =
+      embed.status === 'success' && embed.data.oembed ? figRef.current?.querySelector('iframe') : iframeRef.current;
+    if (iframe) {
+      const [width, height] = [parseInt(iframe.width), parseInt(iframe.height)];
+      iframe.style.aspectRatio = `${width ? width : 16}/${height ? height : 9}`;
+    }
+  }, [embed]);
+
+  if (embed.status === 'error') {
+    return (
+      <figure className={isConcept ? '' : 'c-figure'}>
+        <img alt={t('h5p.error')} src={errorSvgSrc} />
+        <figcaption>{t('h5p.error')}</figcaption>
+      </figure>
+    );
+  }
+  const fullColumnClass = isConcept ? 'c-figure--full-column' : '';
+  const classes = `c-figure ${fullColumnClass} c-figure--resize`;
+
+  if (embed.data.oembed) {
+    return (
+      <StyledFigure
+        className={classes}
+        ref={figRef}
+        //@ts-ignore
+        // eslint-disable-next-line react/no-unknown-property
+        resizeiframe="true"
+        dangerouslySetInnerHTML={{ __html: embed.data.oembed.html ?? '' }}
+      />
+    );
+  }
+
+  return (
+    //@ts-ignore
+    // eslint-disable-next-line react/no-unknown-property
+    <StyledFigure className={classes} resizeiframe="true">
+      <iframe title={embed.embedData.url} ref={iframeRef} aria-label={embed.embedData.url} src={embed.embedData.url} />
+    </StyledFigure>
+  );
+};
+
+export default H5pEmbed;

package/src/Embed/IframeEmbed.tsx

@@ -0,0 +1,84 @@
+/**
+ * Copyright (c) 2023-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import isNumber from 'lodash/isNumber';
+import { useEffect, useRef } from 'react';
+import { IframeMetaData } from '@ndla/types-embed';
+import { useTranslation } from 'react-i18next';
+import { Figure } from '../Figure';
+import { ResourceBox } from '../ResourceBox';
+
+interface Props {
+  embed: IframeMetaData;
+  isConcept?: boolean;
+}
+
+const ExternalEmbed = ({ embed, isConcept }: Props) => {
+  const { t } = useTranslation();
+  const iframeRef = useRef<HTMLIFrameElement>(null);
+
+  const { embedData } = embed;
+
+  useEffect(() => {
+    const iframe = iframeRef.current;
+    if (iframe) {
+      const [width, height] = [parseInt(iframe.width), parseInt(iframe.height)];
+      iframe.style.aspectRatio = `${width ? width : 16}/${height ? height : 9}`;
+    }
+  }, []);
+
+  if (embedData.type === 'fullscreen') {
+    const iframeImage = embed.status === 'success' ? embed.data.iframeImage : undefined;
+    const image = { src: iframeImage?.imageUrl ?? '', alt: iframeImage?.alttext?.alttext ?? '' };
+    return (
+      <Figure type="full">
+        <ResourceBox
+          image={image}
+          title={embedData.title ?? ''}
+          url={embedData.url}
+          caption={embedData.caption ?? ''}
+          buttonText={t('license.other.itemImage.ariaLabel')}
+        />
+      </Figure>
+    );
+  }
+
+  const resize = !embedData.url.includes('trinket.io');
+
+  const fullColumnClass = isConcept ? 'c-figure--full-column' : '';
+  const resizeClass = resize ? 'c-figure--resize' : '';
+  const classes = `c-figure ${fullColumnClass} ${resizeClass}`;
+
+  const { width, height, title, url } = embedData;
+
+  const strippedWidth = isNumber(width) ? width : width?.replace(/\s*px/, '');
+  const strippedHeight = isNumber(height) ? height : height?.replace(/\s*px/, '');
+  const urlOrTitle = title || url;
+
+  return (
+    //@ts-ignore
+    // eslint-disable-next-line react/no-unknown-property
+    <figure className={classes} resizeiframe={`${resize}`}>
+      <iframe
+        ref={iframeRef}
+        title={urlOrTitle}
+        aria-label={urlOrTitle}
+        src={url}
+        width={strippedWidth}
+        height={strippedHeight}
+        // eslint-disable-next-line react/no-unknown-property
+        allowFullScreen
+        scrolling="no"
+        frameBorder="0"
+        loading="lazy"
+      />
+    </figure>
+  );
+};
+
+export default ExternalEmbed;

package/src/Embed/ImageEmbed.tsx

@@ -0,0 +1,314 @@
+/**
+ * Copyright (c) 2023-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import isNumber from 'lodash/isNumber';
+import styled from '@emotion/styled';
+import { figureApa7CopyString, getGroupedContributorDescriptionList, getLicenseByAbbreviation } from '@ndla/licenses';
+import { ImageEmbedData, ImageMetaData } from '@ndla/types-embed';
+import { useTranslation } from 'react-i18next';
+import { ModalV2 } from '@ndla/modal';
+import { SafeLinkButton } from '@ndla/safelink';
+import { MouseEventHandler, useState } from 'react';
+import { ButtonV2, CopyButton } from '@ndla/button';
+import { ExpandTwoArrows } from '@ndla/icons/action';
+import { ArrowCollapse, ChevronDown, ChevronUp } from '@ndla/icons/common';
+import { Figure, FigureCaption, FigureType } from '../Figure';
+import Image, { ImageLink } from '../Image';
+import { FigureLicenseDialogContent } from '../Figure/FigureLicenseDialogContent';
+import { Copyright } from '../types';
+
+interface Props {
+  embed: ImageMetaData;
+  articlePath?: string;
+  previewAlt?: boolean;
+}
+
+export interface Author {
+  name: string;
+  type: string;
+}
+
+export const getLicenseCredits = (copyright?: {
+  creators?: Author[];
+  rightsholders?: Author[];
+  processors?: Author[];
+}) => {
+  return {
+    creators: copyright?.creators ?? [],
+    rightsholders: copyright?.rightsholders ?? [],
+    processors: copyright?.processors ?? [],
+  };
+};
+
+export const errorSvgSrc = `data:image/svg+xml;charset=UTF-8,%3Csvg fill='%238A8888' height='400' viewBox='0 0 24 12' width='100%25' xmlns='http://www.w3.org/2000/svg' style='background-color: %23EFF0F2'%3E%3Cpath d='M0 0h24v24H0V0z' fill='none'/%3E%3Cpath transform='scale(0.3) translate(28, 8.5)' d='M11 15h2v2h-2zm0-8h2v6h-2zm.99-5C6.47 2 2 6.48 2 12s4.47 10 9.99 10C17.52 22 22 17.52 22 12S17.52 2 11.99 2zM12 20c-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8-3.58 8-8 8z'/%3E%3C/svg%3E`;
+const isSmall = (size?: string): size is 'xsmall' | 'small' => size === 'xsmall' || size === 'small';
+
+const isAlign = (align?: string): align is 'left' | 'right' => align === 'left' || align === 'right';
+
+const getFigureType = (size?: string, align?: string): FigureType => {
+  if (size && isSmall(size) && align && isAlign(align)) {
+    return `${size}-${align}`;
+  }
+  if (size && isSmall(size) && !align) {
+    return size as FigureType;
+  }
+  if (align && isAlign(align)) {
+    return align;
+  }
+  return 'full';
+};
+
+const getSizes = (size?: string, align?: string) => {
+  if (align && size === 'full') {
+    return '(min-width: 1024px) 512px, (min-width: 768px) 350px, 100vw';
+  }
+  if (align && size === 'small') {
+    return '(min-width: 1024px) 350px, (min-width: 768px) 180px, 100vw';
+  }
+  if (align && size === 'xsmall') {
+    return '(min-width: 1024px) 180px, (min-width: 768px) 180px, 100vw';
+  }
+  return '(min-width: 1024px) 1024px, 100vw';
+};
+
+const getFocalPoint = (data: ImageEmbedData) => {
+  if (isNumber(data.focalX) && isNumber(data.focalY)) {
+    return { x: data.focalX, y: data.focalY };
+  }
+  return undefined;
+};
+
+const getCrop = (data: ImageEmbedData) => {
+  if (
+    isNumber(data.lowerRightX) &&
+    isNumber(data.lowerRightY) &&
+    isNumber(data.upperLeftX) &&
+    isNumber(data.upperLeftY)
+  ) {
+    return {
+      startX: data.lowerRightX,
+      startY: data.lowerRightY,
+      endX: data.upperLeftX,
+      endY: data.upperLeftY,
+    };
+  }
+  return undefined;
+};
+
+const StyledSpan = styled.span`
+  font-style: italic;
+  color: grey;
+`;
+
+const expandedSizes = '(min-width: 1024px) 1024px, 100vw';
+
+const ImageEmbed = ({ embed, articlePath, previewAlt }: Props) => {
+  const [isOpen, setIsOpen] = useState(false);
+  const [isBylineHidden, setIsBylineHidden] = useState(hideByline(embed.embedData.size));
+  const [imageSizes, setImageSizes] = useState<string | undefined>(undefined);
+  const { t, i18n } = useTranslation();
+  if (embed.status === 'error') {
+    const { align, size } = embed.embedData;
+    const figureType = getFigureType(size, align);
+    return (
+      <Figure type={figureType}>
+        <div className="c-figure__img">
+          <img alt={t('image.error.url')} src={errorSvgSrc} />
+        </div>
+        <figcaption>{t('image.error.caption')}</figcaption>
+      </Figure>
+    );
+  }
+
+  const { data, embedData, seq } = embed;
+
+  const authors = getLicenseCredits(data.copyright);
+
+  const altText = embedData.alt || '';
+  const caption = embedData.caption || '';
+  const license = getLicenseByAbbreviation(data.copyright.license.license, i18n.language);
+
+  const figureType = getFigureType(embedData.size, embedData.align);
+  const sizes = getSizes(embedData.size, embedData.align);
+
+  const focalPoint = getFocalPoint(embedData);
+  const crop = getCrop(embedData);
+
+  const contributors = getGroupedContributorDescriptionList(data.copyright, i18n.language).map((item) => ({
+    name: item.description,
+    type: item.label,
+  }));
+
+  const figureId = `figure-${seq}-${data.id}`;
+
+  const { creators, rightsholders, processors } = authors;
+  const captionAuthors = creators.length || rightsholders.length ? [...creators, ...rightsholders] : processors;
+  return (
+    <Figure
+      id={figureId}
+      type={imageSizes ? undefined : figureType}
+      className={imageSizes ? 'c-figure--right expanded' : ''}>
+      <ImageWrapper src={data.imageUrl} crop={crop} size={embedData.size}>
+        <Image
+          focalPoint={focalPoint}
+          contentType={data.contentType}
+          crop={crop}
+          sizes={imageSizes ?? sizes}
+          alt={altText}
+          src={data.imageUrl}
+          expandButton={
+            <ExpandButton
+              size={embedData.size}
+              expanded={!!imageSizes}
+              bylineHidden={isBylineHidden}
+              onExpand={() => setImageSizes((p) => (p ? undefined : expandedSizes))}
+              onHideByline={() => setIsBylineHidden((p) => !p)}
+            />
+          }
+        />
+      </ImageWrapper>
+      {previewAlt ? <StyledSpan>{`Alt: ${embedData.alt}`}</StyledSpan> : null}
+      <FigureCaption
+        hideFigcaption={isSmall(embedData.size) || isBylineHidden}
+        figureId={figureId}
+        id={figureId}
+        caption={caption}
+        reuseLabel={t('image.reuse')}
+        modalButton={
+          <ButtonV2 shape="pill" variant="outline" size="small" onClick={() => setIsOpen(true)}>
+            {t('image.reuse')}
+          </ButtonV2>
+        }
+        licenseRights={license.rights}
+        authors={captionAuthors}
+        locale={i18n.language}>
+        <ModalV2 controlled isOpen={isOpen} onClose={() => setIsOpen(false)} labelledBy="license-dialog-rules-heading">
+          {(close) => (
+            <FigureLicenseDialogContent
+              title={data.title.title}
+              license={license}
+              onClose={close}
+              authors={contributors}
+              origin={data.copyright.origin}
+              locale={i18n.language}
+              type="image">
+              <ImageLicenseButtons
+                articlePath={articlePath}
+                title={data.title.title}
+                imageUrl={data.imageUrl}
+                copyright={data.copyright}
+              />
+            </FigureLicenseDialogContent>
+          )}
+        </ModalV2>
+      </FigureCaption>
+    </Figure>
+  );
+};
+
+interface ImageWrapperProps {
+  src: string;
+  children: React.ReactNode;
+  crop?: {
+    startX: number;
+    startY: number;
+    endX: number;
+    endY: number;
+  };
+  size?: string;
+}
+const hideByline = (size?: string): boolean => {
+  return !!size && size.endsWith('-hide-byline');
+};
+
+interface ImageLicenseButtonsProps {
+  imageUrl: string;
+  title?: string;
+  articlePath?: string;
+  copyright?: Partial<Copyright>;
+}
+
+export const ImageLicenseButtons = ({ imageUrl, title, articlePath, copyright }: ImageLicenseButtonsProps) => {
+  const { t, i18n } = useTranslation();
+  if (!copyright?.license?.license || copyright?.license?.license === 'COPYRIGHTED') return null;
+
+  const copyString = figureApa7CopyString(
+    title,
+    undefined,
+    imageUrl,
+    articlePath,
+    copyright,
+    copyright?.license?.license,
+    '',
+    t,
+    i18n.language,
+  );
+
+  return (
+    <>
+      <CopyButton
+        variant="outline"
+        onClick={() => navigator.clipboard.writeText(copyString)}
+        copyNode={t('license.hasCopiedTitle')}
+        aria-live="assertive">
+        {t('license.copyTitle')}
+      </CopyButton>
+      <SafeLinkButton to={`${imageUrl}?download=true`} download variant="outline">
+        {t('image.download')}
+      </SafeLinkButton>
+    </>
+  );
+};
+
+const ImageWrapper = ({ src, crop, size, children }: ImageWrapperProps) => {
+  const { t } = useTranslation();
+  if (isSmall(size) || hideByline(size)) {
+    return <>{children}</>;
+  }
+
+  return (
+    <ImageLink src={src} crop={crop} aria-label={t('license.images.itemImage.ariaLabel')}>
+      {children}
+    </ImageLink>
+  );
+};
+
+interface ExpandButtonProps {
+  size?: string;
+  expanded: boolean;
+  bylineHidden: boolean;
+  onExpand: MouseEventHandler<HTMLButtonElement>;
+  onHideByline: MouseEventHandler<HTMLButtonElement>;
+}
+
+const ExpandButton = ({ size, expanded, bylineHidden, onExpand, onHideByline }: ExpandButtonProps) => {
+  const { t } = useTranslation();
+  if (isSmall(size)) {
+    return (
+      <button
+        type="button"
+        className="c-figure__fullscreen-btn"
+        aria-label={t(`license.images.itemImage.zoom${expanded ? 'Out' : ''}ImageButtonLabel`)}
+        onClick={onExpand}>
+        {expanded ? <ArrowCollapse /> : <ExpandTwoArrows />}
+      </button>
+    );
+  } else if (hideByline(size)) {
+    return (
+      <button
+        type="button"
+        className="c-figure__show-byline-btn"
+        aria-label={t(`license.images.itemImage.${bylineHidden ? 'expandByline' : 'minimizeByline'}`)}
+        onClick={onHideByline}>
+        {bylineHidden ? <ChevronDown /> : <ChevronUp />}
+      </button>
+    );
+  } else return null;
+};
+
+export default ImageEmbed;

package/src/Embed/RelatedContentEmbed.tsx

@@ -0,0 +1,62 @@
+/**
+ * Copyright (c) 2023-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import { RelatedContentMetaData } from '@ndla/types-embed';
+import { useTranslation } from 'react-i18next';
+import { contentTypeMapping } from '../model/ContentType';
+import { RelatedArticleV2 } from '../RelatedArticleList/RelatedArticleV2';
+
+interface Props {
+  embed: RelatedContentMetaData;
+  isOembed?: boolean;
+  subject?: string;
+  ndlaFrontendDomain?: string;
+}
+
+const RelatedContentEmbed = ({ embed, isOembed, subject, ndlaFrontendDomain }: Props) => {
+  const { t } = useTranslation();
+  if (embed.status === 'error') {
+    return <></>;
+  }
+
+  const { data, embedData } = embed;
+
+  if (embedData.articleId && data) {
+    const typeId = data.resource?.resourceTypes.find((rt) => contentTypeMapping[rt.id])?.id;
+    const type = typeId ? contentTypeMapping[typeId] : undefined;
+    const path =
+      data.resource?.paths.find((p) => p.split('/')[1] === subject?.replace('urn:', '')) ?? data.resource?.path;
+    return (
+      <RelatedArticleV2
+        title={data.article.title.title ?? ''}
+        introduction={data.article.metaDescription?.metaDescription ?? ''}
+        target={isOembed ? '_blank' : undefined}
+        to={`${ndlaFrontendDomain ?? ''}${path ?? ''}`}
+        type={type}
+      />
+    );
+  } else if (typeof embedData.url === 'string') {
+    return (
+      <RelatedArticleV2
+        title={embedData.title ?? ''}
+        introduction=""
+        to={embedData.url}
+        target="_blank"
+        type={'external-learning-resources'}
+        linkInfo={`${t('related.linkInfo')} ${
+          // Get domain name only from url
+          embedData.url.match(/^(?:https?:\/\/)?(?:[^@\n]+@)?(?:www\.)?([^:/\n]+)/im)?.[1] || embedData.url
+        }`}
+      />
+    );
+  } else {
+    return <></>;
+  }
+};
+
+export default RelatedContentEmbed;

package/src/Embed/UnknownEmbed.tsx

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) 2023-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+import { useTranslation } from 'react-i18next';
+import styled from '@emotion/styled';
+import { colors } from '@ndla/core';
+import { MetaData } from '@ndla/types-embed';
+
+interface Props {
+  embed: MetaData<any, any>;
+}
+
+const StyledSpan = styled.span`
+  color: ${colors.support.red};
+`;
+
+const UnknownEmbed = ({ embed }: Props) => {
+  const { t } = useTranslation();
+  return <StyledSpan>{t('embed.unsupported', { type: embed.resource })}</StyledSpan>;
+};
+
+export default UnknownEmbed;