@equinor/echo-components 0.5.8-rc2 → 0.5.11

package/dist/elements/tagIcon/TagIcon.d.ts

@@ -1,16 +1,16 @@
-import React from 'react';
-interface TagIconProps {
-    icon: JSX.Element;
-    legendColor: string;
-}
-/**
- * Component that will wrap the provided icon with a background color (usually the legend color)
- *
- * @param {TagIconProps} {
- *  icon: Icon to be wrapped
- *  legendColor: background color to apply. Need to be valid css color
- * }
- * @return {*}  {JSX.Element} Wrapped icon with provided color
- */
-export declare const TagIcon: React.FC<TagIconProps>;
-export default TagIcon;
+import React from 'react';
+interface TagIconProps {
+    icon: JSX.Element;
+    legendColor: string;
+}
+/**
+ * Component that will wrap the provided icon with a background color (usually the legend color)
+ *
+ * @param {TagIconProps} {
+ *  icon: Icon to be wrapped
+ *  legendColor: background color to apply. Need to be valid css color
+ * }
+ * @return {*}  {JSX.Element} Wrapped icon with provided color
+ */
+export declare const TagIcon: React.FC<TagIconProps>;
+export default TagIcon;

package/dist/elements/tagIcon/TagIconShadow.d.ts

@@ -1,13 +1,13 @@
-import React from 'react';
-interface TagIconShadowWrapperProps {
-    children: React.ReactNode;
-}
-/**
- * Component that will wrap the provided child element in a shadow.
- * Should be used to add shadow to the tagIcon component
- *
- * @param {TagIconShadowWrapperProps} { children } Child element to wrap
- * @return {*} {JSX.Element} wrapped child element in a shadow
- */
-export declare const TagIconShadowWrapper: React.FC<TagIconShadowWrapperProps>;
-export default TagIconShadowWrapper;
+import React from 'react';
+interface TagIconShadowWrapperProps {
+    children: React.ReactNode;
+}
+/**
+ * Component that will wrap the provided child element in a shadow.
+ * Should be used to add shadow to the tagIcon component
+ *
+ * @param {TagIconShadowWrapperProps} { children } Child element to wrap
+ * @return {*} {JSX.Element} wrapped child element in a shadow
+ */
+export declare const TagIconShadowWrapper: React.FC<TagIconShadowWrapperProps>;
+export default TagIconShadowWrapper;

package/dist/elements/textIconButton/TextIconButton.d.ts

@@ -1,19 +1,19 @@
-import React, { CSSProperties } from 'react';
-export interface TextIconButtonProps {
-    icon: string | React.FC;
-    title: string;
-    onClick: () => void;
-    style?: CSSProperties;
-}
-/**
- * Component that renders a button with the icon and the text provided
- *
- * @param {TextIconButtonProps} {
- *     icon: the name of the icon to display
- *     title: the title text that the button should display
- *     onClick: the function that will be called when user clicks the button
- *     style: Optional parameter that will override the button style
- * }
- * @return {*}  {JSX.Element} A button with the provided icon and text
- */
-export declare const TextIconButton: React.FC<TextIconButtonProps>;
+import React, { CSSProperties } from 'react';
+export interface TextIconButtonProps {
+    icon: string | React.FC;
+    title: string;
+    onClick: () => void;
+    style?: CSSProperties;
+}
+/**
+ * Component that renders a button with the icon and the text provided
+ *
+ * @param {TextIconButtonProps} {
+ *     icon: the name of the icon to display
+ *     title: the title text that the button should display
+ *     onClick: the function that will be called when user clicks the button
+ *     style: Optional parameter that will override the button style
+ * }
+ * @return {*}  {JSX.Element} A button with the provided icon and text
+ */
+export declare const TextIconButton: React.FC<TextIconButtonProps>;

package/dist/helpers/classnames.d.ts

@@ -1,5 +1,5 @@
-declare type ClassNameDynamic = {
-    [key: string]: boolean;
-};
-export declare function classnames(...parts: (string | ClassNameDynamic | undefined | boolean)[]): string | undefined;
-export {};
+declare type ClassNameDynamic = {
+    [key: string]: boolean;
+};
+export declare function classnames(...parts: (string | ClassNameDynamic | undefined | boolean)[]): string | undefined;
+export {};

package/dist/helpers/getIcon.d.ts

@@ -1,2 +1,2 @@
-/// <reference types="react" />
-export declare function getIcon(tagCategoryDescription: string): JSX.Element;
+/// <reference types="react" />
+export declare function getIcon(tagCategoryDescription: string): JSX.Element;

package/dist/helpers/index.d.ts

@@ -1,3 +1,3 @@
-export * from './classnames';
-export * from './getIcon';
-export * from './tagCategoryIcon';
+export * from './classnames';
+export * from './getIcon';
+export * from './tagCategoryIcon';

package/dist/helpers/tagCategoryIcon.d.ts

