@cdx/utils

A lightweight utility library for common JavaScript and TypeScript functionality, designed to streamline development and improve code reusability for Clarity developers.

Installation

Install the package via npm:

npm install @cdx/utils

Features

• checkBrowser: Checks the user's browser and returns an object with browser information.
• debounce: Debounce function, makes sure that your code is only triggered once per user input.
• generateVimeoEmbedUrl: Grabs the video embed URL from a Vimeo URL.
• generateYouTubeEmbedUrl: Grabs the video embed URL from a YouTube URL.
• getAllPosts: Returns all posts based on it's endpoint. Defaults to 'posts'.
• getAncestorNodes: Retrieves an array of ancestor nodes.
• getPost: Gets object data of a post by its ID and endpoint and returns a state.
• getPosts: Gets an array of post data based on an array of post ID's and an endpoint and returns a state.
• getVimeoId: Grabs the video ID from a Vimeo URL.
• getYouTubeId: Grabs the video ID from a YouTube URL.
• isEmpty: Checks whether parameter is empty.
• isObject: Checks whether parameter is an object.
• isTouch: Detects if the device has a touch screen.
• isVimeo: Checks if the URL belongs to vimeo.com.
• isYouTube: Checks if the URL belongs to youtube.com.
• pxToRem: Converts a pixel value to rem value.
• remToPx: Converts rem value to a pixel value.
• removeClass: Remove a class from a single element or a NodeList.
• reorder: Reorders an array.
• setHeight: Adds a --max-height style property to a define element by a defined height.
• slugify: "Slugify" a string input.
• smoothScroller: Smooth scroll animations for hash links to navigate a user to another part of a page.
• svg: Returns and <svg> element including a <use> element which reference's the theme's spritesheet.
• updateField: Updates a specific field in an array based on the index.
• wrap: Wraps specified elements with a given wrapper element.