@dnb/eufemia 9.17.2 → 9.21.0

package/components/step-indicator/StepIndicatorTriggerButton.js

@@ -64,6 +64,8 @@ var StepIndicatorTriggerButton = function (_React$PureComponent) {
     key: "componentDidMount",
     value: function componentDidMount() {
       this._heightAnim.setElement(this._buttonRef.current);
+
+      this._prevStep = this.context.activeStep;
     }
   }, {
     key: "componentWillUnmount",
@@ -76,12 +78,10 @@ var StepIndicatorTriggerButton = function (_React$PureComponent) {
       if (this._prevStep !== this.context.activeStep) {
         var toHeight = this._heightAnim.getUnknownHeight();
 
-        this._heightAnim.adjustFrom(height);
-
         this._heightAnim.adjustTo(height, toHeight);
-      }
 
-      this._prevStep = this.context.activeStep;
+        this._prevStep = this.context.activeStep;
+      }
     }
   }, {
     key: "render",

package/components/switch/Switch.d.ts

@@ -57,7 +57,7 @@ export type SwitchChildren = string | ((...args: any[]) => any);
  */
 export interface SwitchProps extends React.HTMLProps<HTMLElement> {
   /**
-   * Use either the `label` property or provide custom one.
+   * Use either the `label` property or provide a custom one.
    */
   label?: SwitchLabel;
 
@@ -67,13 +67,13 @@ export interface SwitchProps extends React.HTMLProps<HTMLElement> {
   label_position?: SwitchLabelPosition;
 
   /**
-   * The `title` of the input - describing it a bit further for accessibility reasons.
+   * <em>(required)</em> the `title` of the input - describing it a bit further for accessibility reasons.
    */
   title?: string;
   default_state?: SwitchDefaultState;
 
   /**
-   * Determine whether the switch is checked or not. Default will be `false`.
+   * Determine whether the switch is checked or not. The default will be `false`.
    */
   checked?: SwitchChecked;
   disabled?: SwitchDisabled;
@@ -90,7 +90,7 @@ export interface SwitchProps extends React.HTMLProps<HTMLElement> {
   status?: SwitchStatus;
 
   /**
-   * Defines the state of the status. Currently there are two statuses `[error, info]`. Defaults to `error`.
+   * Defines the state of the status. Currently, there are two statuses `[error, info]`. Defaults to `error`.
    */
   status_state?: string;
 
@@ -149,12 +149,12 @@ export interface SwitchProps extends React.HTMLProps<HTMLElement> {
   custom_method?: (...args: any[]) => any;
 
   /**
-   * Will be called on state changes made by the user. Returns an boolean `{ checked, event }`.
+   * Will be called on state changes made by the user. Returns a boolean `{ checked, event }`.
    */
   on_change?: (...args: any[]) => any;
 
   /**
-   * Will be called on state changes made by the user, but with a delay. This way the users sees the animation, before e.g. an error will be removed. Returns an boolean `{ checked, event }`.
+   * Will be called on state changes made by the user, but with a delay. This way the user sees the animation before e.g. an error will be removed. Returns a boolean `{ checked, event }`.
    */
   on_change_end?: (...args: any[]) => any;
   on_state_update?: (...args: any[]) => any;

package/components/tabs/Tabs.d.ts

@@ -66,12 +66,12 @@ export type TabsChildren =
  */
 export interface TabsProps extends React.HTMLProps<HTMLElement> {
   /**
-   * Defines the data structure to load as a JSON. e.g. `[{title: &#39;...&#39;, content: &#39;Current tab&#39;, key
+   * <em>(required)</em> defines the data structure to load as a JSON. e.g. `[{title: &#39;...&#39;, content: &#39;Current tab&#39;, key
    */
   data?: TabsData;
 
   /**
-   * The content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
+   * <em>(required)</em> the content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
    */
   content?: TabsContent;
 
@@ -81,7 +81,7 @@ export interface TabsProps extends React.HTMLProps<HTMLElement> {
   content_style?: string;
 
   /**
-   * To modify the `spacing` on to the content wrapper. Use a supported modifier from the <a href="/uilib/components/section/properties">Section component</a>. Defaults to `true`.
+   * To modify the `spacing` onto the content wrapper. Use a supported modifier from the <a href="/uilib/components/section/properties">Section component</a>. Defaults to `true`.
    */
   content_spacing?: TabsContentSpacing;
   label?: string;
@@ -107,7 +107,7 @@ export interface TabsProps extends React.HTMLProps<HTMLElement> {
   tabs_style?: string;
 
   /**
-   * To modify the `spacing` inside the tabs list. Use a supported modifier from the <a href="/uilib/components/section/properties">Section component</a>. Defaults to `false`.
+   * To modify the `spacing` inside the tab list. Use a supported modifier from the <a href="/uilib/components/section/properties">Section component</a>. Defaults to `false`.
    */
   tabs_spacing?: TabsTabsSpacing;
   use_hash?: TabsUseHash;
@@ -118,7 +118,7 @@ export interface TabsProps extends React.HTMLProps<HTMLElement> {
   prerender?: TabsPrerender;
 
   /**
-   * If set to `true`, the Tabs content will stay in the DOM. The visibility will be handled by using the `hidden` and `aria-hidden` HTML attributes. Similar to `prerender`, but in contrast, the content will render once the users is activating a tab. Defaults to `false`.
+   * If set to `true`, the Tabs content will stay in the DOM. The visibility will be handled by using the `hidden` and `aria-hidden` HTML attributes. Similar to `prerender`, but in contrast, the content will render once the user is activating a tab. Defaults to `false`.
    */
   prevent_rerender?: TabsPreventRerender;
 
@@ -161,7 +161,7 @@ export interface TabsProps extends React.HTMLProps<HTMLElement> {
   className?: string;
 
   /**
-   * The content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
+   * <em>(required)</em> the content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
    */
   children?: TabsChildren;
   render?: (...args: any[]) => any;
@@ -172,7 +172,7 @@ export interface TabsProps extends React.HTMLProps<HTMLElement> {
   on_change?: (...args: any[]) => any;
 
   /**
-   * This event gets triggered once the a users mouse enters a tab (hover). Returns `{ key, selected_key, focus_key, event }`.
+   * This event gets triggered once the user&#39;s mouse enters a tab (hover). Returns `{ key, selected_key, focus_key, event }`.
    */
   on_mouse_enter?: (...args: any[]) => any;
 
@@ -198,7 +198,7 @@ export default class Tabs extends React.Component<TabsProps, any> {
  */
 export interface DummyProps {
   /**
-   * The content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
+   * <em>(required)</em> the content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
    */
   children: React.ReactNode;
 }

package/components/tabs/TabsContentWrapper.d.ts

@@ -22,12 +22,12 @@ export interface ContentWrapperProps extends React.HTMLProps<HTMLElement> {
   content_style?: string;
 
   /**
-   * To modify the `spacing` on to the content wrapper. Use a supported modifier from the <a href="/uilib/components/section/properties">Section component</a>. Defaults to `true`.
+   * To modify the `spacing` onto the content wrapper. Use a supported modifier from the <a href="/uilib/components/section/properties">Section component</a>. Defaults to `true`.
    */
   content_spacing?: ContentWrapperContentSpacing;
 
   /**
-   * The content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
+   * <em>(required)</em> the content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
    */
   children?: ContentWrapperChildren;
 }

package/components/tabs/TabsCustomContent.d.ts

@@ -74,7 +74,7 @@ export interface CustomContentProps extends React.HTMLProps<HTMLElement> {
   left?: CustomContentLeft;
 
   /**
-   * The content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
+   * <em>(required)</em> the content to render. Can be a function, returning the current tab content `(key) => (&#39;Current tab&#39;)`, a React Component or an object with the keys and content `{key1: &#39;Current tab&#39;}`.
    */
   children?: CustomContentChildren;
   className?: string;

package/components/tag/Tag.js

@@ -0,0 +1,112 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+
+var _IconPrimary;
+
+var _excluded = ["className", "skeleton", "children", "text", "onClick", "onDelete", "omitOnKeyUpDeleteEvent"];
+import React from 'react';
+import classnames from 'classnames';
+import IconPrimary from '../icon-primary/IconPrimary';
+import Button from '../button/Button';
+import Context from '../../shared/Context';
+import { warn } from '../../shared/component-helper';
+import { usePropsWithContext } from '../../shared/hooks';
+import TagGroup from './TagGroup';
+import { TagGroupContext } from './TagContext';
+export var defaultProps = {
+  className: null,
+  skeleton: false,
+  text: null,
+  children: null,
+  icon: null,
+  onClick: null,
+  onDelete: null,
+  omitOnKeyUpDeleteEvent: false
+};
+
+var Tag = function Tag(localProps) {
+  var _context$translation;
+
+  var context = React.useContext(Context);
+  var tagGroupContext = React.useContext(TagGroupContext);
+
+  var _usePropsWithContext = usePropsWithContext(localProps, defaultProps, context === null || context === void 0 ? void 0 : (_context$translation = context.translation) === null || _context$translation === void 0 ? void 0 : _context$translation.Tag, context === null || context === void 0 ? void 0 : context.Tag, tagGroupContext),
+      className = _usePropsWithContext.className,
+      skeleton = _usePropsWithContext.skeleton,
+      children = _usePropsWithContext.children,
+      text = _usePropsWithContext.text,
+      onClick = _usePropsWithContext.onClick,
+      onDelete = _usePropsWithContext.onDelete,
+      omitOnKeyUpDeleteEvent = _usePropsWithContext.omitOnKeyUpDeleteEvent,
+      props = _objectWithoutProperties(_usePropsWithContext, _excluded);
+
+  var content = text || children;
+  var isClickable = !!onClick;
+  var isRemovable = !!onDelete && !isClickable;
+  var isInteractive = isClickable || isRemovable;
+  var tagClassNames = classnames('dnb-tag', className, isInteractive && 'dnb-tag--interactive', isRemovable && 'dnb-tag--removable');
+
+  var isDeleteKeyboardEvent = function isDeleteKeyboardEvent(keyboardEvent) {
+    return keyboardEvent.key === 'Backspace' || keyboardEvent.key === 'Delete';
+  };
+
+  var handleKeyUp = function handleKeyUp(event) {
+    if (onDelete && isDeleteKeyboardEvent(event)) {
+      onDelete(event);
+    }
+  };
+
+  var buttonAttr = props;
+
+  if (!isInteractive) {
+    buttonAttr.element = 'span';
+    buttonAttr.type = '';
+  }
+
+  if (isRemovable) {
+    buttonAttr.icon = getDeleteIcon();
+  }
+
+  if (!tagGroupContext) {
+    warn("Tag group required: A Tag requires a Tag.Group with label description as a parent component. This is to ensure correct semantic and accessibility.");
+  }
+
+  return React.createElement(Button, _extends({
+    "data-testid": "tag",
+    variant: "unstyled",
+    size: "small",
+    icon_position: isRemovable ? 'right' : 'left',
+    className: tagClassNames,
+    on_click: onClick || onDelete,
+    text: content,
+    skeleton: skeleton,
+    onKeyUp: isRemovable && !omitOnKeyUpDeleteEvent ? function (e) {
+      return handleKeyUp(e);
+    } : undefined
+  }, buttonAttr));
+
+  function getDeleteIcon() {
+    return _IconPrimary || (_IconPrimary = React.createElement(IconPrimary, {
+      "data-testid": "tag-delete-icon",
+      inherit_color: false,
+      icon: React.createElement("svg", {
+        width: "16",
+        height: "16",
+        fill: "none",
+        xmlns: "http://www.w3.org/2000/svg"
+      }, React.createElement("path", {
+        d: "M0 8a8 8 0 1 1 16 0A8 8 0 1 1 0 8Z",
+        className: "dnb-icon-close-circle-path"
+      }), React.createElement("path", {
+        d: "m5.5 10.5 5-5m0 5-5-5",
+        className: "dnb-icon-close-cross-path",
+        strokeWidth: "1.5",
+        strokeLinecap: "round",
+        strokeLinejoin: "round"
+      }))
+    }));
+  }
+};
+
+Tag.Group = TagGroup;
+export default Tag;

package/components/tag/Tag.tsx

@@ -0,0 +1,196 @@
+import React from 'react'
+import classnames from 'classnames'
+
+// Components
+import IconPrimary, { IconPrimaryIcon } from '../icon-primary/IconPrimary'
+import Button, { ButtonProps } from '../button/Button'
+
+// Shared
+import Context from '../../shared/Context'
+import { ISpacingProps } from '../../shared/interfaces'
+import { SkeletonShow } from '../skeleton/Skeleton'
+import { warn } from '../../shared/component-helper'
+import { usePropsWithContext } from '../../shared/hooks'
+
+// Internal
+import TagGroup from './TagGroup'
+import { TagGroupContext } from './TagContext'
+
+export interface TagProps {
+  /**
+   * The content of the tag element, can be a string or a React Element.
+   * Default: null
+   */
+  text?: string | React.ReactNode
+
+  /**
+   * Icon displaying on the left side
+   * Default: null
+   */
+  icon?: IconPrimaryIcon
+
+  /**
+   * Custom className on the component root
+   * Default: null
+   */
+  className?: string
+
+  /**
+   * Skeleton should be applied when loading content
+   * Default: null
+   */
+  skeleton?: SkeletonShow
+
+  /**
+   * The content of the tag element, can be a string or a React Element. Will be overwritten by text prop
+   * Default: null
+   */
+  children?: string | React.ReactNode // ReactNode allows multiple elements, strings, numbers, fragments, portals...
+
+  /**
+   * Handle the click event on 'tag' element
+   * Default: null
+   */
+  onClick?: React.MouseEventHandler<HTMLButtonElement>
+
+  /**
+   * Handle the delete event on 'tag' element
+   * Default: null
+   */
+  onDelete?: React.MouseEventHandler<HTMLButtonElement>
+
+  /**
+   * Handle the delete event on 'tag' element
+   * Default: null
+   */
+  omitOnKeyUpDeleteEvent?: boolean
+}
+
+export const defaultProps = {
+  className: null,
+  skeleton: false,
+  text: null,
+  children: null,
+  icon: null,
+  onClick: null,
+  onDelete: null,
+  omitOnKeyUpDeleteEvent: false,
+}
+
+const Tag = (localProps: TagProps & ISpacingProps) => {
+  // Every component should have a context
+  const context = React.useContext(Context)
+  const tagGroupContext = React.useContext(TagGroupContext)
+
+  // Extract additional props from global context
+  const {
+    className,
+    skeleton,
+    children,
+    text,
+    onClick,
+    onDelete,
+    omitOnKeyUpDeleteEvent,
+    ...props
+  } = usePropsWithContext(
+    localProps,
+    defaultProps,
+    context?.translation?.Tag,
+    context?.Tag,
+    tagGroupContext
+  )
+
+  const content = text || children
+  const isClickable = !!onClick
+  const isRemovable = !!onDelete && !isClickable
+  const isInteractive = isClickable || isRemovable
+
+  const tagClassNames = classnames(
+    'dnb-tag',
+    className,
+    isInteractive && 'dnb-tag--interactive',
+    isRemovable && 'dnb-tag--removable'
+  )
+
+  const isDeleteKeyboardEvent = (keyboardEvent) => {
+    return (
+      keyboardEvent.key === 'Backspace' || keyboardEvent.key === 'Delete'
+    )
+  }
+
+  const handleKeyUp = (event) => {
+    if (onDelete && isDeleteKeyboardEvent(event)) {
+      onDelete(event)
+    }
+  }
+
+  const buttonAttr: typeof props & Pick<ButtonProps, 'element' | 'type'> =
+    props
+
+  if (!isInteractive) {
+    buttonAttr.element = 'span'
+    buttonAttr.type = ''
+  }
+
+  if (isRemovable) {
+    buttonAttr.icon = getDeleteIcon()
+  }
+
+  if (!tagGroupContext) {
+    warn(
+      `Tag group required: A Tag requires a Tag.Group with label description as a parent component. This is to ensure correct semantic and accessibility.`
+    )
+  }
+
+  return (
+    <Button
+      data-testid="tag"
+      variant="unstyled"
+      size="small"
+      icon_position={isRemovable ? 'right' : 'left'}
+      className={tagClassNames}
+      on_click={onClick || onDelete}
+      text={content}
+      skeleton={skeleton}
+      onKeyUp={
+        isRemovable && !omitOnKeyUpDeleteEvent
+          ? (e) => handleKeyUp(e)
+          : undefined
+      }
+      {...buttonAttr}
+    />
+  )
+
+  function getDeleteIcon() {
+    return (
+      <IconPrimary
+        data-testid="tag-delete-icon"
+        inherit_color={false}
+        icon={
+          <svg
+            width="16"
+            height="16"
+            fill="none"
+            xmlns="http://www.w3.org/2000/svg"
+          >
+            <path
+              d="M0 8a8 8 0 1 1 16 0A8 8 0 1 1 0 8Z"
+              className="dnb-icon-close-circle-path"
+            />
+            <path
+              d="m5.5 10.5 5-5m0 5-5-5"
+              className="dnb-icon-close-cross-path"
+              strokeWidth="1.5"
+              strokeLinecap="round"
+              strokeLinejoin="round"
+            />
+          </svg>
+        }
+      />
+    )
+  }
+}
+
+Tag.Group = TagGroup
+
+export default Tag

package/components/tag/TagContext.js

@@ -0,0 +1,2 @@
+import React from 'react';
+export var TagGroupContext = React.createContext(null);

package/components/tag/TagContext.tsx

@@ -0,0 +1,3 @@
+import React from 'react'
+
+export const TagGroupContext = React.createContext(null)

package/components/tag/TagGroup.js

@@ -0,0 +1,47 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+var _excluded = ["label", "className", "children"];
+import "core-js/modules/es.array.map.js";
+import React from 'react';
+import classnames from 'classnames';
+import { createSpacingClasses } from '../space/SpacingHelper';
+import Context from '../../shared/Context';
+import { usePropsWithContext } from '../../shared/hooks';
+import { TagGroupContext } from './TagContext';
+export var defaultProps = {
+  label: null,
+  className: null,
+  children: null
+};
+
+var TagGroup = function TagGroup(localProps) {
+  var context = React.useContext(Context);
+
+  var _usePropsWithContext = usePropsWithContext(localProps, defaultProps, context === null || context === void 0 ? void 0 : context.TagGroup),
+      label = _usePropsWithContext.label,
+      className = _usePropsWithContext.className,
+      childrenProp = _usePropsWithContext.children,
+      props = _objectWithoutProperties(_usePropsWithContext, _excluded);
+
+  var children = childrenProp;
+
+  if (Array.isArray(childrenProp)) {
+    children = _toConsumableArray(childrenProp).map(function (child) {
+      return child;
+    });
+  }
+
+  var spacingClasses = createSpacingClasses(props);
+  return React.createElement(TagGroupContext.Provider, {
+    value: props
+  }, React.createElement("span", _extends({
+    className: classnames('dnb-tag__group', spacingClasses, className),
+    "data-testid": "tag-group"
+  }, props), React.createElement("span", {
+    "data-testid": "tag-group-label",
+    className: "dnb-sr-only"
+  }, label), children));
+};
+
+export default TagGroup;

package/components/tag/TagGroup.tsx

@@ -0,0 +1,76 @@
+import React from 'react'
+import classnames from 'classnames'
+
+// Components
+import { createSpacingClasses } from '../space/SpacingHelper'
+
+// Shared
+import Context from '../../shared/Context'
+import { ISpacingProps } from '../../shared/interfaces'
+import { usePropsWithContext } from '../../shared/hooks'
+import { TagGroupContext } from './TagContext'
+
+export interface TagGroupProps {
+  /**
+   * Aria label to describe the tag group
+   * Default: null
+   */
+  label: React.ReactNode
+
+  /**
+   * Custom className on the component root
+   * Default: null
+   */
+  className?: string
+
+  /**
+   * The tags to group.
+   * Default: null
+   */
+  children?: React.ReactNode
+}
+
+export const defaultProps = {
+  label: null,
+  className: null,
+  children: null,
+}
+
+const TagGroup = (localProps: TagGroupProps & ISpacingProps) => {
+  // Every component should have a context
+  const context = React.useContext(Context)
+  // Extract additional props from global context
+  const {
+    label,
+    className,
+    children: childrenProp,
+    ...props
+  } = usePropsWithContext(localProps, defaultProps, context?.TagGroup)
+
+  let children = childrenProp
+
+  if (Array.isArray(childrenProp)) {
+    children = [...childrenProp].map((child) => {
+      return child
+    })
+  }
+
+  const spacingClasses = createSpacingClasses(props)
+
+  return (
+    <TagGroupContext.Provider value={props}>
+      <span
+        className={classnames('dnb-tag__group', spacingClasses, className)}
+        data-testid="tag-group"
+        {...props}
+      >
+        <span data-testid="tag-group-label" className="dnb-sr-only">
+          {label}
+        </span>
+        {children}
+      </span>
+    </TagGroupContext.Provider>
+  )
+}
+
+export default TagGroup

package/components/tag/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Component Entry
+ *
+ */
+
+import Tag from './Tag'
+export default Tag
+export * from './Tag'

package/components/tag/index.js

@@ -0,0 +1,3 @@
+import Tag from './Tag';
+export default Tag;
+export * from './Tag';