@@ -1,38 +1,38 @@
-import React from 'react';
-interface ViewTagIconProps {
-    tagCategoryDescription: string;
-}
-export declare enum TagCategoryType {
-    Electrical = "electrical",
-    MainEquipment = "main equipment",
-    Line = "line",
-    ManualValve = "manual valve",
-    CircuitAndStarter = "circuit",
-    Instrument = "instrument",
-    Cable = "cable",
-    Function = "function",
-    Signal = "signal",
-    Telecom = "telecom",
-    JunctionBox = "junction box",
-    Administrative = "administrative"
-}
-/**
- * Method that returns the relevant Icon for the tagCategoryDescription provided
- * Tag icon is the default JSX.Element Icon returned
- * @export
- * @param {('electrical'
- *         | 'main equipment'
- *         | 'line'
- *         | 'manual valve'
- *         | 'circuit/starter'
- *         | 'instrument'
- *         | 'cable'
- *         | 'function'
- *         | 'signal'
- *         | 'telecom'
- *         | 'junction box'
- *         | 'administrative'
- * @return {*}  {JSX.Element} Relevant icon for the provided tagCategoryDescription
- */
-export declare const TagCategoryIcon: React.FC<ViewTagIconProps>;
-export default TagCategoryIcon;
+import React from 'react';
+interface ViewTagIconProps {
+    tagCategoryDescription: string;
+}
+export declare enum TagCategoryType {
+    Electrical = "electrical",
+    MainEquipment = "main equipment",
+    Line = "line",
+    ManualValve = "manual valve",
+    CircuitAndStarter = "circuit",
+    Instrument = "instrument",
+    Cable = "cable",
+    Function = "function",
+    Signal = "signal",
+    Telecom = "telecom",
+    JunctionBox = "junction box",
+    Administrative = "administrative"
+}
+/**
+ * Method that returns the relevant Icon for the tagCategoryDescription provided
+ * Tag icon is the default JSX.Element Icon returned
+ * @export
+ * @param {('electrical'
+ *         | 'main equipment'
+ *         | 'line'
+ *         | 'manual valve'
+ *         | 'circuit/starter'
+ *         | 'instrument'
+ *         | 'cable'
+ *         | 'function'
+ *         | 'signal'
+ *         | 'telecom'
+ *         | 'junction box'
+ *         | 'administrative'
+ * @return {*}  {JSX.Element} Relevant icon for the provided tagCategoryDescription
+ */
+export declare const TagCategoryIcon: React.FC<ViewTagIconProps>;
+export default TagCategoryIcon;

package/dist/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useKeyboardNavigation';
+export * from './useEventListener';

package/dist/hooks/useEventListener.d.ts

@@ -0,0 +1,3 @@
+declare type EventListenerHook = (eventName: string, handler: (e: any) => void, options?: boolean | AddEventListenerOptions, element?: HTMLElement | Window | Document | null) => void;
+declare const useEventListener: EventListenerHook;
+export default useEventListener;

package/dist/hooks/useKeyboardNavigation.d.ts

@@ -0,0 +1,21 @@
+export declare type KeyboardEvents = {
+    up?: Function;
+    right?: Function;
+    down?: Function;
+    left?: Function;
+    enter?: Function;
+    escape?: Function;
+};
+declare const useListNavigator: (listLength: number, initialIndex?: number, keyboardEvents?: KeyboardEvents, listenerTarget?: Document | HTMLElement) => number;
+/**
+ * 1. On open: focus should be undefined/inactive. (list should scroll/show selected item if any).
+ * 2. user presses a key (usually down) - scroll list to focused element, which should be first item
+ * in the first section. Also set focused section.
+ * 3. Potentially jump to last in list if user goes up?
+ */
+declare const useSectionNavigator: (sections: any[], initialSelected: number, keyboardEvents: KeyboardEvents, listenerTarget?: HTMLElement | Document) => {
+    focusedSection: number;
+    focusedOption: number;
+};
+declare const useKeyboardNavigation: (keyboardEvents: KeyboardEvents, listenerTarget?: HTMLElement | Document) => void;
+export { useListNavigator, useSectionNavigator, useKeyboardNavigation };

package/dist/icons/echoAssets/external.d.ts

@@ -1,3 +1,5 @@
-import { IconData } from '@equinor/eds-icons';
-export declare const timp: IconData;
-export declare const timp_text: IconData;
+import { IconData } from '@equinor/eds-icons';
+export declare const robim_external_ald: IconData;
+export declare const robim_external_timp: IconData;
+export declare const robim_external_timp_text: IconData;
+export declare const robim_external_iwit: IconData;

package/dist/icons/echoAssets/index.d.ts

@@ -1,2 +1,3 @@
-export * from './data';
-export * from './external';
+export * from './external';
+export * from './notifications';
+export * from './workOrders';

package/dist/icons/echoAssets/notifications.d.ts

@@ -0,0 +1,9 @@
+import { IconData } from '@equinor/eds-icons';
+export declare const notifications_main_group: IconData;
+export declare const notifications_m1: IconData;
+export declare const notifications_m2: IconData;
+export declare const notifications_m3: IconData;
+export declare const notifications_m4: IconData;
+export declare const notifications_m5: IconData;
+export declare const notifications_m6: IconData;
+export declare const notifications_m9: IconData;

package/dist/icons/echoAssets/workOrders.d.ts

@@ -0,0 +1,11 @@
+import { IconData } from '@equinor/eds-icons';
+export declare const workorders_main_group: IconData;
+export declare const workorders_pm01: IconData;
+export declare const workorders_pm02: IconData;
+export declare const workorders_pm03: IconData;
+export declare const workorders_pm04: IconData;
+export declare const workorders_pm05: IconData;
+export declare const workorders_pm06: IconData;
+export declare const workorders_pm10: IconData;
+export declare const workorders_pm15: IconData;
+export declare const workorders_pm20: IconData;

package/dist/icons/index.d.ts

@@ -1 +1,3 @@
-export * from './echoAssets';
+import * as echoIcons from './echoAssets';
+export * from './echoAssets';
+export { echoIcons };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
-import './theme/theme.css';
-export * from './components';
-export * from './elements';
-export * from './helpers';
-export * from './icons';
-export * from './structure';
-export { themeConst } from './theme/themeConst';
-export * from './types';
+import './theme/theme.css';
+export * from './components';
+export * from './elements';
+export * from './helpers';
+export * from './icons';
+export * from './structure';
+export { themeConst } from './theme/themeConst';
+export * from './types';
+export * from './hooks';