@dnb/eufemia 9.23.0-beta.1 → 9.23.0-beta.2

package/components/global-error/GlobalError.d.ts

@@ -1,64 +1,82 @@
-export default class GlobalError extends React.PureComponent<any, any, any> {
-    static tagName: string;
-    static contextType: React.Context<{
-        translation: any;
-        updateTranslation: (locale: any, translation: any) => void;
-        getTranslation: (props: any) => any;
-        locales: any;
-        Avatar: {};
-        AvatarGroup: {};
-        Breadcrumb: {};
-        BreadcrumbItem: {};
-        InfoCard: {};
-        Tag: {};
-        TagGroup: {};
-        Timeline: {};
-        TimelineItem: {};
-        VisuallyHidden: {};
-        Drawer: {};
-        Dialog: {};
-    }>;
-    static propTypes: {
-        className: PropTypes.Requireable<string>;
-        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        class: PropTypes.Requireable<string>;
-        space: PropTypes.Requireable<string | number | boolean | PropTypes.InferProps<{
-            top: PropTypes.Requireable<string | number | boolean>;
-            right: PropTypes.Requireable<string | number | boolean>;
-            bottom: PropTypes.Requireable<string | number | boolean>;
-            left: PropTypes.Requireable<string | number | boolean>;
-        }>>;
-        top: PropTypes.Requireable<string | number | boolean>;
-        right: PropTypes.Requireable<string | number | boolean>;
-        bottom: PropTypes.Requireable<string | number | boolean>;
-        left: PropTypes.Requireable<string | number | boolean>;
-        status: PropTypes.Requireable<string>;
-        status_content: PropTypes.Requireable<string | object>;
-        title: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        text: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        back: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        href: PropTypes.Requireable<string>;
-        alt: PropTypes.Requireable<string>;
+import * as React from 'react';
+export type GlobalErrorStatusContent = string | Object;
+export type GlobalErrorTitle = string | React.ReactNode;
+export type GlobalErrorText = string | React.ReactNode;
+export type GlobalErrorBack = string | React.ReactNode;
+export type GlobalErrorSpace =
+  | string
+  | number
+  | boolean
+  | {
+      top?: string | number | boolean;
+      right?: string | number | boolean;
+      bottom?: string | number | boolean;
+      left?: string | number | boolean;
     };
-    static defaultProps: {
-        status: any;
-        status_content: any;
-        back: string;
-        title: any;
-        text: any;
-        href: any;
-        alt: any;
-        className: any;
-        children: any;
-        class: any;
-    };
-    static enableWebComponent(): void;
-    static getContent(props: any): any;
-    constructor(props: any);
-    constructor(props: any, context: any);
-    backHandler: (e: any) => void;
-    getHref(): any;
-    hasHistory: () => number | false;
+export type GlobalErrorTop = string | number | boolean;
+export type GlobalErrorRight = string | number | boolean;
+export type GlobalErrorBottom = string | number | boolean;
+export type GlobalErrorLeft = string | number | boolean;
+export type GlobalErrorChildren =
+  | string
+  | ((...args: any[]) => any)
+  | React.ReactNode;
+
+/**
+ * NB: Do not change the docs (comments) in here. The docs are updated during build time by "generateTypes.js" and "fetchPropertiesFromDocs.js".
+ */
+export interface GlobalErrorProps extends React.HTMLProps<HTMLElement> {
+  /**
+   * Status code defines the view showing up.
+   */
+  status?: string;
+
+  /**
+   * A JSON object or a JS object providing the status texts. More details below.
+   */
+  status_content?: GlobalErrorStatusContent;
+
+  /**
+   * Defining a `title` will overwrite the default provided by `status_content`.
+   */
+  title?: GlobalErrorTitle;
+
+  /**
+   * Defining a `text` will overwrite the default provided by `status_content`.
+   */
+  text?: GlobalErrorText;
+
+  /**
+   * The text of the back button. Defaults to `Tilbake`. Can also be a React component.
+   */
+  back?: GlobalErrorBack;
+
+  /**
+   * Instead of using the default `window.history.back()` you can provide the back button and text link with a url.
+   */
+  href?: string;
+
+  /**
+   * Defining a `alt` text for the SVG graphic will overwrite the default provided by `status_content`.
+   */
+  alt?: string;
+  space?: GlobalErrorSpace;
+  top?: GlobalErrorTop;
+  right?: GlobalErrorRight;
+  bottom?: GlobalErrorBottom;
+  left?: GlobalErrorLeft;
+  className?: string;
+
+  /**
+   * If needed, add additional content under the main content.
+   */
+  children?: GlobalErrorChildren;
+  class?: string;
+}
+export default class GlobalError extends React.Component<
+  GlobalErrorProps,
+  any
+> {
+  static defaultProps: object;
+  render(): JSX.Element;
 }
-import React from "react";
-import PropTypes from "prop-types";

package/components/global-status/GlobalStatus.d.ts

@@ -1,146 +1,207 @@
-declare class GlobalStatus extends React.PureComponent<any, any, any> {
-    static tagName: string;
-    static contextType: React.Context<{
-        translation: any;
-        updateTranslation: (locale: any, translation: any) => void;
-        getTranslation: (props: any) => any;
-        locales: any;
-        Avatar: {};
-        AvatarGroup: {};
-        Breadcrumb: {};
-        BreadcrumbItem: {};
-        InfoCard: {};
-        Tag: {};
-        TagGroup: {};
-        Timeline: {};
-        TimelineItem: {};
-        VisuallyHidden: {};
-        Drawer: {};
-        Dialog: {};
-    }>;
-    static propTypes: {
-        class: PropTypes.Requireable<string>;
-        className: PropTypes.Requireable<string>;
-        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        on_adjust: PropTypes.Requireable<(...args: any[]) => any>;
-        on_open: PropTypes.Requireable<(...args: any[]) => any>;
-        on_show: PropTypes.Requireable<(...args: any[]) => any>;
-        on_close: PropTypes.Requireable<(...args: any[]) => any>;
-        on_hide: PropTypes.Requireable<(...args: any[]) => any>;
-        space: PropTypes.Requireable<string | number | boolean | PropTypes.InferProps<{
-            top: PropTypes.Requireable<string | number | boolean>;
-            right: PropTypes.Requireable<string | number | boolean>;
-            bottom: PropTypes.Requireable<string | number | boolean>;
-            left: PropTypes.Requireable<string | number | boolean>;
-        }>>;
-        top: PropTypes.Requireable<string | number | boolean>;
-        right: PropTypes.Requireable<string | number | boolean>;
-        bottom: PropTypes.Requireable<string | number | boolean>;
-        left: PropTypes.Requireable<string | number | boolean>;
-        id: PropTypes.Requireable<string>;
-        status_id: PropTypes.Requireable<string>;
-        title: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        default_title: PropTypes.Requireable<string>;
-        text: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        items: PropTypes.Requireable<string | any[] | ((...args: any[]) => any)>;
-        icon: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        icon_size: PropTypes.Requireable<string>;
-        state: PropTypes.Requireable<string>;
-        show: PropTypes.Requireable<string | boolean>;
-        autoscroll: PropTypes.Requireable<string | boolean>;
-        autoclose: PropTypes.Requireable<string | boolean>;
-        no_animation: PropTypes.Requireable<string | boolean>;
-        delay: PropTypes.Requireable<string | number>;
-        close_text: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        hide_close_button: PropTypes.Requireable<string | boolean>;
-        omit_set_focus: PropTypes.Requireable<string | boolean>;
-        omit_set_focus_on_update: PropTypes.Requireable<string | boolean>;
-        status_anchor_text: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        skeleton: PropTypes.Requireable<string | boolean>;
+import * as React from 'react';
+export type GlobalStatusTitle = React.ReactNode | boolean;
+export type GlobalStatusText =
+  | string
+  | ((...args: any[]) => any)
+  | React.ReactNode;
+export type GlobalStatusItems = string | ((...args: any[]) => any) | any[];
+export type GlobalStatusIcon =
+  | string
+  | ((...args: any[]) => any)
+  | React.ReactNode;
+export type GlobalStatusState = 'error' | 'info';
+export type GlobalStatusShow = 'auto' | any | any | 'true' | 'false';
+export type GlobalStatusAutoscroll = string | boolean;
+export type GlobalStatusAutoclose = string | boolean;
+export type GlobalStatusNoAnimation = string | boolean;
+export type GlobalStatusDelay = string | number;
+export type GlobalStatusHideCloseButton = string | boolean;
+export type GlobalStatusOmitSetFocus = string | boolean;
+export type GlobalStatusOmitSetFocusOnUpdate = string | boolean;
+export type GlobalStatusSkeleton = string | boolean;
+export type GlobalStatusSpace =
+  | string
+  | number
+  | boolean
+  | {
+      /**
+       * Use spacing values like: `small`, `1rem`, `1` or , `16px`. Will use `margin-top`.
+       */
+      top?: string | number | boolean;
+
+      /**
+       * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-right`.
+       */
+      right?: string | number | boolean;
+
+      /**
+       * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-bottom`.
+       */
+      bottom?: string | number | boolean;
+
+      /**
+       * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-left`.
+       */
+      left?: string | number | boolean;
     };
-    static defaultProps: {
-        id: string;
-        status_id: string;
-        title: any;
-        default_title: any;
-        text: any;
-        items: any[];
-        icon: string;
-        icon_size: string;
-        state: string;
-        show: string;
-        autoscroll: boolean;
-        autoclose: boolean;
-        no_animation: boolean;
-        close_text: string;
-        hide_close_button: boolean;
-        omit_set_focus: boolean;
-        omit_set_focus_on_update: boolean;
-        delay: number;
-        status_anchor_text: any;
-        skeleton: any;
-        class: any;
-        className: any;
-        children: any;
-        on_adjust: any;
-        on_open: any;
-        on_show: any;
-        on_close: any;
-        on_hide: any;
-    };
-    static enableWebComponent(): void;
-    static getContent(props: any): any;
-    static getIcon({ state, icon, icon_size }: {
-        state: any;
-        icon: any;
-        icon_size: any;
-    }): any;
-    static getDerivedStateFromProps(props: any, state: any): any;
-    constructor(props: any);
-    _wrapperRef: React.RefObject<any>;
-    _shellRef: React.RefObject<any>;
-    anim: AnimateHeight;
-    provider: import("./GlobalStatusProvider").GlobalStatusProviderItem;
-    _globalStatus: any;
-    adjustHeight: any;
-    _hadContent: boolean;
-    initialActiveElement: Element;
-    hasContent(globalStatus: any): boolean;
-    correctStatus(state: any): any;
-    isPassive: () => boolean;
-    setVisible: ({ delay }?: {
-        delay?: number;
-    }) => void;
-    _visibleTimeout: NodeJS.Timeout;
-    setHidden: ({ delay }?: {
-        delay?: number;
-    }) => void;
-    _hiddenTimeout: NodeJS.Timeout;
-    onKeyDownHandler: (e: any) => void;
-    setFocus(): void;
-    closeHandler: () => void;
-    scrollToStatus(isDone?: any): void;
-    _scrollToStatusTimeout: NodeJS.Timeout;
-    gotoItem: (event: any, item: any) => void;
-    itemsRenderHandler: ({ status_anchor_text, lang }: {
-        status_anchor_text: any;
-        lang: any;
-    }) => (item: any, i: any) => JSX.Element;
+export type GlobalStatusTop = string | number | boolean;
+export type GlobalStatusRight = string | number | boolean;
+export type GlobalStatusBottom = string | number | boolean;
+export type GlobalStatusLeft = string | number | boolean;
+export type GlobalStatusChildren =
+  | string
+  | ((...args: any[]) => any)
+  | React.ReactNode;
+
+/**
+ * NB: Do not change the docs (comments) in here. The docs are updated during build time by "generateTypes.js" and "fetchPropertiesFromDocs.js".
+ */
+export interface GlobalStatusProps extends React.HTMLProps<HTMLElement> {
+  /**
+   * The main ID. Defaults to the prop
+   */
+  id?: string;
+  status_id?: string;
+
+  /**
+   * The title appears as a part of the status content. Use `false` to hide / remove the title and icon. Defaults to `En feil har skjedd`.
+   */
+  title?: GlobalStatusTitle;
+  default_title?: string;
+
+  /**
+   * The text appears as the status content. Besides plain text, you can send in a React component as well. Defaults to `null`.
+   */
+  text?: GlobalStatusText;
+
+  /**
+   * The items (list items) appear as a part of the status content. you can both use an JSON array, or a vanilla array with a string or an object content. Se "Item Object" example below.
+   */
+  items?: GlobalStatusItems;
+
+  /**
+   * The icon shown before the status title. Defaults to `exclamation`.
+   */
+  icon?: GlobalStatusIcon;
+
+  /**
+   * The icon size of the title icon shows. Defaults to `medium`.
+   */
+  icon_size?: string;
+
+  /**
+   * Defines the visual appearance of the status. There are two main statuses `error` and `info`. The default status is `error`.
+   */
+  state?: GlobalStatusState;
+
+  /**
+   * Set to `true` or `false` to manually make the global status visible. Defaults to `true`.
+   */
+  show?: GlobalStatusShow;
+
+  /**
+   * Set to `true` to automatically scroll the page to the appeared global status. Defaults to `true`.
+   */
+  autoscroll?: GlobalStatusAutoscroll;
+
+  /**
+   * Set to `true` to automatically close the global status if there are no more left items in the provider stack. Defaults to `true`.
+   */
+  autoclose?: GlobalStatusAutoclose;
+
+  /**
+   * Set to `true` to disable the show/hide/slide/fade/grow/shrink animation. Defaults to `false`.
+   */
+  no_animation?: GlobalStatusNoAnimation;
+
+  /**
+   * Defines the delay on how long the automated visibility should wait before it appears to the user. Defaults to `200ms`.
+   */
+  delay?: GlobalStatusDelay;
+
+  /**
+   * Text of the close button. Defaults to `Lukk`.
+   */
+  close_text?: React.ReactNode;
+
+  /**
+   * Set to `true` if the close button should be hidden for the user. Defaults to `false`.
+   */
+  hide_close_button?: GlobalStatusHideCloseButton;
+
+  /**
+   * Set to `true` to omit setting the focus during visibility. Defaults to `false`. Additionally, there is `omit_set_focus_on_update` which is set to `true` by default.
+   */
+  omit_set_focus?: GlobalStatusOmitSetFocus;
+  omit_set_focus_on_update?: GlobalStatusOmitSetFocusOnUpdate;
+
+  /**
+   * Defines the anchor text showing up after every item, in case there is a `status_id` defined. Defaults to `Gå til %s`. The `%s` represents the optional and internal handled label addition.
+   */
+  status_anchor_text?: React.ReactNode;
+  skeleton?: GlobalStatusSkeleton;
+
+  /**
+   * Has to be an object with either: `top`, `right`, `bottom` or `left`. Use spacing values like: `small`, `1rem`, `1` or , `16px`.
+   */
+  space?: GlobalStatusSpace;
+
+  /**
+   * Use spacing values like: `small`, `1rem`, `1` or , `16px`. Will use `margin-top`.
+   */
+  top?: GlobalStatusTop;
+
+  /**
+   * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-right`.
+   */
+  right?: GlobalStatusRight;
+
+  /**
+   * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-bottom`.
+   */
+  bottom?: GlobalStatusBottom;
+
+  /**
+   * Use spacing values like: `small`, `1rem`, `1` or , `16px`. will use `margin-left`.
+   */
+  left?: GlobalStatusLeft;
+  class?: string;
+  className?: string;
+
+  /**
+   * The text appears as the status content. Besides plain text, you can send in a React component as well. Defaults to `null`.
+   */
+  children?: GlobalStatusChildren;
+
+  /**
+   * Gets triggered once the GlobalStatus is getting new content by the user. Returns `{ id, status_id, ...properties }`.
+   */
+  on_adjust?: (...args: any[]) => any;
+
+  /**
+   * Gets triggered the first time the GlobalStatus appears on the screen. In other words, it has to have been hidden before. Returns `{ id, status_id, ...properties }`.
+   */
+  on_open?: (...args: any[]) => any;
+
+  /**
+   * Gets triggered for the first time and for every new content update the GlobalStatus gets. Returns `{ id, status_id, ...properties }`.
+   */
+  on_show?: (...args: any[]) => any;
+
+  /**
+   * Gets triggered once the GlobalStatus disappears from the screen. Works only if `no_animation` is not `true`. Returns `{ id, status_id, ...properties }`.
+   */
+  on_close?: (...args: any[]) => any;
+
+  /**
+   * Gets triggered once the GlobalStatus is getting closed/hidden by the user. Returns `{ id, status_id, ...properties }`.
+   */
+  on_hide?: (...args: any[]) => any;
 }
-declare namespace GlobalStatus {
-    export function create(...args: any[]): GlobalStatusInterceptor;
-    import Set = create;
-    export { Set };
-    import AddStatus = create;
-    export { AddStatus };
-    import Update = create;
-    export { Update };
-    export { GlobalStatusController as Add };
-    export const Remove: typeof import("./GlobalStatusController").GlobalStatusRemove;
+export default class GlobalStatus extends React.Component<
+  GlobalStatusProps,
+  any
+> {
+  static defaultProps: object;
+  render(): JSX.Element;
 }
-export default GlobalStatus;
-import React from "react";
-import AnimateHeight from "../../shared/AnimateHeight";
-import PropTypes from "prop-types";
-import { GlobalStatusInterceptor } from "./GlobalStatusController";
-import GlobalStatusController from "./GlobalStatusController";

package/components/global-status/GlobalStatusController.d.ts

@@ -1,40 +1,40 @@
-export class GlobalStatusInterceptor {
-    constructor(props: any);
-    provider: any;
-    status_id: any;
-    add(props: any): any;
-    update(props: any): any;
-    remove(): any;
+import * as React from 'react';
+export type GlobalStatusControllerRemoveOnUnmount = string | boolean;
+
+/**
+ * NB: Do not change the docs (comments) in here. The docs are updated during build time by "generateTypes.js" and "fetchPropertiesFromDocs.js".
+ */
+export interface GlobalStatusControllerProps
+  extends React.HTMLProps<HTMLElement> {
+  /**
+   * The main ID. Defaults to the prop
+   */
+  id?: string;
+  status_id?: string;
+  remove_on_unmount?: GlobalStatusControllerRemoveOnUnmount;
 }
-export default GlobalStatusController;
-declare class GlobalStatusController extends React.PureComponent<any, any, any> {
-    static propTypes: {
-        id: PropTypes.Requireable<string>;
-        status_id: PropTypes.Requireable<string>;
-        remove_on_unmount: PropTypes.Requireable<string | boolean>;
-    };
-    static defaultProps: {
-        id: string;
-        status_id: any;
-        remove_on_unmount: boolean;
-    };
-    static getDerivedStateFromProps(props: any, state: any): any;
-    constructor(props: any);
+export default class GlobalStatusController extends React.Component<
+  GlobalStatusControllerProps,
+  any
+> {
+  static defaultProps: object;
+  render(): JSX.Element;
 }
-declare namespace GlobalStatusController {
-    export { GlobalStatusRemove as Remove };
-    export { GlobalStatusController as Update };
+
+/**
+ * NB: Do not change the docs (comments) in here. The docs are updated during build time by "generateTypes.js" and "fetchPropertiesFromDocs.js".
+ */
+export interface GlobalStatusRemoveProps {
+  /**
+   * The main ID. Defaults to the prop
+   */
+  id?: string;
+  status_id: string;
 }
-export class GlobalStatusRemove extends React.PureComponent<any, any, any> {
-    static propTypes: {
-        id: PropTypes.Requireable<string>;
-        status_id: PropTypes.Validator<string>;
-    };
-    static defaultProps: {
-        id: string;
-    };
-    static getDerivedStateFromProps(props: any, state: any): any;
-    constructor(props: any);
+export class GlobalStatusRemove extends React.Component<
+  GlobalStatusRemoveProps,
+  any
+> {
+  static defaultProps: object;
+  render(): JSX.Element;
 }
-import React from "react";
-import PropTypes from "prop-types";