@equinor/echo-components 0.5.7 → 0.5.8-rc2

package/dist/components/echoCard/LinkSection.d.ts

@@ -1,8 +1,8 @@
-import React from 'react';
-import { CardIcons } from './Title';
-export declare type LinkSectionProps = {
-    children?: React.ReactNode;
-    linkSectionIcons?: CardIcons[];
-    className?: string;
-};
-export declare const LinkSection: ({ children, className, linkSectionIcons }: Partial<LinkSectionProps>) => JSX.Element;
+import React from 'react';
+import { CardIcons } from './Title';
+export declare type LinkSectionProps = {
+    children?: React.ReactNode;
+    linkSectionIcons?: CardIcons[];
+    className?: string;
+};
+export declare const LinkSection: ({ children, className, linkSectionIcons }: Partial<LinkSectionProps>) => JSX.Element;

package/dist/components/echoCard/Title.d.ts

@@ -1,13 +1,13 @@
-/// <reference types="react" />
-export interface CardIcons {
-    name: string;
-    color: string;
-    onClick?: () => void;
-}
-export declare type TitleProps = {
-    headerTitle?: string;
-    onHeaderClick?: () => void;
-    headerIcons?: CardIcons[];
-    className?: string;
-};
-export declare const Title: ({ headerTitle, headerIcons, className, onHeaderClick }: Partial<TitleProps>) => JSX.Element;
+/// <reference types="react" />
+export interface CardIcons {
+    name: string;
+    color: string;
+    onClick?: () => void;
+}
+export declare type TitleProps = {
+    headerTitle?: string;
+    onHeaderClick?: () => void;
+    headerIcons?: CardIcons[];
+    className?: string;
+};
+export declare const Title: ({ headerTitle, headerIcons, className, onHeaderClick }: Partial<TitleProps>) => JSX.Element;

package/dist/components/echoCard/index.d.ts

@@ -1,14 +1,14 @@
-import { Body, BodyProps } from './Body';
-import { DateSection, DateSectionProps } from './DateSection';
-import { EchoCard as BaseEchoCard, EchoCardProps } from './EchoCard';
-import { LinkSection } from './LinkSection';
-import { Title, TitleProps } from './Title';
-declare type CardType = typeof BaseEchoCard & {
-    Title: typeof Title;
-    Body: typeof Body;
-    LinkSection: typeof LinkSection;
-    DateSection: typeof DateSection;
-};
-declare const EchoCard: CardType;
-export { EchoCard };
-export type { EchoCardProps, TitleProps, DateSectionProps, BodyProps };
+import { Body, BodyProps } from './Body';
+import { DateSection, DateSectionProps } from './DateSection';
+import { EchoCard as BaseEchoCard, EchoCardProps } from './EchoCard';
+import { LinkSection } from './LinkSection';
+import { Title, TitleProps } from './Title';
+declare type CardType = typeof BaseEchoCard & {
+    Title: typeof Title;
+    Body: typeof Body;
+    LinkSection: typeof LinkSection;
+    DateSection: typeof DateSection;
+};
+declare const EchoCard: CardType;
+export { EchoCard };
+export type { EchoCardProps, TitleProps, DateSectionProps, BodyProps };

package/dist/components/echoHeader/EchoHeader.d.ts

@@ -1,20 +1,20 @@
-import React from 'react';
-export interface EchoHeaderProps {
-    moduleTitle: string;
-    moduleIcon: string | React.FC;
-    plantName?: string;
-    customHeaderSection?: React.FC;
-}
-/**
- * Component that renders the Echo header
- *
- * @param {EchoHeaderProps} {
- *    moduleTitle: the title of the module
- *    moduleIcon: the module Icon
- *    plantName: show the plant name next to the module title
- *    customSection: a section in the header where there can be custom components
- * }
- * @returns {*} {JSX.Element} Echo header with custom section
- */
-export declare const EchoHeader: React.FC<EchoHeaderProps>;
-export default EchoHeader;
+import React from 'react';
+export interface EchoHeaderProps {
+    moduleTitle: string;
+    moduleIcon: string | React.FC;
+    plantName?: string;
+    customHeaderSection?: React.FC;
+}
+/**
+ * Component that renders the Echo header
+ *
+ * @param {EchoHeaderProps} {
+ *    moduleTitle: the title of the module
+ *    moduleIcon: the module Icon
+ *    plantName: show the plant name next to the module title
+ *    customSection: a section in the header where there can be custom components
+ * }
+ * @returns {*} {JSX.Element} Echo header with custom section
+ */
+export declare const EchoHeader: React.FC<EchoHeaderProps>;
+export default EchoHeader;

