@dfds-ui/react-components 1.0.0 → 1.0.1-alpha.b9b3748c

package/assertions/banner/Banner.d.ts

@@ -1,5 +1,7 @@
-import React from 'react';
+import React, { ElementType, FunctionComponent, ReactNode } from 'react';
 import { Intent } from '../../common/intent';
+export declare type BannerVariant = 'lowEmphasis' | 'mediumEmphasis' | 'highEmphasis' | 'default' | 'inverted';
+export declare type BannerStickyPosition = 'top' | 'bottom';
 export declare type BannerProps = {
     /**
      * Specifies the intent of the Banner (change the color of the banner icon to match intended status)
@@ -8,7 +10,7 @@ export declare type BannerProps = {
     /**
      * Actions to be displayed inside the banner
      */
-    actions?: React.ReactNode;
+    actions?: ReactNode;
     /**
      * Class name to be added to the banner
      */
@@ -23,8 +25,10 @@ export declare type BannerProps = {
     closeLabel?: string;
     /**
      * Specifies the variation of the banner.
+     *
+     * `default` and `inverted` variants are deprecated
      */
-    variant?: 'default' | 'inverted';
+    variant?: BannerVariant;
     /**
      * Specifies if the Banner should be displayed with `position: fixed;`
      *
@@ -34,19 +38,33 @@ export declare type BannerProps = {
     /**
      * Specifies the position of the Sticky Banner.
      */
-    stickyPosition?: 'top' | 'bottom';
+    stickyPosition?: BannerStickyPosition;
     /**
-     * Specifies if the Banner should have a border/divider at the bottom`
+     * Specifies if the Banner should have a border/divider at the bottom.
      */
     divider?: boolean;
     /**
      * Specify a custom icon to replace the one derived from `intent`
      *
-     * @type {React.ElementType<{ className?: string }>}
+     * @type {ElementType<{ className?: string }>}
      */
-    icon?: React.ElementType<{
+    icon?: ElementType<{
         className?: string;
     }>;
+    /**
+     * Specifies if the actions should always appear below the content
+     */
+    wrapActions?: boolean;
+    /**
+     * Content of the Banner
+     */
+    children?: ReactNode;
 };
-declare const Banner: React.FunctionComponent<BannerProps>;
+interface BannerContextInterface {
+    intent: NonNullable<BannerProps['intent']>;
+    variant: NonNullable<BannerProps['variant']>;
+}
+export declare const BannerContext: React.Context<BannerContextInterface | undefined>;
+export declare const useBannerContext: () => BannerContextInterface;
+export declare const Banner: FunctionComponent<BannerProps>;
 export default Banner;