@ndla/ui 3.2.1-alpha.8 → 3.2.1

package/es/AuthorInfo/AuthorInfo.js

@@ -10,8 +10,7 @@ function _extends() { _extends = Object.assign || function (target) { for (var i
 import React from 'react';
 import PropTypes from 'prop-types';
 import BEMHelper from 'react-bem-helper';
-import SafeLink from '@ndla/safelink'; // @ts-ignore
-
+import SafeLink from '@ndla/safelink';
 import Portrait from '../Portrait';
 import { jsx as ___EmotionJSX } from "@emotion/core";
 var classes = new BEMHelper({

package/lib/BackgroundImage/BackgroundImage.d.ts

@@ -0,0 +1,11 @@
+declare type ImageType = 'mobile' | 'tablet' | 'desktop' | 'wide';
+interface Props {
+    showOverlay?: boolean;
+    className?: string;
+    images: {
+        url: string;
+        types: ImageType[];
+    }[];
+}
+declare const BackgroundImage: ({ images, showOverlay }: Props) => JSX.Element;
+export default BackgroundImage;

package/{es/BackgroundImage/index.js → lib/BackgroundImage/index.d.ts}

@@ -1,2 +1,2 @@
 import BackgroundImage from './BackgroundImage';
-export default BackgroundImage;
+export default BackgroundImage;

package/lib/ContentLoader/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) 2018-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 { ReactNode } from 'react';
+interface Props {
+    children?: ReactNode;
+    speed?: number;
+    width?: number;
+    height?: number;
+    primaryColor?: string;
+    secondaryColor?: string;
+    preserveAspectRatio?: string;
+    className?: string;
+}
+declare const ContentLoader: ({ children, width, height, preserveAspectRatio, className, primaryColor, secondaryColor, speed, ...rest }: Props) => JSX.Element;
+export default ContentLoader;

package/lib/Dialog/Dialog.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2017-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 { ReactNode } from 'react';
+interface Props {
+    id: string;
+    labelledby?: string;
+    label?: string;
+    hidden?: boolean;
+    children?: ReactNode;
+    messages?: {
+        close: string;
+    };
+    modifier?: string | string[];
+    disablePortal?: boolean;
+    onClose?: () => void;
+}
+export declare const Dialog: ({ children, messages, id, labelledby, label, modifier, disablePortal, hidden, onClose, ...rest }: Props) => any;
+export {};

package/{es/Dialog/index.js → lib/Dialog/index.d.ts}

@@ -7,4 +7,4 @@
  */
 import { Dialog } from './Dialog';
 export { Dialog };
-export default Dialog;
+export default Dialog;

package/lib/Figure/Figure.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { ReactNode } from 'react';
+import { License } from '../types';
+export declare const FigureCaption: ({ figureId, id, children, caption, authors, reuseLabel, licenseRights, locale, link, hideFigcaption, hasLinkedVideo, }: FigureCaptionProps) => JSX.Element;
+export interface FigureLicense extends License {
+    short: string;
+    title: string;
+    userFriendlyTitle: string;
+    description: string;
+    rights: string[];
+    linkText?: string;
+    url?: string;
+}
+interface FigureCaptionProps {
+    figureId: string;
+    id: string;
+    caption?: string;
+    reuseLabel: string;
+    licenseRights: string[];
+    children?: ReactNode;
+    authors?: {
+        name: string;
+    }[];
+    link?: {
+        url: string;
+        text: string;
+        description?: string;
+        external?: boolean;
+    };
+    locale?: string;
+    hideFigcaption?: boolean;
+    hasLinkedVideo?: boolean;
+}
+declare const Figure: ({ children, type, resizeIframe, ...rest }: Props) => JSX.Element;
+interface Props {
+    id: string;
+    children: (params: {
+        typeClass: string;
+    }) => ReactNode | ReactNode;
+    type: 'full' | 'full-column' | 'left' | 'small-left' | 'right' | 'small-right' | 'xsmall-right' | 'xsmall-left';
+    resizeIframe?: boolean;
+    noFigcaption?: boolean;
+}
+export default Figure;

package/lib/Figure/FigureExpandButton.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) 2019-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 declare function FigureExpandButton({ messages, typeClass }: Props): JSX.Element;
+interface Props {
+    messages: {
+        zoomImageButtonLabel: string;
+        zoomOutImageButtonLabel: string;
+    };
+    typeClass: string;
+}
+export {};

package/lib/Figure/FigureLicense.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2018-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 { ReactNode } from 'react';
+import BEMHelper from 'react-bem-helper';
+import { FigureLicense } from './Figure';
+import { Contributor } from '../types';
+export declare const classLicenses: BEMHelper<BEMHelper.ReturnObject>;
+interface FigureLicenseCtaProps {
+    children?: ReactNode;
+    origin?: string;
+    authors?: Contributor[];
+    messages: {
+        source: string;
+        title: string;
+    };
+    title?: string;
+}
+export declare const FigureLicenseCta: ({ children, messages, authors, origin, title }: FigureLicenseCtaProps) => JSX.Element;
+interface Props {
+    messages: {
+        modelPremission?: string;
+        learnAboutLicenses: string;
+    };
+    license: FigureLicense;
+    locale: string;
+}
+export declare const FigureLicenseByline: ({ messages, license, locale }: Props) => JSX.Element;
+export {};

package/lib/Figure/FigureLicenseDialog.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) 2017-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 { ReactNode } from 'react';
+import { FigureLicense } from './Figure';
+import { Contributor } from '../types';
+export declare const FigureLicenseDialog: ({ children, messages, id, authors, origin, title, locale, license }: Props) => JSX.Element;
+interface Props {
+    id: string;
+    children?: ReactNode;
+    origin?: string;
+    authors?: Contributor[];
+    messages: {
+        modelPremission?: string;
+        close: string;
+        rulesForUse: string;
+        source: string;
+        learnAboutLicenses: string;
+        title: string;
+    };
+    title?: string;
+    license: FigureLicense;
+    locale: string;
+}
+export {};

package/{es/Figure/index.js → lib/Figure/index.d.ts}

@@ -9,4 +9,4 @@ import Figure, { FigureCaption } from './Figure';
 export { Figure, FigureCaption };
 export { FigureLicenseDialog } from './FigureLicenseDialog';
 export { FigureExpandButton } from './FigureExpandButton';
-export { FigureBylineExpandButton } from './FigureBylineExpandButton';
+export { FigureBylineExpandButton } from './FigureBylineExpandButton';

package/lib/FileList/File.d.ts

@@ -0,0 +1,7 @@
+import { FileType } from './FileList';
+interface Props {
+    id: string;
+    file: FileType;
+}
+declare const File: ({ file, id }: Props) => JSX.Element;
+export default File;

package/lib/FileList/FileList.d.ts

@@ -0,0 +1,17 @@
+export interface FileType {
+    title: string;
+    formats: FileFormat[];
+    fileExists?: boolean;
+}
+export interface FileFormat {
+    url: string;
+    fileType: string;
+    tooltip: string;
+}
+interface Props {
+    id: string;
+    heading: string;
+    files: FileType[];
+}
+declare const FileList: ({ files, heading, id }: Props) => JSX.Element;
+export default FileList;

package/{es/FileList/index.js → lib/FileList/index.d.ts}

@@ -1,3 +1,3 @@
 import FileList from './FileList';
 export { default as File } from './File';
-export default FileList;
+export default FileList;

package/lib/Hero/Hero.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { ReactNode } from 'react';
+interface HeroProps {
+    children?: ReactNode;
+    contentType: 'subject-material' | 'tasks-and-activities' | 'assessment-resources' | 'subject' | 'external-learning-resources' | 'source-material' | 'learning-path' | 'topic' | 'beta' | 'ndla-film' | 'ndla-film has-image';
+}
+export declare const Hero: ({ children, contentType }: HeroProps) => JSX.Element;
+interface Props {
+    children?: ReactNode;
+}
+export declare const SubjectMaterialHero: (props: Props) => JSX.Element;
+export declare const TasksAndActivitiesHero: (props: Props) => JSX.Element;
+export declare const AssessmentResourcesHero: (props: Props) => JSX.Element;
+export declare const SubjectHero: (props: Props) => JSX.Element;
+export declare const ExternalLearningResourcesHero: (props: Props) => JSX.Element;
+export declare const SourceMaterialHero: (props: Props) => JSX.Element;
+export declare const NdlaFilmHero: ({ hasImage, ...rest }: Props & {
+    hasImage?: boolean | undefined;
+}) => JSX.Element;
+export {};

package/{es/Hero/index.js → lib/Hero/index.d.ts}

@@ -5,4 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  *
  */
-export { SubjectMaterialHero, TasksAndActivitiesHero, AssessmentResourcesHero, SubjectHero, ExternalLearningResourcesHero, SourceMaterialHero, Hero, NdlaFilmHero } from './Hero';
+export { SubjectMaterialHero, TasksAndActivitiesHero, AssessmentResourcesHero, SubjectHero, ExternalLearningResourcesHero, SourceMaterialHero, Hero, NdlaFilmHero, } from './Hero';

package/lib/Image/Image.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2017-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 { ReactNode } from 'react';
+import { ImageCrop, ImageFocalPoint } from '../types';
+export declare const makeSrcQueryString: (width: number | undefined, crop?: ImageCrop | undefined, focalPoint?: ImageFocalPoint | undefined) => string;
+interface Props {
+    alt: string;
+    src: string;
+    sizes?: string;
+    fallbackWidth?: number;
+    contentType?: string;
+    srcSet?: string;
+    lazyLoad?: boolean;
+    lazyLoadSrc?: string;
+    expandButton?: ReactNode;
+    crop?: ImageCrop;
+    focalPoint?: ImageFocalPoint;
+}
+declare const Image: ({ alt, src, lazyLoad, lazyLoadSrc, crop, focalPoint, contentType, sizes, expandButton, ...rest }: Props) => JSX.Element;
+export default Image;

package/lib/Image/ImageLink.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2019-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 { ReactNode } from 'react';
+import { ImageCrop, ImageFocalPoint } from '../types';
+interface Props {
+    src: string;
+    children: ReactNode;
+    sizes?: string;
+    crop?: ImageCrop;
+    focalPoint?: ImageFocalPoint;
+}
+export declare function ImageLink({ src, crop, children, ...rest }: Props): JSX.Element;
+export {};

package/lib/Image/LazyLoadImage.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2017-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+interface Props {
+    alt: string;
+    src: string;
+    sizes?: string;
+    contentType?: string;
+    srcSet?: string;
+    lazyLoadSrc?: string;
+}
+declare const LazyLoadImage: ({ alt, src, srcSet, lazyLoadSrc, sizes, ...rest }: Props) => JSX.Element;
+export default LazyLoadImage;

package/{es/Image/index.js → lib/Image/index.d.ts}

@@ -8,4 +8,4 @@
 import Image from './Image';
 export { makeSrcQueryString } from './Image';
 export { ImageLink } from './ImageLink';
-export default Image;
+export default Image;

package/lib/InfoBox/InfoBox.d.ts

@@ -0,0 +1,6 @@
+import { ReactNode } from 'react';
+interface Props {
+    children?: ReactNode;
+}
+declare const InfoBox: ({ children }: Props) => JSX.Element;
+export default InfoBox;

package/lib/InfoWidget/InfoWidget.d.ts

@@ -0,0 +1,19 @@
+import { ReactNode } from 'react';
+interface Props {
+    heading: string;
+    description: string;
+    mainLink: {
+        name: string;
+        url?: string;
+        href?: string;
+    };
+    iconLinks: {
+        name: string;
+        url?: string;
+        href?: string;
+        icon: ReactNode;
+    }[];
+    center?: boolean;
+}
+declare const InfoWidget: ({ heading, description, mainLink, iconLinks, center }: Props) => JSX.Element;
+export default InfoWidget;

package/{es/InfoWidget/index.js → lib/InfoWidget/index.d.ts}

@@ -1,2 +1,2 @@
 import InfoWidget from './InfoWidget';
-export default InfoWidget;
+export default InfoWidget;

package/lib/Logo/Logo.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 BEMHelper from 'react-bem-helper';
+export declare const logoClasses: BEMHelper<BEMHelper.ReturnObject>;
+interface Props {
+    to?: string | {
+        pathname: string;
+        search?: string;
+        hash?: string;
+    };
+    label: string;
+    locale?: string;
+    cssModifier?: string;
+    large?: boolean;
+    name?: boolean;
+    color?: string;
+}
+export declare const Logo: ({ name, to, cssModifier, color, large, locale, label }: Props) => JSX.Element;
+export default Logo;

package/lib/Logo/SvgLogo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ *
+ */
+interface Props {
+    name?: boolean;
+    color?: string;
+    locale?: string;
+}
+export declare const SvgLogo: ({ name, color, locale }: Props) => JSX.Element;
+export default SvgLogo;

package/{es/Logo/index.js → lib/Logo/index.d.ts}

@@ -6,4 +6,4 @@
  *
  */
 import Logo from './Logo';
-export default Logo;
+export default Logo;

package/lib/Masthead/Masthead.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 } from 'react';
+import { WithTranslation } from 'react-i18next';
+interface MastheadItemProps {
+    children?: ReactNode;
+    className?: string;
+    right?: boolean;
+    left?: boolean;
+}
+export declare const MastheadItem: ({ children, className, left, right }: MastheadItemProps) => JSX.Element;
+interface Props {
+    children?: ReactNode;
+    fixed?: boolean;
+    showLoaderWhenNeeded?: boolean;
+    infoContent?: ReactNode;
+    ndlaFilm?: boolean;
+    skipToMainContentId?: string;
+}
+export declare const Masthead: ({ children, fixed, infoContent, showLoaderWhenNeeded, ndlaFilm, skipToMainContentId, t, }: Props & WithTranslation) => JSX.Element;
+declare const _default: React.ComponentType<Pick<Pick<Props & WithTranslation<"translation">, "fixed" | "children" | "t" | "tReady" | "ndlaFilm" | "infoContent" | "showLoaderWhenNeeded" | "skipToMainContentId">, "fixed" | "children" | "ndlaFilm" | "infoContent" | "showLoaderWhenNeeded" | "skipToMainContentId"> & import("react-i18next").WithTranslationProps>;
+export default _default;

package/{es/Masthead/index.js → lib/Masthead/index.d.ts}

@@ -7,4 +7,4 @@
  */
 import Masthead, { MastheadItem } from './Masthead';
 export { MastheadItem };
-export default Masthead;
+export default Masthead;

package/lib/NoContentBox/NoContentBox.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) 2017-present, NDLA.
+ *
+ * This source code is licensed under the GPLv3 license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+interface Props {
+    onClick?: () => void;
+    buttonText?: string;
+    text: string;
+}
+export declare const NoContentBox: ({ buttonText, text, onClick }: Props) => JSX.Element;
+export default NoContentBox;