package/dist/components/floatingActionButton/FloatingActionButton.d.ts

@@ -0,0 +1,29 @@
+import React from 'react';
+interface WithLabel {
+    variant: 'square_icon_with_text';
+    label: string;
+}
+interface WithoutLabel {
+    variant: 'circle_icon' | 'square_icon';
+    label?: never;
+}
+declare type MutuallyExclusiveVariantLabel = WithLabel | WithoutLabel;
+export declare type FloatingActionButtonProps = MutuallyExclusiveVariantLabel & {
+    iconName: string;
+    ariaLabel?: string;
+    /**
+     * Disable button if true
+     */
+    disabled?: boolean;
+    /**
+     * The method to be called when button is pressed
+     */
+    onClick: () => void;
+};
+/**
+ * Floating actions buttons exists within the viewport, seperated from any sheet, dialog or menu
+ * and are typically used for special actions pertaining to the module they are used in.
+ * @return {*}  {JSX.Element} Floating actions button
+ */
+declare const FloatingActionButton: React.FC<FloatingActionButtonProps>;
+export { FloatingActionButton };

package/dist/components/index.d.ts

@@ -1,15 +1,17 @@
-export * from './buttonWithPopover/ButtonWithPopover';
-export * from './contextMenu/ContextMenu';
-export * from './contextMenuPopover/DataInfoButton';
-export * from './datePicker/ReactDatePicker';
-export * from './dialogGenerator/DialogGenerator';
-export * from './dropdown/Dropdown';
-export * from './echoBottomBar/EchoBottomBar';
-export * from './echoCard/index';
-export * from './echoHeader/EchoHeader';
-export * from './inlineTagIconLink/InlineTagIconLink';
-export * from './listItem';
-export * from './listRow/ListRow';
-export * from './sidesheet';
-export * from './tagContextMenu/TagContextMenu';
-export * from './timePicker/TimePicker';
+export * from './buttonWithPopover/ButtonWithPopover';
+export * from './contextMenu/ContextMenu';
+export * from './contextMenuPopover/DataInfoButton';
+export * from './datePicker/ReactDatePicker';
+export * from './dialogGenerator/DialogGenerator';
+export * from './dropdown/Dropdown';
+export * from './echoBottomBar/EchoBottomBar';
+export * from './echoCard/index';
+export * from './echoHeader/EchoHeader';
+export * from './inlineTagIconLink/InlineTagIconLink';
+export * from './listItem';
+export * from './floatingActionButton/FloatingActionButton';
+export * from './listRow/ListRow';
+export * from './sidebarButton/SidebarButton';
+export * from './sidesheet';
+export * from './tagContextMenu/TagContextMenu';
+export * from './timePicker/TimePicker';

package/dist/components/inlineTagIconLink/InlineTagIconLink.d.ts

@@ -1,12 +1,12 @@
-import React from 'react';
-export interface InlineTagIconLinkProps {
-    onClickHandler?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
-    tagNo: string;
-    description: string;
-    tagCategoryDescription?: string;
-    icon?: string | React.ReactNode;
-    legendColor: string;
-    disableHover?: boolean;
-}
-export declare const InlineTagIconLink: React.FC<InlineTagIconLinkProps>;
-export default InlineTagIconLink;
+import React from 'react';
+export interface InlineTagIconLinkProps {
+    onClickHandler?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    tagNo: string;
+    description: string;
+    tagCategoryDescription?: string;
+    icon?: string | React.ReactNode;
+    legendColor: string;
+    disableHover?: boolean;
+}
+export declare const InlineTagIconLink: React.FC<InlineTagIconLinkProps>;
+export default InlineTagIconLink;

