@linzjs/lui 17.28.2 → 17.29.1-0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [17.29.0](https://github.com/linz/lui/compare/v17.28.2...v17.29.0) (2023-02-01)
+
+
+### Features
+
+* **LuiFloatingWindow:** new component extracted from Search LuiFloatingWindow ([#832](https://github.com/linz/lui/issues/832)) ([c186e94](https://github.com/linz/lui/commit/c186e949318b6cf34b1746f894ee869ee8db55ed))
+
 ## [17.28.2](https://github.com/linz/lui/compare/v17.28.1...v17.28.2) (2023-01-30)
 
 

package/dist/components/LuiFloatingWindow/LuiFloatingWindow.d.ts

@@ -0,0 +1,15 @@
+import React, { ReactElement } from 'react';
+export { FloatingWindowContextProvider as LuiFloatingWindowContextProvider, useFloatingWindow as useLuiFloatingWindow, } from '@linzjs/floating-windows';
+export interface ILuiFloatingWindowProps {
+    callbackOnPopinFloatingWindow?: () => void;
+    callbackOnPopoutFloatingWindow?: () => void;
+    callbackOnCloseFloatingWindow?: () => void;
+    dockUndockFloatingWindow?: () => void;
+    startHeight?: number;
+    startWidth?: number;
+    rightSideHeader?: ReactElement | string;
+    leftSideHeader?: ReactElement | string;
+    startDisplayed?: boolean;
+}
+export declare const LUI_WINDOW_NAME = "luiFloatingWindow";
+export declare const LuiFloatingWindow: React.FC<ILuiFloatingWindowProps>;

package/dist/components/LuiFloatingWindow/LuiFloatingWindowHeaders.d.ts

@@ -0,0 +1,11 @@
+import React, { ReactElement } from 'react';
+import '../../scss/Components/LuiFloatingWindow/LuiFloatingWindow.scss';
+export declare const LuiFloatingWindowHeader: React.FC<{
+    rightSideHeader?: ReactElement | string;
+    leftSideHeader?: ReactElement | string;
+    isPoppedOut: boolean;
+    onDock?: () => void;
+    onPopout?: () => void;
+    onPopin?: () => void;
+    onClose?: () => void;
+}>;

package/dist/components/LuiHeader/LuiHeader.d.ts

@@ -9,6 +9,9 @@ interface HeaderProps {
     transparent?: boolean;
     sticky?: boolean;
 }
+/**
+ * @deprecated: this is replaced by LuiHeaderV2
+ */
 declare const LuiHeader: React.FC<React.PropsWithChildren<HeaderProps>>;
 interface ILuiIcon {
     /**
@@ -39,6 +42,8 @@ interface ILuiHeaderMenuItem extends ILuiIcon {
     'data-testid'?: string;
 }
 /**
+ * @deprecated: this is replaced by LuiHeaderMenuItemV2
+ *
  * The \`LuiHeaderMenuItem\` is the base component for all menu items that are to be shown in the header.
  * Note that it depends on it being rendered inside a LuiHeader for its styles to apply properly.
  * To configure the item for responsiveness, ensure to set any of the hideOn* properties.
@@ -56,6 +61,9 @@ interface ILuiCloseableHeaderMenuItem extends Omit<ILuiHeaderMenuItem, 'onClick'
     open: boolean;
     setOpen: (value: boolean) => void;
 }
+/**
+ * @deprecated replaced by LuiCloseableHeaderMenuItemV2
+ */
 declare const LuiCloseableHeaderMenuItem: React.FC<React.PropsWithChildren<ILuiCloseableHeaderMenuItem>>;
 interface ILuiMenuCloseButton extends ILuiIcon {
     'data-testid'?: string;

package/dist/components/LuiHeader/LuiHeaderV2.d.ts

@@ -0,0 +1,16 @@
+import React, { ReactNode } from 'react';
+import { HeaderSize, ILuiCloseableHeaderMenuItem, ILuiHeaderMenuItem } from './LuiHeader';
+interface HeaderPropsV2 {
+    headingText?: string;
+    size?: HeaderSize;
+    homeLink?: string | (() => void);
+    transparent?: boolean;
+    sticky?: boolean;
+    appMenu?: ReactNode;
+}
+declare const LuiHeaderV2: React.FC<React.PropsWithChildren<HeaderPropsV2>>;
+declare const LuiHeaderMenuItemV2: React.ForwardRefExoticComponent<ILuiHeaderMenuItem & {
+    children?: React.ReactNode;
+} & React.RefAttributes<HTMLDivElement>>;
+declare const LuiCloseableHeaderMenuItemV2: React.FC<React.PropsWithChildren<ILuiCloseableHeaderMenuItem>>;
+export { LuiHeaderV2, LuiHeaderMenuItemV2, LuiCloseableHeaderMenuItemV2 };

package/dist/components/LuiHeaderMenu/LuiHeaderMenus.d.ts

@@ -18,13 +18,25 @@ interface ILuiDrawerMenuOption {
      */
     onClick?: () => void;
 }
+/**
+ * @deprecated replaced by LuiDrawerMenuOptionsV2
+ */
 declare const LuiDrawerMenuOptions: React.FC<React.PropsWithChildren<ILuiIcon>>;
+/**
+ * @deprecated replaced by LuiDrawerMenuOptionV2
+ */
 declare const LuiDrawerMenuOption: React.FC<React.PropsWithChildren<ILuiDrawerMenuOption>>;
 declare type ILuiDrawerMenu = Omit<ILuiHeaderMenuItem, 'onClick'> & {
     hasStickyHeader?: boolean;
 };
+/**
+ * @deprecated replaced by LuiDrawerMenuV2
+ */
 declare const LuiDrawerMenu: React.FC<React.PropsWithChildren<ILuiDrawerMenu>>;
 declare type ILuiDropdownMenu = Omit<ILuiHeaderMenuItem, 'onClick'>;
+/**
+ * @deprecated  replaced by LuiDropdownMenuV2
+ */
 declare const LuiDropdownMenu: React.FC<React.PropsWithChildren<ILuiDropdownMenu>>;
 interface ILuiDrawerMenuSection {
     /**

package/dist/components/LuiHeaderMenu/LuiHeaderMenusV2.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import { ILuiHeaderMenuItem, ILuiIcon } from '../LuiHeader/LuiHeader';
+import { ILuiDrawerMenu, ILuiDrawerMenuOption, ILuiDrawerMenuSection } from './LuiHeaderMenus';
+import { Size } from '../common/ResponsiveUtils';
+declare const LuiDrawerMenuOptionsV2: React.FC<React.PropsWithChildren<ILuiIcon>>;
+/**
+ * display badge on the left
+ */
+declare const LuiDrawerMenuOptionV2: React.FC<React.PropsWithChildren<ILuiDrawerMenuOption>>;
+declare const LuiDrawerMenuV2: React.FC<React.PropsWithChildren<ILuiDrawerMenu>>;
+declare type ILuiDropdownMenuV2 = Omit<ILuiHeaderMenuItem, 'onClick'> & {
+    /**
+     * The anchor origin of dropdown, default to left
+     */
+    anchorOrigin?: {
+        horizontal?: 'left' | 'right';
+    };
+    /**
+     * the width of dropdown, default to 'md'
+     */
+    size?: Size | 'xxl';
+};
+declare const LuiDropdownMenuV2: React.FC<React.PropsWithChildren<ILuiDropdownMenuV2>>;
+declare const LuiDrawerMenuSectionV2: (props: ILuiDrawerMenuSection) => JSX.Element;
+declare const LuiDrawerMenuDividerV2: () => JSX.Element;
+export { LuiDrawerMenuV2, LuiDrawerMenuOptionsV2, LuiDrawerMenuOptionV2, ILuiDropdownMenuV2, LuiDropdownMenuV2, LuiDrawerMenuSectionV2, LuiDrawerMenuDividerV2, };

package/dist/components/common/UseMediaQuery.d.ts

@@ -0,0 +1,9 @@
+import { Size } from './ResponsiveUtils';
+export declare type Breakpoint = Exclude<Size | 'xxl', 'xs'>;
+export declare const breakpoints: Record<Breakpoint, number>;
+export declare const breakpointQuery: {
+    up: (bp: Breakpoint) => string;
+    down: (bp: Breakpoint) => string;
+    between: (bp1: Breakpoint, bp2: Breakpoint) => string;
+};
+export declare const useMediaQuery: (query: string) => boolean;

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { LuiBanner, LuiBannerContent } from './components/LuiBanner/LuiBanner';
 export { LuiStaticMessage } from './components/LuiStaticMessage/LuiStaticMessage';
 export { LuiButton } from './components/LuiButton/LuiButton';
+export { LuiFloatingWindow, ILuiFloatingWindowProps, LUI_WINDOW_NAME, LuiFloatingWindowContextProvider, useLuiFloatingWindow, } from './components/LuiFloatingWindow/LuiFloatingWindow';
 export * from './components/LuiToastMessage/LuiToastMessage';
 export * from './contexts/LuiMessagingContextProvider';
 export { LuiButtonGroup } from './components/LuiButton/LuiButton';
@@ -35,7 +36,9 @@ export { LuiFooter } from './components/LuiFooter/LuiFooter';
 export { LuiComboSelect, LuiComboSelectProps, LuiComboSelectOption, } from './components/LuiForms/LuiComboSelect/LuiComboSelect';
 export { LuiFormSectionHeader, IFormSectionHeaderProps, } from './components/LuiForms/LuiFormSection/LuiFormSectionHeader';
 export * from './components/LuiHeader/LuiHeader';
+export * from './components/LuiHeader/LuiHeaderV2';
 export * from './components/LuiHeaderMenu/LuiHeaderMenus';
+export * from './components/LuiHeaderMenu/LuiHeaderMenusV2';
 export { LuiUpdatesSplashModal } from './components/LuiUpdateSplashModal/LuiUpdatesSplashModal';
 export { LuiModal, LuiAlertModal, LuiAlertModalButtons, } from './components/LuiModal/LuiModal';
 export { ISearchInputProps, ISearchGroupedResult, ISearchResult, LuiSearchInput, } from './components/LuiSearchInput/LuiSearchInput';
@@ -66,3 +69,4 @@ export { RadioItemRenderer } from './components/LuiListBox/Renderers/RadioItemRe
 export { CheckboxItemRenderer } from './components/LuiListBox/Renderers/CheckboxItemRenderer';
 export { LuiSideMenu, ILuiSideMenuProps, } from './components/LuiSideMenu/LuiSideMenu';
 export { LuiSideMenuItem, ILuiSideMenuItemProps, LuiMenuItemClickHandler, } from './components/LuiSideMenu/LuiSideMenuItem';
+export { Breakpoint, breakpoints, breakpointQuery, useMediaQuery, } from './components/common/UseMediaQuery';