package/{es/NoContentBox/index.js → lib/NoContentBox/index.d.ts}

@@ -6,4 +6,4 @@
  *
  */
 import NoContentBox from './NoContentBox';
-export default NoContentBox;
+export default NoContentBox;

package/lib/Portrait/Portrait.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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.
+ *
+ */
+interface Props {
+    src: string;
+    alt: string;
+    className?: string;
+    modifier?: 'small' | 'large';
+}
+declare const Portrait: ({ src, alt, modifier, className }: Props) => JSX.Element;
+export default Portrait;

package/{es/Portrait/index.js → lib/Portrait/index.d.ts}

@@ -6,4 +6,4 @@
  *
  */
 import Portrait from './Portrait';
-export default Portrait;
+export default Portrait;

package/lib/Topic/Topic.d.ts

@@ -7,6 +7,7 @@
  */
 import React from 'react';
 import { ItemProps } from '../Navigation/NavigationBox';
+import { ImageCrop, ImageFocalPoint } from '../types';
 declare type VisualElementProps = {
     type: 'image' | 'video' | 'other';
     element: React.ReactNode;
@@ -18,8 +19,8 @@ export declare type TopicProps = {
         image?: {
             url: string;
             alt: string;
-            crop?: object;
-            focalPoint?: object;
+            crop?: ImageCrop;
+            focalPoint?: ImageFocalPoint;
         };
         visualElement?: VisualElementProps;
         resources?: React.ReactNode;

package/lib/Translation/Translation.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 { ReactNode } from 'react';
+interface Props {
+    children: ReactNode;
+    index: number;
+}
+declare const Translation: ({ children, index }: Props) => JSX.Element;
+export default Translation;

package/lib/Translation/TranslationBox.d.ts

@@ -0,0 +1,10 @@
+import { ReactNode } from 'react';
+interface Props {
+    tabs: {
+        id: string;
+        title: string;
+        content: () => ReactNode | ReactNode;
+    }[];
+}
+declare const TranslationBox: ({ tabs }: Props) => JSX.Element;
+export default TranslationBox;

package/lib/Translation/TranslationLine.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 { ReactNode } from 'react';
+interface Props {
+    isTerm?: boolean;
+    children: ReactNode;
+    lang?: string;
+    langName?: string;
+}
+declare const TranslationLine: ({ children, lang, langName, isTerm }: Props) => JSX.Element;
+export default TranslationLine;

package/lib/index.d.ts

@@ -8,12 +8,26 @@
 /** @ts-ignore */
 export * from './index-javascript';
 export { ArticleByline, ArticleContent, ArticleFootNotes, ArticleIntroduction, ArticleTitle, ArticleWrapper, ArticleHeaderWrapper, ArticleSideBar, default as Article, } from './Article';
+export { default as NoContentBox } from './NoContentBox';
+export { default as Masthead, MastheadItem } from './Masthead';
+export { default as Portrait } from './Portrait';
+export { default as ContentLoader } from './ContentLoader';
 export { ErrorResourceAccessDenied, default as ErrorMessage } from './ErrorMessage';
+export { default as FileList, File } from './FileList';
 export { BlogPost, BlogPostWrapper } from './BlogPosts';
+export { default as Logo } from './Logo';
+export { InfoBox } from './InfoBox';
+export { default as InfoWidget } from './InfoWidget';
 export { FrontpageInfo, FrontpageFilm, FrontpageToolbox, FrontpageMultidisciplinarySubject, FrontpageHeader, FrontpageSubjectIllustration, FrontpageSearch, FrontpageProgramMenu, } from './Frontpage';
+export { default as Image, ImageLink } from './Image';
+export { makeSrcQueryString } from './Image';
+export { SubjectMaterialHero, TasksAndActivitiesHero, AssessmentResourcesHero, SubjectHero, ExternalLearningResourcesHero, SourceMaterialHero, Hero, NdlaFilmHero, } from './Hero';
 export { Footer, EditorName, FooterText, FooterAuth } from './Footer';
+export { Figure, FigureCaption, FigureLicenseDialog, FigureExpandButton } from './Figure';
 export { LanguageSelector } from './LanguageSelector';
 export { LearningPathWrapper, LearningPathContent, LearningPathMenu, LearningPathSticky, LearningPathInformation, LearningPathStickySibling, LearningPathStickyPlaceholder, LearningPathLastStepNavigation, LearningPathMobileStepInfo, LearningPathMobileHeader, } from './LearningPaths';
+export { Translation, TranslationLine, TranslationBox } from './Translation';
+export { default as Spinner } from './Spinner';
 export { default as SearchResultSleeve } from './Search/SearchResultSleeve';
 export { default as ContentTypeResult } from './Search/ContentTypeResult';
 export { SearchFieldForm } from './Search/SearchFieldForm';

package/lib/locale/messages-en.d.ts

@@ -818,6 +818,10 @@ declare const messages: {
         reuse: string;
         error: string;
     };
+    other: {
+        download: string;
+        reuse: string;
+    };
     concept: {
         showDescription: string;
         error: {

package/lib/locale/messages-nb.d.ts

@@ -818,6 +818,10 @@ declare const messages: {
         reuse: string;
         error: string;
     };
+    other: {
+        download: string;
+        reuse: string;
+    };
     concept: {
         showDescription: string;
         error: {

package/lib/locale/messages-nn.d.ts

@@ -818,6 +818,10 @@ declare const messages: {
         reuse: string;
         error: string;
     };
+    other: {
+        download: string;
+        reuse: string;
+    };
     concept: {
         showDescription: string;
         error: {