package/dist/components/listItem/ListItem.d.ts

@@ -1,50 +1,50 @@
-import React, { CSSProperties } from 'react';
-interface VisualComponent {
-    icon?: never;
-    visual?: React.ReactNode;
-}
-interface IconOptions {
-    icon?: {
-        name: string;
-        color?: string;
-        backgroundColor?: string;
-    };
-    visual?: never;
-}
-/**
- * Make property "icon" and "visual" mutually exclusive
- */
-declare type WithVisualOrIconOptions = VisualComponent | IconOptions;
-interface ListItemBaseProps {
-    /**
-     * Add List Action Area
-     */
-    listAction?: React.ReactNode;
-    /**
-     * Main content Area
-     */
-    primary: string | React.ReactNode;
-    secondary?: string | React.ReactNode;
-    tertiary?: string | React.ReactNode;
-    /**
-     * Caption Area
-     */
-    caption?: string | React.ReactNode;
-    /**
-     * Add Item Action Area
-     */
-    itemAction?: React.ReactNode;
-    /**
-     * Change container element. Default is "li"
-     */
-    as?: React.ElementType;
-    onCardClick?: () => void;
-    /**
-     * Style Modification
-     */
-    className?: string;
-    style?: CSSProperties;
-}
-export declare type ListItemProps = ListItemBaseProps & WithVisualOrIconOptions;
-declare function ListItem(props: ListItemProps): JSX.Element;
-export { ListItem };
+import React, { CSSProperties } from 'react';
+interface VisualComponent {
+    icon?: never;
+    visual?: React.ReactNode;
+}
+interface IconOptions {
+    icon?: {
+        name: string;
+        color?: string;
+        backgroundColor?: string;
+    };
+    visual?: never;
+}
+/**
+ * Make property "icon" and "visual" mutually exclusive
+ */
+declare type WithVisualOrIconOptions = VisualComponent | IconOptions;
+interface ListItemBaseProps {
+    /**
+     * Add List Action Area
+     */
+    listAction?: React.ReactNode;
+    /**
+     * Main content Area
+     */
+    primary: string | React.ReactNode;
+    secondary?: string | React.ReactNode;
+    tertiary?: string | React.ReactNode;
+    /**
+     * Caption Area
+     */
+    caption?: string | React.ReactNode;
+    /**
+     * Add Item Action Area
+     */
+    itemAction?: React.ReactNode;
+    /**
+     * Change container element. Default is "li"
+     */
+    as?: React.ElementType;
+    onCardClick?: () => void;
+    /**
+     * Style Modification
+     */
+    className?: string;
+    style?: CSSProperties;
+}
+export declare type ListItemProps = ListItemBaseProps & WithVisualOrIconOptions;
+declare function ListItem(props: ListItemProps): JSX.Element;
+export { ListItem };

package/dist/components/listItem/index.d.ts

@@ -1 +1 @@
-export * from './ListItem';
+export * from './ListItem';

package/dist/components/listRow/ListRow.d.ts

