@ndla/ui 34.6.1 → 34.6.3

package/src/Embed/conceptComponents.tsx

@@ -0,0 +1,393 @@
+/**
+ * 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 { forwardRef, ReactNode, RefAttributes, useEffect, useRef } from 'react';
+import { ConceptVisualElementMeta } from '@ndla/types-embed';
+import { useTranslation } from 'react-i18next';
+import { Root, Item, Header, Trigger, Content } from '@radix-ui/react-accordion';
+import { getGroupedContributorDescriptionList, getLicenseByAbbreviation, getLicenseCredits } from '@ndla/licenses';
+import { css } from '@emotion/react';
+import { ButtonV2 } from '@ndla/button';
+import { breakpoints, colors, fonts, misc, mq, spacing } from '@ndla/core';
+import { ChevronDown } from '@ndla/icons/common';
+import { parseMarkdown } from '@ndla/util';
+import styled from '@emotion/styled';
+import { NotionDialogContent, NotionDialogLicenses, NotionDialogText } from '@ndla/notion';
+import { Figure, FigureCaption } from '../Figure';
+import { NotionVisualElementType } from '../Notion';
+import { classLicenses, FigureLicenseByline, FigureLicenseCta } from '../Figure/FigureLicense';
+import { Copyright } from '../types';
+import { ImageLicenseButtons } from './ImageEmbed';
+
+export interface ConceptNotionData {
+  title: string;
+  content?: string;
+  articlePath?: string;
+  metaImage?: {
+    url?: string;
+    alt?: string;
+  };
+  copyright?: Copyright;
+  source?: string;
+  visualElement?: ConceptVisualElementMeta;
+}
+
+interface ConceptNotionProps extends RefAttributes<HTMLDivElement>, ConceptNotionData {
+  className?: string;
+  closeButton?: ReactNode;
+  previewAlt?: boolean;
+  inPopover?: boolean;
+  tags?: string[];
+  subjects?: string[];
+}
+
+const getConceptVisualElement = (visualElement: ConceptVisualElementMeta): NotionVisualElementType | undefined => {
+  if (visualElement.status === 'error') {
+    return undefined;
+  }
+
+  if (visualElement.resource === 'image') {
+    return {
+      resource: visualElement.resource,
+      title: visualElement.data.title.title,
+      copyright: visualElement.data.copyright,
+      image: { src: visualElement.data.imageUrl, alt: visualElement.data.alttext.alttext },
+      url: visualElement.data.imageUrl,
+    };
+  } else if (visualElement.resource === 'brightcove') {
+    return {
+      resource: visualElement.resource,
+      title: visualElement.data.name,
+      url: `https://players.brightcove.net/${visualElement.embedData.account}/${visualElement.embedData.player}_default/index.html?videoId=${visualElement.embedData.videoid}`,
+      copyright: visualElement.data.copyright,
+    };
+  } else if (visualElement.resource === 'external' || visualElement.resource === 'iframe') {
+    return {
+      resource: visualElement.resource,
+      url: visualElement.embedData.url,
+      title: visualElement.embedData.url,
+    };
+  } else {
+    return {
+      resource: visualElement.resource,
+      url: visualElement.data.h5pUrl,
+      title: visualElement.embedData.title,
+    };
+  }
+};
+
+const notionContentCss = css`
+  @keyframes animateIn {
+    0% {
+      opacity: 0;
+      transform: translate3d(0, -13px, 0);
+    }
+    100% {
+      opacity: 1;
+      transform: translate3d(0, 0, 0);
+    }
+  }
+
+  animation-name: animateIn;
+  animation-duration: 300ms;
+  padding: ${spacing.normal};
+  background-color: white;
+  z-index: 1;
+  box-shadow: 0 0 30px rgba(0, 0, 0, 0.2);
+  ${mq.range({ from: breakpoints.tablet })} {
+    width: 500px;
+  }
+  ${mq.range({ from: breakpoints.desktop })} {
+    width: 720px;
+  }
+
+  ${mq.range({ until: breakpoints.tablet })} {
+    padding: ${spacing.small};
+    z-index: 9999;
+    height: 100%;
+    width: 100%;
+    overflow: auto;
+  }
+`;
+
+const StyledIframe = styled.iframe<{ type?: string }>`
+  height: auto;
+  min-height: ${(p) => p.type === 'video' && '400px'};
+`;
+
+const NotionHeader = styled.div`
+  display: flex;
+  align-items: center;
+  justify-content: flex-end;
+  border-bottom: 2px solid ${colors.brand.tertiary};
+  padding-bottom: ${spacing.small};
+  h1 {
+    flex-grow: 1;
+    margin: 0;
+    font-weight: ${fonts.weight.bold};
+    ${fonts.sizes('22px', 1.2)};
+  }
+  small {
+    padding-left: ${spacing.small};
+    margin-left: ${spacing.xsmall};
+    border-left: 1px solid ${colors.brand.greyLight};
+    ${fonts.sizes('20px', 1.2)};
+    font-weight: ${fonts.weight.normal};
+  }
+`;
+
+const StyledAccordionContent = styled(Content)`
+  background-color: ${colors.brand.lighter};
+  padding: ${spacing.small};
+  border-radius: ${misc.borderRadius};
+  overflow: hidden;
+  &[data-state='open'] {
+    animation: slideDown 300ms ease-out;
+  }
+  &[data-state='closed'] {
+    animation: slideUp 300ms ease-out;
+  }
+  @keyframes slideDown {
+    from {
+      height: 0;
+    }
+    to {
+      height: var(--radix-accordion-content-height);
+    }
+  }
+  @keyframes slideUp {
+    from {
+      height: var(--radix-accordion-content-height);
+    }
+    to {
+      height: 0;
+    }
+  }
+`;
+
+const StyledRoot = styled(Root)`
+  border-bottom: 1px solid ${colors.brand.greyLight};
+`;
+
+const StyledFigure = styled(Figure)`
+  && {
+    margin: ${spacing.normal} 0;
+  }
+  padding-bottom: 0;
+`;
+
+const StyledFigureCaption = styled(FigureCaption)`
+  border-bottom: 0;
+
+  h3 {
+    margin: 0;
+  }
+`;
+
+const StyledSpan = styled.span`
+  font-style: italic;
+  color: grey;
+`;
+
+const StyledAccordionTrigger = styled(ButtonV2)`
+  color: ${colors.brand.primary};
+  border-color: ${colors.brand.primary};
+  &[data-state='open'] {
+    svg {
+      transform: rotate(180deg);
+    }
+  }
+  svg {
+    transition: transform 300ms;
+  }
+`;
+
+const ListWrapper = styled.div`
+  display: flex;
+  gap: ${spacing.small};
+  align-items: center;
+`;
+
+const StyledList = styled.ul`
+  display: flex;
+  gap: ${spacing.small};
+  align-items: center;
+  list-style: none;
+  > li {
+    margin: 0;
+    font-family: ${fonts.sans};
+    font-weight: ${fonts.weight.semibold};
+    border-radius: ${misc.borderRadius};
+    background-color: ${colors.brand.greyLightest};
+    ${fonts.sizes('12px', 1.2)};
+    padding: ${spacing.xxsmall};
+  }
+`;
+
+export const ConceptNotionV2 = forwardRef<HTMLDivElement, ConceptNotionProps>(
+  (
+    {
+      visualElement,
+      articlePath,
+      title,
+      content,
+      source,
+      copyright,
+      closeButton,
+      inPopover,
+      previewAlt,
+      tags,
+      subjects,
+      ...rest
+    },
+    ref,
+  ) => {
+    const { t, i18n } = useTranslation();
+    const iframeRef = useRef<HTMLIFrameElement>(null);
+
+    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}`;
+      }
+    }, []);
+
+    const licenseCredits = getLicenseCredits(copyright);
+    const { creators, rightsholders, processors } = licenseCredits;
+    const authors = creators.length || rightsholders.length ? creators.concat(rightsholders) : processors;
+
+    const visualElementType =
+      visualElement?.embedData.resource === 'brightcove' ? 'video' : visualElement?.embedData.resource;
+
+    const notionVisualElement = visualElement ? getConceptVisualElement(visualElement) : undefined;
+    const visualElementLicense = getLicenseByAbbreviation(
+      notionVisualElement?.copyright?.license?.license ?? '',
+      i18n.language,
+    );
+    const visualElementLicenseCredits = getLicenseCredits(notionVisualElement?.copyright);
+    const visualElementAuthors =
+      visualElementLicenseCredits.creators.length || visualElementLicenseCredits.rightsholders.length
+        ? visualElementLicenseCredits.creators.concat(visualElementLicenseCredits.rightsholders)
+        : visualElementLicenseCredits.processors;
+    const visualElementGroupedAuthors = getGroupedContributorDescriptionList(
+      visualElementLicenseCredits,
+      i18n.language,
+    ).map((item) => ({
+      name: item.description,
+      type: item.label,
+    }));
+    return (
+      <div css={inPopover ? notionContentCss : undefined} {...rest} ref={ref}>
+        <NotionHeader>
+          <h1>
+            {title} {<small>{t('searchPage.resultType.notionsHeading')}</small>}
+          </h1>
+          {closeButton}
+        </NotionHeader>
+        <NotionDialogContent>
+          {notionVisualElement && (
+            <StyledFigure resizeIframe type={'full-column'}>
+              {notionVisualElement.image?.src ? (
+                <img src={notionVisualElement.image.src} alt={notionVisualElement.image.alt} />
+              ) : (
+                <StyledIframe
+                  ref={iframeRef}
+                  allowFullScreen
+                  type={visualElementType}
+                  src={notionVisualElement?.url}
+                  title={notionVisualElement?.title}
+                />
+              )}
+              {previewAlt && visualElement?.resource === 'image' ? (
+                <StyledSpan>{`Alt: ${visualElement.embedData.alt}`}</StyledSpan>
+              ) : null}
+              {visualElementLicense && (
+                <StyledRoot type="single" collapsible>
+                  <Item value="licenseInfo">
+                    <StyledFigureCaption
+                      figureId={''}
+                      id={''}
+                      modalButton={<></>}
+                      reuseLabel={t('reuse')}
+                      authors={visualElementAuthors}
+                      licenseRights={visualElementLicense.rights}>
+                      {visualElementLicense.abbreviation && (
+                        <Header>
+                          <Trigger asChild>
+                            <StyledAccordionTrigger variant="outline" shape="pill" size="small" colorTheme="lighter">
+                              {t('license.info')}
+                              <ChevronDown />
+                            </StyledAccordionTrigger>
+                          </Trigger>
+                        </Header>
+                      )}
+                    </StyledFigureCaption>
+                    <StyledAccordionContent>
+                      <div {...classLicenses()}>
+                        <h1 {...classLicenses('title')}>{t(`license.${visualElementType}.rules`)}</h1>
+                        <FigureLicenseByline
+                          license={visualElementLicense}
+                          messages={{
+                            learnAboutLicenses: t('license.learnMore'),
+                          }}
+                          locale={i18n.language}
+                        />
+                        <FigureLicenseCta
+                          authors={visualElementGroupedAuthors}
+                          title={notionVisualElement?.title}
+                          origin={notionVisualElement?.copyright?.origin}
+                          messages={{ source: t('source'), title: t('title') }}>
+                          {visualElementType === 'image' ? (
+                            <ImageLicenseButtons
+                              imageUrl={notionVisualElement.image?.src ?? ''}
+                              title={notionVisualElement.title}
+                              copyright={notionVisualElement.copyright}
+                              articlePath={articlePath}
+                            />
+                          ) : null}
+                        </FigureLicenseCta>
+                      </div>
+                    </StyledAccordionContent>
+                  </Item>
+                </StyledRoot>
+              )}
+            </StyledFigure>
+          )}
+          <NotionDialogText>{parseMarkdown(content ?? '', 'body')}</NotionDialogText>
+        </NotionDialogContent>
+        {tags && (
+          <ListWrapper>
+            {`${t('notions.tags')}:`}
+            <StyledList>
+              {tags.map((tag, index) => (
+                <li key={index}>{tag}</li>
+              ))}
+            </StyledList>
+          </ListWrapper>
+        )}
+        {subjects && (
+          <ListWrapper>
+            {`${t('notions.usedIn')}:`}
+            <StyledList>
+              {subjects.map((subject, index) => (
+                <li key={index}>{subject}</li>
+              ))}
+            </StyledList>
+          </ListWrapper>
+        )}
+
+        <NotionDialogLicenses
+          authors={authors.map((a) => a.name)}
+          license={copyright?.license?.license ?? ''}
+          source={parseMarkdown(source ?? '', 'body')}
+        />
+      </div>
+    );
+  },
+);

package/src/Embed/index.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ *
+ */
+
+export { default as ImageEmbed } from './ImageEmbed';
+export { default as AudioEmbed } from './AudioEmbed';
+export { default as H5pEmbed } from './H5pEmbed';
+export { default as ExternalEmbed } from './ExternalEmbed';
+export { default as IframeEmbed } from './IframeEmbed';
+export { default as FootnoteEmbed } from './FootnoteEmbed';
+export { default as BrightcoveEmbed } from './BrightcoveEmbed';
+export { default as ContentLinkEmbed } from './ContentLinkEmbed';
+export { default as RelatedContentEmbed } from './RelatedContentEmbed';
+export { default as ConceptEmbed } from './ConceptEmbed';
+export { ConceptNotionV2 } from './conceptComponents';
+export { default as ConceptListEmbed } from './ConceptListEmbed';
+export { default as UnknownEmbed } from './UnknownEmbed';

