@ostack.tech/ui 0.3.4 → 0.4.0

package/dist/types/components/FeedbackPopover/FeedbackPopover.d.ts

@@ -1,5 +1,5 @@
-import { IconProp } from '@fortawesome/fontawesome-svg-core';
 import { ComponentPropsWithoutRef, ComponentPropsWithRef, ReactNode } from 'react';
+import { IconProp } from '../Icon';
 import { IconButton, IconButtonSize } from '../IconButton';
 import { PopoverContent } from '../Popover';
 /** Properties of the feedback popover component. */

package/dist/types/index.d.ts

@@ -71,9 +71,9 @@ export * from './utils/control.ts';
 export * from './utils/cx.ts';
 export * from './utils/filtering.ts';
 export * from './utils/keyboardShortcut.ts';
-export * from './utils/locationUtils.ts';
 export * from './utils/mergeAriaIds.ts';
 export * from './utils/nativeControls.ts';
+export * from './utils/navigate.ts';
 export * from './utils/numericStringUtils.ts';
 export * from './utils/parseDateStrict.ts';
 export * from './utils/sorting.ts';
@@ -86,12 +86,15 @@ export * from './utils/useDateTransformer.tsx';
 export * from './utils/useIntersectionObserver.ts';
 export * from './utils/useLatestValues.ts';
 export * from './utils/useLayoutEffect.ts';
+export * from './utils/useLocation.ts';
 export * from './utils/useMeasure.ts';
 export * from './utils/useMediaQuery.ts';
 export * from './utils/useNumericTransformer.tsx';
 export * from './utils/useResponsiveValues.ts';
 export * from './utils/useScrollbarSize.ts';
 export * from './utils/useScrollPosition.ts';
+export * from './utils/useSearchParam.ts';
+export * from './utils/useSearchParams.ts';
 export * from './utils/useSpacing.ts';
 export * from './utils/warnOnce.ts';
 export * from './utils/zustandUtils.ts';

package/dist/types/utils/navigate.d.ts

@@ -0,0 +1,16 @@
+/** Options used to navigate to a new location. */
+export interface NavigationOptions {
+    /** Optional state to push. */
+    state?: unknown;
+    /**
+     * Whether to replace the current history entry.
+     *
+     * @default false
+     */
+    replace?: boolean;
+}
+/**
+ * Function used to navigate to a new URL (small utility function around
+ * `history.pushState` and `history.replaceState`).
+ */
+export declare function navigate(url: string | URL, options?: NavigationOptions): void;

package/dist/types/utils/useLocation.d.ts

@@ -0,0 +1,30 @@
+/** Representation of the URL's location path (`pathname`, `search`, and `hash`). */
+interface LocationPath {
+    /**
+     * String containing the pathname of the URL.
+     *
+     * _E.g._, `/foo/bar` in `https://example.org:8080/foo/bar?q=baz#bang`.
+     */
+    readonly pathname: string;
+    /**
+     * Search string (also known as _query string_): `"?"` followed by the
+     * parameters of the URL or an empty string if there are no such parameters.
+     *
+     * _E.g._, `?q=baz` in `https://example.org:8080/foo/bar?q=baz#bang`.
+     */
+    readonly search: string;
+    /**
+     * `"#"` followed by the fragment identifier of the URL or an empty string if
+     * there is no fragment identifier.
+     *
+     * _E.g._, `#bang` in `https://example.org:8080/foo/bar?q=baz#bang`.
+     */
+    readonly hash: string;
+}
+/**
+ * Hook exposing the current location and a function to navigate to a new
+ * location.
+ */
+export declare function useLocation(): LocationPath;
+export declare function useLocation<T>(selector: (location: LocationPath) => T): T;
+export {};

package/dist/types/utils/useSearchParam.d.ts

@@ -0,0 +1,26 @@
+import { SetSearchParamsOptions } from './useSearchParams.ts';
+/** Options used to navigate to the new search parameter. */
+export interface SetSearchParamOptions extends SetSearchParamsOptions {
+    /**
+     * Whether the search parameter should be cleared when its value equals the
+     * default value.
+     *
+     * @default false
+     */
+    clearDefaultValue?: boolean;
+}
+/** Result of the {@link useSearchParam} hook. */
+export type UseSearchParamResult<TValue extends string | undefined = string | undefined> = [
+    searchParamValue: TValue,
+    setSearchParamValue: (nextSearchParamValue: {
+        toString(): string;
+    } | null | undefined | ((prevSearchParamValue: TValue) => {
+        toString(): string;
+    } | null | undefined), options?: SetSearchParamOptions) => void
+];
+/**
+ * Hook exposing the value of a single URL search parameter and a function to
+ * update it.
+ */
+export declare function useSearchParam(searchParam: string): UseSearchParamResult;
+export declare function useSearchParam(searchParam: string, defaultValue: string): UseSearchParamResult<string>;