@@ -1,29 +1,29 @@
-import React, { CSSProperties } from 'react';
-import { ExpandableRowProps, IconListItem } from '@types';
-export interface ListRowProps {
-    isDraggable: boolean;
-    item: IconListItem;
-    expandable?: ExpandableRowProps;
-    rowIndex: number;
-    style?: CSSProperties;
-}
-/**
- * Component that renders one row in a list. The row can be marked as draggable and expandable
- *
- * @param {ListRowProps} {
- *     isDraggable: flag to indicate that the row can be rearranged in a list
- *     item: {      The item to be rendered in the row
- *          title: the title of the item in the row
- *          subtitle: the subtitle of the item in the row
- *          icons: the icons that will be displayed on the same row, and their respective actions
- *     }
- *     expandable: { object with properties to handle if the row is expandable. If undefined the row cannot be expanded
- *          iconItems: the items that will be displayed if row is expanded, and their respective actions
- *          expanded: flag to indicate if the row is expanded or not
- *          setExpanded: method that updates the expanded flag
- *     }
- *     style: style element to override wrapper style
- * }
- * @return {*}  {JSX.Element} a row element to be used in a list
- */
-export declare const ListRow: React.FC<ListRowProps>;
+import React, { CSSProperties } from 'react';
+import { ExpandableRowProps, IconListItem } from '@types';
+export interface ListRowProps {
+    isDraggable: boolean;
+    item: IconListItem;
+    expandable?: ExpandableRowProps;
+    rowIndex: number;
+    style?: CSSProperties;
+}
+/**
+ * Component that renders one row in a list. The row can be marked as draggable and expandable
+ *
+ * @param {ListRowProps} {
+ *     isDraggable: flag to indicate that the row can be rearranged in a list
+ *     item: {      The item to be rendered in the row
+ *          title: the title of the item in the row
+ *          subtitle: the subtitle of the item in the row
+ *          icons: the icons that will be displayed on the same row, and their respective actions
+ *     }
+ *     expandable: { object with properties to handle if the row is expandable. If undefined the row cannot be expanded
+ *          iconItems: the items that will be displayed if row is expanded, and their respective actions
+ *          expanded: flag to indicate if the row is expanded or not
+ *          setExpanded: method that updates the expanded flag
+ *     }
+ *     style: style element to override wrapper style
+ * }
+ * @return {*}  {JSX.Element} a row element to be used in a list
+ */
+export declare const ListRow: React.FC<ListRowProps>;

package/dist/components/rightPanel/PanelContextWrapper.d.ts

@@ -0,0 +1,19 @@
+import React from 'react';
+import { PanelSize } from '../../types/menuItem';
+export interface PanelContextState {
+    activePanel: string | undefined;
+    panelSize: PanelSize;
+    updateActivePanel: (newActivePanel: string | undefined) => void;
+    updatePanelSize: (newPanelSize: PanelSize) => void;
+}
+/**
+ * Panel context with default initialized values
+ *
+ */
+export declare const PanelContext: React.Context<PanelContextState>;
+/**
+ * The panel context wrapper that should be used within Panel component to store the state of the panel
+ *
+ */
+export declare const PanelContextWrapper: React.FC;
+export default PanelContextWrapper;

package/dist/components/rightPanel/index.d.ts

@@ -0,0 +1,5 @@
+export * from './menuButton/MenuButton';
+export * from './panel/Panel';
+export * from './panelContent/PanelContent';
+export * from './panelWrapper/PanelWrapper';
+export * from './usePanelContext';

package/dist/components/rightPanel/menuButton/MenuButton.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+interface MenuButtonProps {
+    text: string;
+    active: boolean;
+    onClick: (event?: React.MouseEvent<HTMLButtonElement>) => void;
+    children: React.ReactNode;
+    refValue?: React.RefObject<HTMLButtonElement>;
+    id?: string;
+}
+/**
+ * The menu bottom items
+ * On desktop it will have an active border on the left,
+ * and on mobile the active border will be on the bottom
+ * Contains an icon and a descriptive text
+ * @param {*} {
+ *     text, the text below the icon, also displayed on hover
+ *     active, boolean describing the buttons active state
+ *     children, the icon to be displayed
+ *     onClick, the on click event
+ *     refValue, a reference value in case its needed
+ *     id: the id of the button in case its needed
+ * }
+ * @return {*}  {JSX.Element}
+ */
+declare const MenuButton: React.FC<MenuButtonProps>;
+export default MenuButton;

