@equinor/echo-components 0.5.3 → 0.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +62 -62
  3. package/package.json +120 -119
  4. package/dist/components/buttonWithPopover/ButtonWithPopover.d.ts +0 -21
  5. package/dist/components/contextMenu/ContextMenu.d.ts +0 -35
  6. package/dist/components/contextMenuPopover/DataInfoButton.d.ts +0 -19
  7. package/dist/components/contextMenuPopover/DataInfoPopover.d.ts +0 -18
  8. package/dist/components/datePicker/PopupHeader.d.ts +0 -19
  9. package/dist/components/datePicker/ReactDatePicker.d.ts +0 -19
  10. package/dist/components/dialogGenerator/DialogGenerator.d.ts +0 -26
  11. package/dist/components/dropdown/Dropdown.d.ts +0 -37
  12. package/dist/components/echoBottomBar/EchoBottomBar.d.ts +0 -7
  13. package/dist/components/echoCard/Body.d.ts +0 -7
  14. package/dist/components/echoCard/DateSection.d.ts +0 -8
  15. package/dist/components/echoCard/EchoCard.d.ts +0 -7
  16. package/dist/components/echoCard/LinkSection.d.ts +0 -8
  17. package/dist/components/echoCard/Title.d.ts +0 -13
  18. package/dist/components/echoCard/index.d.ts +0 -14
  19. package/dist/components/echoHeader/EchoHeader.d.ts +0 -20
  20. package/dist/components/index.d.ts +0 -14
  21. package/dist/components/inlineTagIconLink/InlineTagIconLink.d.ts +0 -12
  22. package/dist/components/listRow/ListRow.d.ts +0 -30
  23. package/dist/components/sidesheet/enums.d.ts +0 -5
  24. package/dist/components/sidesheet/index.d.ts +0 -11
  25. package/dist/components/sidesheet/sheet/Sheet.d.ts +0 -19
  26. package/dist/components/sidesheet/sheet/index.d.ts +0 -1
  27. package/dist/components/sidesheet/sheet/utils.d.ts +0 -2
  28. package/dist/components/sidesheet/sheetTopArea/SheetTopArea.d.ts +0 -16
  29. package/dist/components/sidesheet/sheetTopArea/index.d.ts +0 -1
  30. package/dist/components/tagContextMenu/TagContextMenu.d.ts +0 -30
  31. package/dist/components/timePicker/TimePicker.d.ts +0 -12
  32. package/dist/elements/draggableItemsWrapper/DraggableItemsWrapper.d.ts +0 -18
  33. package/dist/elements/icon/Icon.d.ts +0 -20
  34. package/dist/elements/index.d.ts +0 -8
  35. package/dist/elements/radioButtonGroup/RadioButtonGroup.d.ts +0 -20
  36. package/dist/elements/roundIconButton/RoundIconButton.d.ts +0 -13
  37. package/dist/elements/sliderField/SliderField.d.ts +0 -25
  38. package/dist/elements/tagIcon/TagIcon.d.ts +0 -16
  39. package/dist/elements/tagIcon/TagIconShadow.d.ts +0 -13
  40. package/dist/elements/textIconButton/TextIconButton.d.ts +0 -19
  41. package/dist/helpers/getIcon.d.ts +0 -2
  42. package/dist/helpers/index.d.ts +0 -1
  43. package/dist/helpers/tagCategoryIcon.d.ts +0 -38
  44. package/dist/icons/echoAssets/index.d.ts +0 -3
  45. package/dist/icons/index.d.ts +0 -1
  46. package/dist/index.d.ts +0 -8
  47. package/dist/index.js +0 -21667
  48. package/dist/setupTests.d.ts +0 -1
  49. package/dist/structure/iconList/IconList.d.ts +0 -32
  50. package/dist/structure/iconList/createListRow.d.ts +0 -14
  51. package/dist/structure/index.d.ts +0 -2
  52. package/dist/structure/linkCard/LinkCard.d.ts +0 -26
  53. package/dist/structure/optionsList/OptionsList.d.ts +0 -24
  54. package/dist/theme/themeConst.d.ts +0 -65
  55. package/dist/types/actionButton.d.ts +0 -6
  56. package/dist/types/dataInformation.d.ts +0 -8
  57. package/dist/types/draggableItem.d.ts +0 -5
  58. package/dist/types/expandableRowProps.d.ts +0 -6
  59. package/dist/types/iconItem.d.ts +0 -4
  60. package/dist/types/iconListItem.d.ts +0 -6
  61. package/dist/types/index.d.ts +0 -9
  62. package/dist/types/linkCardItem.d.ts +0 -5
  63. package/dist/types/optionsItem.d.ts +0 -6
  64. package/dist/types/radioButtonItem.d.ts +0 -4