package/dist/types/utils/useSearchParams.d.ts

@@ -0,0 +1,20 @@
+import { NavigationOptions } from './navigate.ts';
+/** Options used to navigate to the new search parameters. */
+export interface SetSearchParamsOptions extends NavigationOptions {
+    /**
+     * Whether to clear the URL's hash when navigating.
+     *
+     * @default false
+     */
+    clearHash?: boolean;
+}
+/** Result of the {@link useSearchParams} hook. */
+export type UseSearchParamsResult = [
+    searchParams: URLSearchParams,
+    setSearchParams: (nextSearchParams: (string[][] | Record<string, string> | string | URLSearchParams) | ((prevSearchParams: URLSearchParams) => string[][] | Record<string, string> | string | URLSearchParams), options?: SetSearchParamsOptions) => void
+];
+/**
+ * Hook exposing the current URL search parameters and a function to update
+ * them.
+ */
+export declare function useSearchParams(): UseSearchParamsResult;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ostack.tech/ui",
   "description": "ostack/UI component library.",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "homepage": "https://ui.ostack.tech/",
   "author": {
     "name": "Opensoft",

package/dist/types/utils/locationUtils.d.ts

@@ -1,85 +0,0 @@
-/** Representation of the URL's location path (`pathname`, `search`, and `hash`). */
-interface LocationPath {
-    /**
-     * String containing the pathname of the URL.
-     *
-     * _E.g._, `/foo/bar` in `https://example.org:8080/foo/bar?q=baz#bang`.
-     */
-    readonly pathname: string;
-    /**
-     * Search string (also known as _query string_): `"?"` followed by the
-     * parameters of the URL or an empty string if there are no such parameters.
-     *
-     * _E.g._, `?q=baz` in `https://example.org:8080/foo/bar?q=baz#bang`.
-     */
-    readonly search: string;
-    /**
-     * `"#"` followed by the fragment identifier of the URL or an empty string if
-     * there is no fragment identifier.
-     *
-     * _E.g._, `#bang` in `https://example.org:8080/foo/bar?q=baz#bang`.
-     */
-    readonly hash: string;
-}
-/** Options used to navigate to a new location. */
-export interface NavigationOptions {
-    /** Optional state to push. */
-    state?: unknown;
-    /**
-     * Whether to replace the current history entry.
-     *
-     * @default false
-     */
-    replace?: boolean;
-}
-/** Result of the {@link useLocation} hook. */
-export type UseLocationResult = [
-    location: LocationPath,
-    navigate: (url: string | URL, options?: NavigationOptions) => void
-];
-/**
- * Hook exposing the current location and a function to navigate to a new
- * location.
- */
-export declare function useLocation(): UseLocationResult;
-/** Options used to navigate to the new search parameters. */
-export interface SetSearchParamsOptions extends NavigationOptions {
-    /**
-     * Whether to clear the URL's hash when navigating.
-     *
-     * @default false
-     */
-    clearHash?: boolean;
-}
-/** Result of the {@link useSearchParams} hook. */
-export type UseSearchParamsResult = [
-    searchParams: URLSearchParams,
-    setSearchParams: (nextSearchParams: (string[][] | Record<string, string> | string | URLSearchParams) | ((prevSearchParams: URLSearchParams) => string[][] | Record<string, string> | string | URLSearchParams), options?: SetSearchParamsOptions) => void
-];
-/**
- * Hook exposing the current URL search parameters and a function to update
- * them.
- */
-export declare function useSearchParams(): UseSearchParamsResult;
-/** Options used to navigate to the new search parameter. */
-export interface SetSearchParamOptions extends SetSearchParamsOptions {
-    /**
-     * Whether the search parameter should be cleared when its value equals the
-     * default value.
-     *
-     * @default false
-     */
-    clearDefaultValue?: boolean;
-}
-/** Result of the {@link useSearchParam} hook. */
-export type UseSearchParamResult<TValue extends string | undefined = string | undefined> = [
-    searchParamValue: TValue,
-    setSearchParamValue: (nextSearchParamValue: string | number | bigint | boolean | null | undefined | ((prevSearchParamValue: TValue) => string | number | bigint | boolean | null | undefined), options?: SetSearchParamOptions) => void
-];
-/**
- * Hook exposing the value of a single URL search parameter and a function to
- * update it.
- */
-export declare function useSearchParam(searchParam: string): UseSearchParamResult;
-export declare function useSearchParam(searchParam: string, defaultValue: string): UseSearchParamResult<string>;
-export {};