package/dist/components/rightPanel/panel/Panel.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { MenuItem } from '../../../types/menuItem';
+interface PanelProps {
+    menuItems: MenuItem[];
+    header: string | React.ReactNode;
+}
+/**
+ * The actual right side panel. This component wraps the panel with a panel state
+ *
+ * @param {PanelProps} {
+ * menuItems, the items to be displayed in the menu and its belonging panels
+ * header, the header that will be displayed on mobile.
+ * If its a string then it will only display a header text. But it can also be a component with self defined html
+ * }
+ * @return {*}  {JSX.Element}
+ */
+export declare const Panel: React.FC<PanelProps>;
+export default Panel;

package/dist/components/rightPanel/panelContent/PanelContent.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+interface PanelContentProps {
+    header: string;
+    children: React.ReactNode;
+    backToMainPanel?: () => void;
+}
+/**
+ * The component that wraps the panel drawer content
+ * This components displays a header with close and possible back button
+ * It also displays the content wrapped with some css
+ *
+ * @param {PanelContentProps} {
+ *     header, the header text to display
+ *     children, the panels content
+ *     backToMainPanel: optional parameter that controls whether the panel should have a back button or not
+ *      to be used in cases where there are panels within panels
+ * }
+ * @return {*}  {JSX.Element}
+ */
+export declare const PanelContent: React.FC<PanelContentProps>;
+export default PanelContent;

package/dist/components/rightPanel/panelWrapper/PanelWrapper.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+import { MenuItem } from '../../../types/menuItem';
+interface PanelWrapperProps {
+    menuItems: MenuItem[];
+    header: string | React.ReactNode;
+}
+/**
+ * Component that display's the buttons in a panel. It will automatically try to calculate how many buttons to display
+ * and how many buttons to hide behind the more menu.
+ * It controls which panel to display when a button is clicked
+ * On desktop this component will render on the right side, and on the top in mobile view
+ *
+ * @param {*} {
+ * menuItems, the items to be displayed in the menu and its belonging panels
+ * header, the header that will be displayed on mobile.
+ * If its a string then it will only display a header text. But it can also be a component with self defined html
+ * }
+ * @return {*}  {JSX.Element}
+ */
+export declare const PanelWrapper: React.FC<PanelWrapperProps>;
+export default PanelWrapper;

package/dist/components/rightPanel/usePanelContext.d.ts

@@ -0,0 +1,8 @@
+import { PanelContextState } from './PanelContextWrapper';
+/**
+ * Hook that exposes panel context, if not used within a PanelContext this hook will throw an error
+ *
+ * @export
+ * @return {*}  {PanelContextState} Returns the existing panel context or throws error if not used within a PanelContext
+ */
+export declare function usePanelContext(): PanelContextState;

package/dist/components/sidebarButton/SidebarButton.d.ts

@@ -0,0 +1,41 @@
+import React from 'react';
+export declare type ButtonType = 'rightBarButton' | 'bottomBarButton' | 'leftBarButton' | 'tabButton';
+export interface SidebarButtonProps {
+    text: string;
+    active: boolean;
+    onClick: (event?: React.MouseEvent<HTMLButtonElement>) => void;
+    /**
+     * count must be bigger than 0.
+     */
+    count?: number;
+    buttonType: ButtonType;
+    refValue?: React.RefObject<HTMLButtonElement>;
+    id?: string;
+    children: React.ReactNode;
+}
+/**
+ * The reusable button component that is used in sidebars/bottom bar or as a tab button.
+ *
+ * On desktop it will have an active border on the left/right/top
+ * depending if ButtonType is set to: "rightBarButton"/"leftBarButton"/"bottomBarButton".
+ * The tabButton have the active border on the left.
+ *
+ * On mobile with the right sidebar, the active border will be on the bottom.
+ * In landscape mode with the bottom bar, the active border will be on the right.
+ *
+ *
+ * The button contains an icon and a descriptive text.
+ * @param {*} {
+ *     text: the text below the icon.
+ *     active: boolean describing the button's active state.
+ *     onClick: the onClick event.
+ *     count: used for the tabButton.
+ *     buttonType: decides which button type it is.
+ *     refValue: a reference value, in case it's needed.
+ *     id: the id of the button, in case it's needed.
+ *     children: the icon to be displayed.
+ * }
+ * @return {*}  {JSX.Element}
+ */
+export declare const SidebarButton: React.FC<SidebarButtonProps>;
+export default SidebarButton;