@@ -1,8 +0,0 @@
1
- import React from 'react';
2
- export declare type DateSectionProps = {
3
- date?: Date | null;
4
- dateSectionText?: string;
5
- children?: React.ReactNode;
6
- className?: string;
7
- };
8
- export declare const DateSection: ({ dateSectionText, date, children, className }: Partial<DateSectionProps>) => JSX.Element;
@@ -1,7 +0,0 @@
1
- import React from 'react';
2
- export interface EchoCardProps {
3
- children: React.ReactNode;
4
- className?: string;
5
- style?: React.CSSProperties;
6
- }
7
- export declare const EchoCard: React.FC<EchoCardProps>;
@@ -1,8 +0,0 @@
1
- import React from 'react';
2
- import { CardIcons } from './Title';
3
- export declare type LinkSectionProps = {
4
- children?: React.ReactNode;
5
- linkSectionIcons?: CardIcons[];
6
- className?: string;
7
- };
8
- export declare const LinkSection: ({ children, className, linkSectionIcons }: Partial<LinkSectionProps>) => JSX.Element;
@@ -1,13 +0,0 @@
1
- /// <reference types="react" />
2
- export interface CardIcons {
3
- name: string;
4
- color: string;
5
- onClick?: () => void;
6
- }
7
- export declare type TitleProps = {
8
- headerTitle?: string;
9
- onHeaderClick?: () => void;
10
- headerIcons?: CardIcons[];
11
- className?: string;
12
- };
13
- export declare const Title: ({ headerTitle, headerIcons, className, onHeaderClick }: Partial<TitleProps>) => JSX.Element;
@@ -1,14 +0,0 @@
1
- import { Body, BodyProps } from './Body';
2
- import { DateSection, DateSectionProps } from './DateSection';
3
- import { EchoCard as BaseEchoCard } from './EchoCard';
4
- import { LinkSection } from './LinkSection';
5
- import { Title, TitleProps } from './Title';
6
- declare type CardType = typeof BaseEchoCard & {
7
- Title: typeof Title;
8
- Body: typeof Body;
9
- LinkSection: typeof LinkSection;
10
- DateSection: typeof DateSection;
11
- };
12
- declare const EchoCard: CardType;
13
- export { EchoCard };
14
- export type { TitleProps, DateSectionProps, BodyProps };
@@ -1,20 +0,0 @@
1
- import React from 'react';
2
- export interface EchoHeaderProps {
3
- moduleTitle: string;
4
- moduleIcon: string | React.FC;
5
- plantName?: string;
6
- customHeaderSection?: React.FC;
7
- }
8
- /**
9
- * Component that renders the Echo header
10
- *
11
- * @param {EchoHeaderProps} {
12
- * moduleTitle: the title of the module
13
- * moduleIcon: the module Icon
14
- * plantName: show the plant name next to the module title
15
- * customSection: a section in the header where there can be custom components
16
- * }
17
- * @returns {*} {JSX.Element} Echo header with custom section
18
- */
19
- export declare const EchoHeader: React.FC<EchoHeaderProps>;
20
- export default EchoHeader;
@@ -1,14 +0,0 @@
1
- export { ButtonWithPopover } from './buttonWithPopover/ButtonWithPopover';
2
- export { ContextMenu } from './contextMenu/ContextMenu';
3
- export { DataInfoButton } from './contextMenuPopover/DataInfoButton';
4
- export { ReactDatePicker } from './datePicker/ReactDatePicker';
5
- export { DialogGenerator } from './dialogGenerator/DialogGenerator';
6
- export { Dropdown } from './dropdown/Dropdown';
7
- export { EchoBottomBar } from './echoBottomBar/EchoBottomBar';
8
- export { EchoCard } from './echoCard/index';
9
- export { EchoHeader } from './echoHeader/EchoHeader';
10
- export { InlineTagIconLink } from './inlineTagIconLink/InlineTagIconLink';
11
- export { ListRow } from './listRow/ListRow';
12
- export * from './sidesheet';
13
- export { TagContextMenu } from './tagContextMenu/TagContextMenu';
14
- export { TimePicker } from './timePicker/TimePicker';
@@ -1,12 +0,0 @@
1
- import React from 'react';
2
- export interface InlineTagIconLinkProps {
3
- onClickHandler?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
4
- tagNo: string;
5
- description: string;
6
- tagCategoryDescription?: string;
7
- icon?: string | React.ReactNode;
8
- legendColor: string;
9
- disableHover?: boolean;
10
- }
11
- export declare const InlineTagIconLink: React.FC<InlineTagIconLinkProps>;
12
- export default InlineTagIconLink;
@@ -1,30 +0,0 @@
1
- import React, { CSSProperties } from 'react';
2
- import { ExpandableRowProps } from '../../types/expandableRowProps';
3
- import { IconListItem } from '../../types/iconListItem';
4
- export interface ListRowProps {
5
- isDraggable: boolean;
6
- item: IconListItem;
7
- expandable?: ExpandableRowProps;
8
- rowIndex: number;
9
- style?: CSSProperties;
10
- }
11
- /**
12
- * Component that renders one row in a list. The row can be marked as draggable and expandable
13
- *
14
- * @param {ListRowProps} {
15
- * isDraggable: flag to indicate that the row can be rearranged in a list
16
- * item: { The item to be rendered in the row
17
- * title: the title of the item in the row
18
- * subtitle: the subtitle of the item in the row
19
- * icons: the icons that will be displayed on the same row, and their respective actions
20
- * }
21
- * expandable: { object with properties to handle if the row is expandable. If undefined the row cannot be expanded
22
- * iconItems: the items that will be displayed if row is expanded, and their respective actions
23
- * expanded: flag to indicate if the row is expanded or not
24
- * setExpanded: method that updates the expanded flag
25
- * }
26
- * style: style element to override wrapper style
27
- * }
28
- * @return {*} {JSX.Element} a row element to be used in a list
29
- */
30
- export declare const ListRow: React.FC<ListRowProps>;
@@ -1,5 +0,0 @@
1
- export declare enum SideSheetOrientation {
2
- Vertical = "vertical",
3
- Horizontal = "horizontal",
4
- Fullscreen = "fullscreen"
5
- }
@@ -1,11 +0,0 @@
1
- import React from 'react';
2
- import { SideSheetOrientation } from './enums';
3
- import { SheetProps } from './sheet';
4
- import { SheetTopAreaProps } from './sheetTopArea';
5
- interface SideSheetProps extends SheetProps, SheetTopAreaProps {
6
- open: boolean;
7
- children: React.ReactNode;
8
- }
9
- declare function SideSheet({ open, side, orientation, floating, children, className, style, ...topBarProps }: SideSheetProps): JSX.Element | null;
10
- export type { SideSheetProps };
11
- export { SideSheet, SideSheetOrientation };
@@ -1,19 +0,0 @@
1
- import React, { CSSProperties } from 'react';
2
- import { SideSheetOrientation } from '../enums';
3
- interface Style {
4
- style?: CSSProperties;
5
- className?: string;
6
- }
7
- interface SheetProps extends Style {
8
- children: React.ReactNode;
9
- side?: 'left' | 'right';
10
- orientation?: SideSheetOrientation;
11
- /**
12
- * Default true. Use this to make Sheet push content to the side.
13
- * Only affects "vertical" orientation.
14
- */
15
- floating?: boolean;
16
- }
17
- declare function Sheet({ side, orientation, floating, children, className, style }: SheetProps): JSX.Element;
18
- export type { SheetProps };
19
- export { Sheet };
@@ -1 +0,0 @@
1
- export * from './Sheet';
@@ -1,2 +0,0 @@
1
- import { SideSheetOrientation } from '../enums';
2
- export declare function getSheetContainerClass(side?: 'left' | 'right', orientation?: SideSheetOrientation, floating?: boolean): string;
@@ -1,16 +0,0 @@
1
- import React from 'react';
2
- import { SideSheetOrientation } from '../enums';
3
- interface SheetTopAreaProps extends Partial<SheetOrientationActionsProps> {
4
- closeSheet: () => void;
5
- previous?: React.ReactNode;
6
- }
7
- declare function SheetTopArea({ orientation, onOrientationChange, closeSheet, previous }: SheetTopAreaProps): JSX.Element;
8
- interface SheetOrientationActionsProps {
9
- orientation: SideSheetOrientation;
10
- /**
11
- * Providing this function allows the developer to control sheet orientation.
12
- */
13
- onOrientationChange: (orientationTarget: SideSheetOrientation) => void;
14
- }
15
- export type { SheetTopAreaProps };
16
- export { SheetTopArea };
@@ -1 +0,0 @@
1
- export * from './SheetTopArea';
@@ -1,30 +0,0 @@
1
- import React from 'react';
2
- interface TagContextMenuProps {
3
- expanded: boolean;
4
- setExpanded: (expanded: boolean) => void;
5
- tagNo: string;
6
- description: string;
7
- openTagInformation: () => void;
8
- selected: boolean;
9
- selectedClassName?: string;
10
- children: React.ReactNode;
11
- }
12
- /**
13
- * Component that renders a tag context menu that can be expanded and closed upon click
14
- * The condensed variant will only display the the relevant tag icon
15
- * The expanded variant will display relevant tag icon, tag number and tag description
16
- *
17
- * @param {TagContextMenuProps} {
18
- * expanded: flag that state if the context menu should be expanded or not
19
- * setExpanded: method to update the expanded flag
20
- * tagNo: the tag no to display
21
- * description: the tag description
22
- * openTagInformation: method called when expanded context menu is called
23
- * selected: Flag to handle if there are multiple context menu's on a page, and a selected style should be applied
24
- * selectedClassName: styling used to handle multiple tag visible on the page at the same time, class will be added to tagIcon when context menu is not expanded
25
- * children: Meant to be used to pass TagIcon component to this component
26
- * }
27
- * @return {*} {JSX.Element} a tag context menu for the provided properties
28
- */
29
- export declare const TagContextMenu: React.FC<TagContextMenuProps>;
30
- export default TagContextMenu;
@@ -1,12 +0,0 @@
1
- import React from 'react';
2
- export interface TimePickerProps {
3
- id: string;
4
- value?: string;
5
- label: string;
6
- onValueChanged?: (time: string) => void;
7
- className?: string;
8
- readOnly?: boolean;
9
- timeRange?: string[];
10
- }
11
- export declare const TimePicker: React.FC<TimePickerProps>;
12
- export default TimePicker;
@@ -1,18 +0,0 @@
1
- import React, { CSSProperties } from 'react';
2
- import { DraggableItem } from '../../types/draggableItem';
3
- export interface DraggableItemsWrapperProps {
4
- style?: CSSProperties;
5
- onChange: (newDragItems: DraggableItem[], oldIndex: number | undefined, newIndex: number | undefined) => void;
6
- children: React.ReactNode[];
7
- }
8
- /**
9
- * Component that renders a wrapper for items that are draggable
10
- *
11
- * @param {DraggableItemsWrapperProps} {
12
- * style: style element to override wrapper style
13
- * onChange: method that will be called when elements have be reordered inside the wrapper
14
- * children: list of elements that can be reordered
15
- * }
16
- * @return {*} {JSX.Element}
17
- */
18
- export declare const DraggableItemsWrapper: React.FC<DraggableItemsWrapperProps>;
@@ -1,20 +0,0 @@
1
- import React from 'react';
2
- export interface IconProps {
3
- name: string;
4
- color: string;
5
- title?: string;
6
- className?: string;
7
- size?: 16 | 24 | 32 | 40 | 48;
8
- }
9
- /**
10
- * Component that work's as a eds icon wrapper, it imports all eds possible icons
11
- *
12
- * @param {IconProps} {
13
- * name: The name of the icon to be displayed
14
- * title: The html title to use
15
- * color:The color to icon should have
16
- * size: The wanted size of the icon. Possible values are 16, 24, 32, 40 and 48
17
- * }
18
- * @return {*} {JSX.Element} A icon for the provided information
19
- */
20
- export declare const Icon: React.FC<IconProps>;
@@ -1,8 +0,0 @@
1
- export { DraggableItemsWrapper } from './draggableItemsWrapper/DraggableItemsWrapper';
2
- export { Icon } from './icon/Icon';
3
- export { RadioButtonGroup } from './radioButtonGroup/RadioButtonGroup';
4
- export * from './roundIconButton/RoundIconButton';
5
- export { SliderField } from './sliderField/SliderField';
6
- export { TagIcon } from './tagIcon/TagIcon';
7
- export { TagIconShadowWrapper } from './tagIcon/TagIconShadow';
8
- export { TextIconButton } from './textIconButton/TextIconButton';
@@ -1,20 +0,0 @@
1
- import React, { CSSProperties } from 'react';
2
- import { RadioButtonItem } from '../../types/radioButtonItem';
3
- export interface RadioButtonGroupProps {
4
- title: string;
5
- options: RadioButtonItem[];
6
- style?: CSSProperties;
7
- onSelected: (index: number) => void;
8
- }
9
- /**
10
- * Component that renders a Radio Button Group with a set of options to choose from
11
- *
12
- * @param {RadioButtonGroupProps} {
13
- * title: The title of the radio button group,
14
- * options: List of items to be displayed as options,
15
- * style: Style element to override wrapper style,
16
- * onSelected: Method to be called when the selected value is changed
17
- * }
18
- * @return {*} {JSX.Element}
19
- */
20
- export declare const RadioButtonGroup: React.FC<RadioButtonGroupProps>;
@@ -1,13 +0,0 @@
1
- import React, { EventHandler, ReactElement, SyntheticEvent } from 'react';
2
- export declare enum RoundIconButtonVariants {
3
- OpenCloseButton = "openCloseButton",
4
- ToggleButton = "toggleButton"
5
- }
6
- export interface RoundIconButtonProps {
7
- label: string;
8
- active?: boolean;
9
- variant?: RoundIconButtonVariants;
10
- children?: ReactElement;
11
- onClick?: EventHandler<SyntheticEvent>;
12
- }
13
- export declare const RoundIconButton: React.FC<RoundIconButtonProps>;
@@ -1,25 +0,0 @@
1
- import React, { CSSProperties } from 'react';
2
- export interface SliderFieldProps {
3
- value: number;
4
- min: number;
5
- max: number;
6
- labels?: string[];
7
- title: string;
8
- onChange: (value: number) => void;
9
- style?: CSSProperties;
10
- }
11
- /**
12
- * Component that renders a slider with numeric or custom values
13
- *
14
- * @param {SliderFieldProps} {
15
- * value: Current value of the slider,
16
- * min: Minimum value of the slider,
17
- * max: Maximum value of the slider,
18
- * labels: List of labels to use if the slider should not display numeric values,
19
- * title: Text shown as title of the slider,
20
- * onChange: Method that will be called if the slider value is changed,
21
- * style: style element to override wrapper style
22
- * }
23
- * @return {*} {JSX.Element}
24
- */
25
- export declare const SliderField: React.FC<SliderFieldProps>;
@@ -1,16 +0,0 @@
1
- import React from 'react';
2
- interface TagIconProps {
3
- icon: JSX.Element;
4
- legendColor: string;
5
- }
6
- /**
7
- * Component that will wrap the provided icon with a background color (usually the legend color)
8
- *
9
- * @param {TagIconProps} {
10
- * icon: Icon to be wrapped
11
- * legendColor: background color to apply. Need to be valid css color
12
- * }
13
- * @return {*} {JSX.Element} Wrapped icon with provided color
14
- */
15
- export declare const TagIcon: React.FC<TagIconProps>;
16
- export default TagIcon;
@@ -1,13 +0,0 @@
1
- import React from 'react';
2
- interface TagIconShadowWrapperProps {
3
- children: React.ReactNode;
4
- }
5
- /**
6
- * Component that will wrap the provided child element in a shadow.
7
- * Should be used to add shadow to the tagIcon component
8
- *
9
- * @param {TagIconShadowWrapperProps} { children } Child element to wrap
10
- * @return {*} {JSX.Element} wrapped child element in a shadow
11
- */
12
- export declare const TagIconShadowWrapper: React.FC<TagIconShadowWrapperProps>;
13
- export default TagIconShadowWrapper;
@@ -1,19 +0,0 @@
1
- import React, { CSSProperties } from 'react';
2
- export interface TextIconButtonProps {
3
- icon: string | React.FC;
4
- title: string;
5
- onClick: () => void;
6
- style?: CSSProperties;
7
- }
8
- /**
9
- * Component that renders a button with the icon and the text provided
10
- *
11
- * @param {TextIconButtonProps} {
12
- * icon: the name of the icon to display
13
- * title: the title text that the button should display
14
- * onClick: the function that will be called when user clicks the button
15
- * style: Optional parameter that will override the button style
16
- * }
17
- * @return {*} {JSX.Element} A button with the provided icon and text
18
- */
19
- export declare const TextIconButton: React.FC<TextIconButtonProps>;
@@ -1,2 +0,0 @@
1
- /// <reference types="react" />
2
- export declare function getIcon(tagCategoryDescription: string): JSX.Element;
@@ -1 +0,0 @@
1
- export { getIcon } from './getIcon';
@@ -1,38 +0,0 @@
1
- import React from 'react';
2
- interface ViewTagIconProps {
3
- tagCategoryDescription: string;
4
- }
5
- export declare enum TagCategoryType {
6
- Electrical = "electrical",
7
- MainEquipment = "main equipment",
8
- Line = "line",
9
- ManualValve = "manual valve",
10
- CircuitAndStarter = "circuit",
11
- Instrument = "instrument",
12
- Cable = "cable",
13
- Function = "function",
14
- Signal = "signal",
15
- Telecom = "telecom",
16
- JunctionBox = "junction box",
17
- Administrative = "administrative"
18
- }
19
- /**
20
- * Method that returns the relevant Icon for the tagCategoryDescription provided
21
- * Tag icon is the default JSX.Element Icon returned
22
- * @export
23
- * @param {('electrical'
24
- * | 'main equipment'
25
- * | 'line'
26
- * | 'manual valve'
27
- * | 'circuit/starter'
28
- * | 'instrument'
29
- * | 'cable'
30
- * | 'function'
31
- * | 'signal'
32
- * | 'telecom'
33
- * | 'junction box'
34
- * | 'administrative'
35
- * @return {*} {JSX.Element} Relevant icon for the provided tagCategoryDescription
36
- */
37
- export declare const TagCategoryIcon: React.FC<ViewTagIconProps>;
38
- export default TagCategoryIcon;
@@ -1,3 +0,0 @@
1
- import { IconData } from '@equinor/eds-icons';
2
- export declare const sheet_left: IconData;
3
- export declare const sheet_bottom: IconData;
@@ -1 +0,0 @@
1
- export {};
package/dist/index.d.ts DELETED
@@ -1,8 +0,0 @@
1
- import './theme/theme.css';
2
- export * from './components';
3
- export * from './elements';
4
- export * from './helpers';
5
- export * from './icons';
6
- export * from './structure';
7
- export { themeConst } from './theme/themeConst';
8
- export * from './types';