package/src/FactBox/FactBoxV2.tsx

@@ -0,0 +1,56 @@
+/**
+ * Copyright (c) 2016-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 React, { ReactNode, useState } from 'react';
+import BEMHelper from 'react-bem-helper';
+import { useTranslation } from 'react-i18next';
+import styled from '@emotion/styled';
+import { IconButtonV2 } from '@ndla/button';
+import { ChevronDown, ChevronUp } from '@ndla/icons/common';
+
+const classes = new BEMHelper({
+  name: 'factbox',
+  prefix: 'c-',
+});
+
+interface Props {
+  children?: ReactNode;
+}
+
+const StyledAside = styled.aside`
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+`;
+
+const StyledDiv = styled.div`
+  width: 100%;
+`;
+
+const StyledIconButton = styled(IconButtonV2)`
+  margin-top: -20px;
+  z-index: 1;
+`;
+
+const FactBox = ({ children }: Props) => {
+  const { t } = useTranslation();
+  const [isOpen, setIsOpen] = useState(false);
+
+  const additional = isOpen ? 'expanded' : '';
+
+  return (
+    <StyledAside {...classes(undefined, undefined, additional)}>
+      <StyledDiv {...classes('content')}>{children}</StyledDiv>
+      <StyledIconButton onClick={() => setIsOpen((p) => !p)} aria-label={t(`factbox.${isOpen ? 'close' : 'open'}`)}>
+        {isOpen ? <ChevronUp /> : <ChevronDown />}
+      </StyledIconButton>
+    </StyledAside>
+  );
+};
+
+export default FactBox;

package/src/FactBox/index.ts

@@ -1,3 +1,5 @@
 import FactBox from './FactBox';
 
+export { default as FactBoxV2 } from './FactBoxV2';
+
 export default FactBox;

package/src/Figure/Figure.tsx

@@ -25,6 +25,7 @@ const classes = new BEMHelper({
 export const FigureCaption = ({
   figureId,
   id,
+  modalButton,
   children,
   caption,
   authors,
@@ -36,9 +37,11 @@ export const FigureCaption = ({
   hasLinkedVideo,
   hideIconsAndAuthors,
   linkedVideoMessages,
+  linkedVideoButton,
+  className,
 }: FigureCaptionProps) => {
   return (
-    <figcaption {...classes('caption', hideFigcaption && !isMobile ? 'hidden-caption' : undefined)}>
+    <figcaption {...classes('caption', hideFigcaption && !isMobile ? 'hidden-caption' : undefined, className)}>
       {caption ? <div {...classes('info')}>{parseMarkdown(caption)}</div> : null}
       <footer {...classes('byline')}>
         <div {...classes('byline-licenselist')}>
@@ -48,26 +51,33 @@ export const FigureCaption = ({
                 <span {...classes('byline-authors')}>{authors?.map((author) => author.name).join(', ')}</span>
               )}
               <div>
-                <Button
-                  borderShape="rounded"
-                  outline
-                  size="small"
-                  type="button"
-                  data-dialog-trigger-id={id}
-                  data-dialog-source-id={figureId}>
-                  {reuseLabel}
-                </Button>
-                {hasLinkedVideo && (
+                {modalButton ? (
+                  modalButton
+                ) : (
                   <Button
                     borderShape="rounded"
                     outline
                     size="small"
                     type="button"
-                    {...classes('toggleAlternativeVideo')}>
-                    <span className="original">{linkedVideoMessages?.alternative}</span>
-                    <span className="alternative hidden">{linkedVideoMessages?.original}</span>
+                    data-dialog-trigger-id={id}
+                    data-dialog-source-id={figureId}>
+                    {reuseLabel}
                   </Button>
                 )}
+                {hasLinkedVideo &&
+                  (linkedVideoButton ? (
+                    linkedVideoButton
+                  ) : (
+                    <Button
+                      borderShape="rounded"
+                      outline
+                      size="small"
+                      type="button"
+                      {...classes('toggleAlternativeVideo')}>
+                      <span className="original">{linkedVideoMessages?.alternative}</span>
+                      <span className="alternative hidden">{linkedVideoMessages?.original}</span>
+                    </Button>
+                  ))}
               </div>
               {children}
             </div>
@@ -103,12 +113,15 @@ export interface FigureLicense {
 }
 
 interface FigureCaptionProps {
+  className?: string;
   figureId: string;
   id?: string;
   caption?: string;
-  reuseLabel: string;
+  reuseLabel?: string;
   licenseRights: string[];
   children?: ReactNode;
+  modalButton?: ReactNode;
+  linkedVideoButton?: ReactNode;
   authors?: { name: string }[];
   link?: {
     url: string;

package/src/Figure/FigureLicenseDialogContent.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 { useTranslation } from 'react-i18next';
+import styled from '@emotion/styled';
+import { colors, fonts, spacing } from '@ndla/core';
+import { ButtonV2 } from '@ndla/button';
+import { ModalBody } from '@ndla/modal';
+import { ReactNode } from 'react';
+import { Contributor } from '../types';
+import { FigureLicense } from './Figure';
+import { classLicenses, FigureLicenseByline, FigureLicenseCta } from './FigureLicense';
+
+interface Props {
+  children?: ReactNode;
+  origin?: string;
+  authors?: Contributor[];
+  onClose: () => void;
+  type: 'image' | 'text' | 'audio' | 'podcast' | 'video' | 'h5p' | 'concept' | 'files';
+  title?: string;
+  license: FigureLicense;
+  locale: string;
+}
+
+const StyledModalBody = styled(ModalBody)`
+  background-color: ${colors.brand.light};
+  flex: 1;
+`;
+
+const StyledH1 = styled.h1`
+  color: ${colors.brand.primary};
+  ${fonts.sizes('22px', '22px')};
+  margin: 0;
+  flex-grow: 1;
+`;
+
+const StyledHeader = styled.div`
+  display: flex;
+  justify-content: flex-end;
+  padding-bottom: ${spacing.normal};
+`;
+
+export const FigureLicenseDialogContent = ({
+  children,
+  authors,
+  origin,
+  title,
+  locale,
+  license,
+  onClose,
+  type,
+}: Props) => {
+  const { t } = useTranslation();
+  const messages = {
+    title: t('title'),
+    source: t('source'),
+    learnAboutLicenses: t('license.learnMore'),
+  };
+  return (
+    <StyledModalBody>
+      <div {...classLicenses()}>
+        <StyledHeader>
+          <StyledH1 id="license-dialog-rules-heading">{t(`license.${type}.rules`)}</StyledH1>
+          <ButtonV2 variant="link" onClick={onClose}>
+            {t('close')}
+          </ButtonV2>
+        </StyledHeader>
+        <FigureLicenseByline license={license} messages={messages} locale={locale} />
+        <FigureLicenseCta authors={authors} title={title} origin={origin} messages={messages}>
+          {children}
+        </FigureLicenseCta>
+      </div>
+    </StyledModalBody>
+  );
+};

package/src/Figure/component.figure.scss

@@ -167,7 +167,6 @@
 .c-figure__fullscreen-btn {
   cursor: pointer;
   position: absolute;
-  z-index: 1;
   padding: 0;
   bottom: 8px;
   right: 8px;