@vertigis/react-ui 9.13.0 → 10.1.0

package/utils/intl.js

@@ -7,9 +7,10 @@
 // functions.
 /**
  * Formats a date for display. The time portion will not appear in the output.
+ *
  * @param date The Date value to format.
  * @param locale An optional locale to use. If not specified, the browser's
- * locale will be used.
+ *   locale will be used.
  * @param options Additional options that control how the date is formatted.
  */
 export function formatDate(date, options, locale = navigator.language) {
@@ -17,9 +18,10 @@ export function formatDate(date, options, locale = navigator.language) {
 }
 /**
  * Formats a time for display. The date portion will not appear in the output.
+ *
  * @param date The Date value to format.
  * @param locale An optional locale to use. If not specified, the browser's
- * locale will be used.
+ *   locale will be used.
  * @param options Additional options that control how the time is formatted.
  */
 export function formatTime(date, options, locale = navigator.language) {
@@ -27,20 +29,21 @@ export function formatTime(date, options, locale = navigator.language) {
 }
 /**
  * Formats a date and time for display.
+ *
  * @param date The Date value to format.
  * @param locale An optional locale to use. If not specified, the browser's
- * locale will be used.
- * @param options Additional options that control how the date & time are
- * formatted.
+ *   locale will be used.
+ * @param options Additional options that control how the date & time are formatted.
  */
 export function formatDateTime(date, options, locale = navigator.language) {
     return date ? date.toLocaleString(locale, options) : "";
 }
 /**
  * Formats a number for display.
+ *
  * @param number The number to format.
  * @param locale An optional locale to use. If not specified, the browser's
- * locale will be used.
+ *   locale will be used.
  * @param options Additional options that control how the number is formatted.
  */
 export function formatNumber(number, options, locale = navigator.language) {

package/utils/markdown.d.ts

@@ -5,9 +5,9 @@ export interface MarkdownToHtmlOptions {
     /**
      * If specified, produces HTML that is valid to place within an HTML element
      * that only supports inline content (called "phrasing content" in the HTML5
-     * spec). Example elements that only support phrasing content are <span> and
-     * <h2>. In this mode, any block-level elements resulting from the Markdown
-     * conversion will be stripped. The default is `false`.
+     * spec). Example elements that only support phrasing content are <span>
+     * and<h2>. In this mode, any block-level elements resulting from the
+     * Markdown conversion will be stripped. The default is `false`.
      */
     inline?: boolean;
     /**
@@ -21,6 +21,14 @@ export interface MarkdownToHtmlOptions {
      */
     escapeHtml?: boolean;
 }
+/**
+ * Converts markdown text into HTML. The resulting HTML is sanitized and safe to
+ * insert into the DOM.
+ *
+ * @param markdown The markdown text to convert.
+ * @param options Options that affect how the text is converted.
+ */
+export declare function markdownToSafeHtml(markdown: string, options?: MarkdownToHtmlOptions): string;
 /**
  * Converts markdown text into HTML.
  *

package/utils/markdown.js

@@ -1,15 +1,25 @@
 import escapeHtml from "lodash.escape";
 import { marked } from "marked";
+import { sanitizeHtml } from "./html.js";
 /**
  * A custom marked renderer that escapes HTML in the original markdown.
  */
 class EscapeHtmlRenderer extends marked.Renderer {
     html(html) {
-        /* eslint-disable @typescript-eslint/no-unsafe-call */
         return escapeHtml(html);
     }
 }
 EscapeHtmlRenderer.instance = new EscapeHtmlRenderer();
+/**
+ * Converts markdown text into HTML. The resulting HTML is sanitized and safe to
+ * insert into the DOM.
+ *
+ * @param markdown The markdown text to convert.
+ * @param options Options that affect how the text is converted.
+ */
+export function markdownToSafeHtml(markdown, options) {
+    return sanitizeHtml(markdownToHtml(markdown, options));
+}
 /**
  * Converts markdown text into HTML.
  *

package/utils/react.d.ts

@@ -0,0 +1,15 @@
+import type { MutableRefObject, Ref, RefCallback } from "react";
+/**
+ * Produces a unique ID that can be used for the HTML `id` attribute. Will use
+ * the provided value if defined (typically obtained from the calling
+ * component's `id` prop), otherwise one will be generated. The ID will remain
+ * the same between renders (even if `idProp` changes).
+ */
+export declare function useId(idProp?: string): string;
+/**
+ * Combines multiple refs into a single ref.
+ *
+ * Useful when a component needs a ref to one of its own elements, but also
+ * supports forwarding a ref from its parent component.
+ */
+export declare function mergeRefs<T>(...refs: (RefCallback<T> | MutableRefObject<T | null> | null)[]): Ref<T>;

package/utils/react.js

@@ -0,0 +1,42 @@
+import { useState } from "react";
+/**
+ * Generate a random 10 digit id.
+ *
+ * @param prefix An optional prefix to prepend to the generated id.
+ * @internal
+ */
+export function _generateId(prefix) {
+    const randomId = Math.random().toString(36).substr(2, 10);
+    if (!prefix) {
+        return randomId;
+    }
+    return `${prefix}-${randomId}`;
+}
+/**
+ * Produces a unique ID that can be used for the HTML `id` attribute. Will use
+ * the provided value if defined (typically obtained from the calling
+ * component's `id` prop), otherwise one will be generated. The ID will remain
+ * the same between renders (even if `idProp` changes).
+ */
+export function useId(idProp) {
+    const [id] = useState(() => idProp ?? _generateId());
+    return id;
+}
+/**
+ * Combines multiple refs into a single ref.
+ *
+ * Useful when a component needs a ref to one of its own elements, but also
+ * supports forwarding a ref from its parent component.
+ */
+export function mergeRefs(...refs) {
+    return (value) => {
+        refs.forEach(ref => {
+            if (typeof ref === "function") {
+                ref(value);
+            }
+            else if (ref) {
+                ref.current = value;
+            }
+        });
+    };
+}

package/utils/url.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Clears the hash string.
+ */
+export declare function clearHashParams(): void;
+/**
+ * Returns the decoded hash parameter value for a given key.
+ *
+ * @param key The key used to return a value.
+ */
+export declare function getHashParam(key: string): string | undefined;
+export declare function getQueryStringParam(key: string): string | undefined;
+/**
+ * Builds and sets the hash string.
+ *
+ * @param kvp An object with hash parameters as key/value pairs.
+ */
+export declare function setHashParams(kvp: {
+    [key: string]: string;
+}): void;

package/utils/url.js

@@ -0,0 +1,74 @@
+/**
+ * Clears the hash string.
+ */
+export function clearHashParams() {
+    history.replaceState(null, document.title, getUrlWithoutHash());
+}
+/**
+ * Returns the decoded hash parameter value for a given key.
+ *
+ * @param key The key used to return a value.
+ */
+export function getHashParam(key) {
+    return getKeyValuePairs()[key];
+}
+export function getQueryStringParam(key) {
+    const params = new URL(window.location.href).searchParams;
+    const value = params.get(key);
+    // Prefer undefined over null
+    return typeof value === "string" ? value : undefined;
+}
+/**
+ * Returns the hash string.
+ */
+function getHashParamString() {
+    return location.hash.substring(1);
+}
+/**
+ * Returns an object with hash parameters as key/value pairs.
+ */
+function getKeyValuePairs() {
+    const kvp = {};
+    if (hasHashParams()) {
+        const params = getHashParamString().split("&");
+        for (const param of params) {
+            const keyPair = param.split("=");
+            kvp[decodeURIComponent(keyPair[0])] = decodeURIComponent(keyPair[1]);
+        }
+    }
+    return kvp;
+}
+/**
+ * Returns the URL without the hash string.
+ */
+function getUrlWithoutHash() {
+    return `${location.protocol}//${location.host}${location.pathname}${location.search}`;
+}
+/**
+ * Whether the window currently has a hash string.
+ */
+function hasHashParams() {
+    return !!location.hash;
+}
+/**
+ * Builds and sets the hash string.
+ *
+ * @param kvp An object with hash parameters as key/value pairs.
+ */
+export function setHashParams(kvp) {
+    const hashParamList = [];
+    for (const key of Object.keys(kvp)) {
+        hashParamList.push(`${encodeURIComponent(key)}=${encodeURIComponent(kvp[key])}`);
+    }
+    const hashParamString = `#${hashParamList.join("&")}`;
+    setHashParamsString(hashParamString);
+}
+/**
+ * Sets the hash string.
+ *
+ * @param paramsString The string to be set as the hash string.
+ */
+function setHashParamsString(paramsString) {
+    paramsString = paramsString.startsWith("#") ? paramsString : `#${paramsString}`;
+    history.replaceState(null, document.title, getUrlWithoutHash() + paramsString);
+}

package/CircularProgress/CircularProgress.d.ts

@@ -1,2 +0,0 @@
-export { default } from "@mui/material/CircularProgress";
-export * from "@mui/material/CircularProgress";

package/CircularProgress/CircularProgress.js

@@ -1,2 +0,0 @@
-export { default } from "@mui/material/CircularProgress";
-export * from "@mui/material/CircularProgress";