SF DesignDev Packages

Appearance

Return to top
On this page

@screaming/utils

Introduction

@screaming/utils is a collection of utility functions, written in TypeScript. TypeScript knowledge is not required, however, as the functions can be used in JavaScript-only projects as well!

View source code.

Installation

TIP

@screaming/utils comes pre-installed in all @screaming/froggo projects.

Install with your favourite package manager:

sh
# yarn
yarn add @screaming/utils

# pnpm
pnpm install @screaming/utils

# npm
npm install @screaming/utils
1
2
3
4
5
6
7
8

Import as required:

ts
import { ... } from '@screaming/utils'
1

Deprecated Utilities

Some deprecated functions/classes are still available in @screaming/utils:

  • Accordion.ts
  • AnimationController.ts
  • appendChildren.ts
  • BrowserChecker.ts
  • createAccordions.ts
  • delegateEvents.ts
  • ElementCache.ts
  • El.ts
  • findObjects.ts
  • index.ts
  • moveElAtBreakpoint.ts
  • removeChildren.ts
  • updateAttribute.ts

These can be imported like so:

ts
import { ... } from '@screaming/utils/deprecated'
1