package/dist/components/sidesheet/enums.d.ts

@@ -1,5 +1,5 @@
-export declare enum SideSheetOrientation {
-    Vertical = "vertical",
-    Horizontal = "horizontal",
-    Fullscreen = "fullscreen"
-}
+export declare enum SideSheetOrientation {
+    Vertical = "vertical",
+    Horizontal = "horizontal",
+    Fullscreen = "fullscreen"
+}

package/dist/components/sidesheet/index.d.ts

@@ -1,11 +1,11 @@
-import React from 'react';
-import { SideSheetOrientation } from './enums';
-import { SheetProps } from './sheet';
-import { SheetTopAreaProps } from './sheetTopArea';
-interface SideSheetProps extends SheetProps, SheetTopAreaProps {
-    open: boolean;
-    children: React.ReactNode;
-}
-declare function SideSheet({ open, side, orientation, floating, children, className, style, ...topBarProps }: SideSheetProps): JSX.Element | null;
-export type { SideSheetProps };
-export { SideSheet, SideSheetOrientation };
+import React from 'react';
+import { SideSheetOrientation } from './enums';
+import { SheetProps } from './sheet';
+import { SheetTopAreaProps } from './sheetTopArea';
+interface SideSheetProps extends SheetProps, SheetTopAreaProps {
+    open: boolean;
+    children: React.ReactNode;
+}
+declare function SideSheet({ open, side, orientation, floating, children, className, style, ...topBarProps }: SideSheetProps): JSX.Element | null;
+export type { SideSheetProps };
+export { SideSheet, SideSheetOrientation };

package/dist/components/sidesheet/sheet/Sheet.d.ts

@@ -1,19 +1,19 @@
-import React, { CSSProperties } from 'react';
-import { SideSheetOrientation } from '../enums';
-interface Style {
-    style?: CSSProperties;
-    className?: string;
-}
-interface SheetProps extends Style {
-    children: React.ReactNode;
-    side?: 'left' | 'right';
-    orientation?: SideSheetOrientation;
-    /**
-     * Default true. Use this to make Sheet push content to the side.
-     * Only affects "vertical" orientation.
-     */
-    floating?: boolean;
-}
-declare function Sheet({ side, orientation, floating, children, className, style }: SheetProps): JSX.Element;
-export type { SheetProps };
-export { Sheet };
+import React, { CSSProperties } from 'react';
+import { SideSheetOrientation } from '../enums';
+interface Style {
+    style?: CSSProperties;
+    className?: string;
+}
+interface SheetProps extends Style {
+    children: React.ReactNode;
+    side?: 'left' | 'right';
+    orientation?: SideSheetOrientation;
+    /**
+     * Default true. Use this to make Sheet push content to the side.
+     * Only affects "vertical" orientation.
+     */
+    floating?: boolean;
+}
+declare function Sheet({ side, orientation, floating, children, className, style }: SheetProps): JSX.Element;
+export type { SheetProps };
+export { Sheet };

package/dist/components/sidesheet/sheet/index.d.ts

@@ -1 +1 @@
-export * from './Sheet';
+export * from './Sheet';

package/dist/components/sidesheet/sheet/utils.d.ts

@@ -1,2 +1,2 @@
-import { SideSheetOrientation } from '../enums';
-export declare function getSheetContainerClass(side?: 'left' | 'right', orientation?: SideSheetOrientation, floating?: boolean): string;
+import { SideSheetOrientation } from '../enums';
+export declare function getSheetContainerClass(side?: 'left' | 'right', orientation?: SideSheetOrientation, floating?: boolean): string;