Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@kompanion/utils

0.0.5 • Public • Published

@kompanion/utils

Tiny snippets of useful javascript code for websites and apps.

npm i @kompanion/utils
# or 
yarn add @kompanion/utils

Utilities

As @kompanion/utils is written in Typescript, you get automatic intellisense by default if using editors like VS Code.

Arrays

shuffleArray

Self explanatory. The only argument is an array:

import { shuffleArray } from '@kompanion/utils';
 
const emojis = ['😄', '🤨', '🧡', '😝'];
const randomEmoji = shuffleArray(emojis)[0];

DOM-related

scrollToId

Single argument: id: string

Uses the scrollIntoView API to smoothly scroll the screen to the object defined by the given id. If no object is found, does nothing.

<button onClick="scrollToId('contact')">Get in contact</button>

getWindowSize

Checks if there's a window object (if it's a browser) and returns an object: {width: num, height: num}

Development helpers

isDevEnv

React

textToParagraphs

Social Sharing

Pass an URL (string) to getFbShareUrl or getTwitterShareUrl to get back a string with a new URL for sharing. getLinkedinUrl also asks for a title string.

Strings

boldString

italicizeString

slugifyString

removeWhitespace

removeSpecialCharacters

lowercaseFirstLetter

capitalizeFirstLetter

keyFromString

getRandomNumber

getProperSlug

checkIfAbsUrl

TODO

  • Add another tsconfig for an ES5 bundle
  • Finish documentation

Install

npm i @kompanion/utils

DownloadsWeekly Downloads

2

Version

0.0.5

License

none

Unpacked Size

17 kB

Total Files

24

Last publish

Collaborators

  • avatar