@dnb/eufemia 10.0.0-beta.8 → 10.1.0

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

@@ -1,62 +1,64 @@
-import * as React from 'react';
-import type { SpacingProps } from '../space/types';
-export type GlobalErrorStatusContent = string | Record<string, unknown>;
-export type GlobalErrorTitle = string | React.ReactNode;
-export type GlobalErrorText = string | React.ReactNode;
-export type GlobalErrorBack = string | React.ReactNode;
-export type GlobalErrorChildren =
-  | string
-  | ((...args: any[]) => any)
-  | React.ReactNode;
-export interface GlobalErrorProps
-  extends React.HTMLProps<HTMLElement>,
-    SpacingProps {
-  /**
-   * 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;
-  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;
-}
+/**
+ * Web GlobalError Component
+ *
+ */
+import React from 'react';
+import { GetTranslationProps } from '../../shared/Context';
+import { SkeletonShow } from '../skeleton/Skeleton';
+import type { SpacingProps } from '../../shared/types';
+export declare type GlobalErrorLink = {
+    text: string;
+    url: string;
+};
+export declare type GlobalErrorProps = {
+    /**
+     * When `404` or `500` is given, a predefined text will be shown.
+     * Defaults to `400`.
+     */
+    status?: '404' | '500' | string;
+    /**
+     * Will overwrite the default title.
+     */
+    title?: React.ReactNode;
+    /**
+     * Will overwrite the default text.
+     */
+    text?: React.ReactNode;
+    /**
+     * Will overwrite the default error message code.
+     */
+    code?: React.ReactNode;
+    /**
+     * Will overwrite the default additional help text.
+     */
+    help?: React.ReactNode;
+    /**
+     * Provide an array with objects `{ text: 'Text', url: 'https://...' }` to display a list of anchor links.
+     */
+    links?: Array<GlobalErrorLink>;
+    /**
+     * If true, it will use 80vh as the height and center its content.
+     */
+    center?: boolean;
+    /**
+     * Skeleton should be applied when loading content
+     * Default: null
+     */
+    skeleton?: SkeletonShow;
+};
+export declare type GlobalErrorAllProps = GlobalErrorProps & Omit<React.HTMLProps<HTMLElement>, 'ref'> & SpacingProps & GetTranslationProps;
+export declare type GlobalErrorTranslationContent = {
+    /**
+     * Defining a `title` will overwrite the default provided by `status_content`.
+     */
+    title?: React.ReactNode;
+    /**
+     * Defining a `text` will overwrite the default provided by `status_content`.
+     */
+    text?: React.ReactNode;
+};
+export declare type GlobalErrorTranslation = {
+    404?: GlobalErrorTranslationContent;
+    500?: GlobalErrorTranslationContent;
+};
+export default function GlobalError(localProps: GlobalErrorAllProps): JSX.Element;