Functions#

import { isTouchDevice } from '@dnb/eufemia/shared/component-helper'

isTouchDevice() // returns Boolean

import { toPascalCase } from '@dnb/eufemia/shared/component-helper'

toPascalCase(String) // returns String

import { toKebabCase } from '@dnb/eufemia/shared/component-helper'

toKebabCase(String) // returns String

import { filterProps } from '@dnb/eufemia/shared/component-helper'

filterProps(props: Object|Array, remove*: Object|Array|Function, allowed*: Object|Array|Function) // returns Object|Array

import { makeUniqueId } from '@dnb/eufemia/shared/component-helper'

makeUniqueId(prefix*: String, length*: Number) // returns String

import { slugify } from '@dnb/eufemia/shared/component-helper'

slugify(String) // returns String

import { checkIfHasScrollbar } from '@dnb/eufemia/shared/component-helper'

checkIfHasScrollbar(HTMLElement) // returns Boolean

import { convertJsxToString } from '@dnb/eufemia/shared/component-helper'

convertJsxToString(element: HTMLElement, separator*: String) // returns String

import { InteractionInvalidation } from '@dnb/eufemia/shared/component-helper'

const instance = new InteractionInvalidation()

// Avoid invalidating inside here
instance.setBypassSelector('.dnb-modal__content *')

// Enable the invalidation
instance.activate()

// Optionally, set an element selector instead of affecting everything inside the body
instance.activate('.selector')

// Remove the invalidation
instance.revert()

import { scrollToLocationHashId } from '@dnb/eufemia/shared/helpers'

// in case there is a #hash in the url
const elem = scrollToLocationHashId({
  offset: 100,
  delay: 100,
  onCompletion: (elem) => {
    try {
      elem.classList.add('focus')
    } catch (e) {
      //
    }
  },
}) // returns HTMLElement

import { getOffsetTop } from '@dnb/eufemia/shared/helpers'

getOffsetTop(element: HTMLElement) // returns Number

import { applyPageFocus } from '@dnb/eufemia/shared/helpers'

applyPageFocus(selector*: String, callback*: Function)

import { setPageFocusElement } from '@dnb/eufemia/shared/helpers'

setPageFocusElement(selectorOrElement: String|HTMLElement, key*: String) // returns Void

import { debounce } from '@dnb/eufemia/shared/helpers'

const debounceFunc = ({ foo }) => { ... }

const debounced = debounce(
  debounceFunc,
  wait = 500, // milliseconds
  {
    immediate = false, // execute the debounceFunc on the leading edge
  } = {},
)

debounced({ foo: 'bar' }) // Delay the execution again

debounced.cancel() // optional, cancel the execution

import { debounceAsync } from '@dnb/eufemia/shared/helpers'

async function debounceFunc({ foo }) {
  // Optionally, add a cancel event (wasCanceled is a function to check later if it was canceled)
  const wasCanceled = this.addCancelEvent(myCancelMethod)

  await wait(1000) // Do something async
}

const myCancelMethod = () => {
  console.log('canceled')
}

const debounced = debounceAsync(
  debounceFunc,
  (wait = 500) // milliseconds
)

debounceAsync({ foo: 'bar' }) // Delay the execution again

debounced.cancel() // Optional: cancel the execution
debounced.addCancelEvent(myCancelMethod) // Alternatively, you can add the cancel event like this

import { type DebounceHelpers } from '@dnb/eufemia/shared/helpers'

async function debounceFunc(
  this: DebounceHelpers,
  { foo }: { foo: string }
) {
  const wasCanceled = this.addCancelEvent(myCancelMethod)
  // ...
}

import { isModifiedClickEvent } from '@dnb/eufemia/shared/helpers'

isModifiedClickEvent(event) // returns Boolean

import { copyToClipboard } from '@dnb/eufemia/shared/helpers'

copyToClipboard(string) // returns success: String|Boolean|Error