@ostack.tech/ui 0.3.1 → 0.3.3

package/dist/types/components/DataTable/DataTablePagination.d.ts

@@ -1,4 +1,5 @@
-import { ComponentPropsWithoutRef, ReactNode } from 'react';
+import { ComponentPropsWithoutRef, ComponentPropsWithRef, ReactNode } from 'react';
+import { IconButton } from '../IconButton';
 /** Properties of the data table pagination component. */
 export interface DataTablePaginationProps extends ComponentPropsWithoutRef<"div"> {
     /**
@@ -13,6 +14,13 @@ export interface DataTablePaginationProps extends ComponentPropsWithoutRef<"div"
     previousPageButtonLabel?: string;
     /** Label of the next page button (only relevant in paged mode). */
     nextPageButtonLabel?: string;
+    /**
+     * Properties to pass to the previous page button (only relevant in paged
+     * mode).
+     */
+    previousPageButtonProps?: ComponentPropsWithRef<typeof IconButton>;
+    /** Properties to pass to the next page button (only relevant in paged mode). */
+    nextPageButtonProps?: ComponentPropsWithRef<typeof IconButton>;
 }
 /** Component used to provide pagination to the data table. */
 export declare const DataTablePagination: import('react').ForwardRefExoticComponent<DataTablePaginationProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/types/components/DataTable/PagedDataTablePagination.d.ts

@@ -1,7 +1,7 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { DataTablePaginationProps } from './DataTablePagination.tsx';
 /** Properties of the scrolled data table pagination. */
-export interface PagedDataTablePaginationProps extends ComponentPropsWithoutRef<"div">, Pick<DataTablePaginationProps, "rowsRange" | "previousPageButtonLabel" | "nextPageButtonLabel"> {
+export interface PagedDataTablePaginationProps extends ComponentPropsWithoutRef<"div">, Pick<DataTablePaginationProps, "rowsRange" | "previousPageButtonLabel" | "nextPageButtonLabel" | "previousPageButtonProps" | "nextPageButtonProps"> {
 }
 /** Pagination component of the scrolled data table. */
 export declare const PagedDataTablePagination: import('react').ForwardRefExoticComponent<PagedDataTablePaginationProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/types/index.d.ts

@@ -71,6 +71,7 @@ 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/numericStringUtils.ts';

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

@@ -0,0 +1,85 @@
+/** 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 {};

package/package.json

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