@alextheman/components 6.25.2 → 6.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +183 -165
- package/dist/index.d.ts +187 -169
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/v7/index.cjs +1 -1
- package/dist/v7/index.cjs.map +1 -1
- package/dist/v7/index.js +1 -1
- package/dist/v7/index.js.map +1 -1
- package/package.json +2 -3
package/dist/index.d.cts
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
import { CollapseProps } from "@mui/material/Collapse";
|
|
2
|
-
import { PaletteMode, SxProps, Theme } from "@mui/material/styles";
|
|
2
|
+
import { PaletteMode, SxProps, Theme, ThemeOptions } from "@mui/material/styles";
|
|
3
3
|
import { CSSProperties, ComponentProps, ComponentPropsWithRef, ComponentPropsWithoutRef, ComponentType, Dispatch, ElementType, JSX, Key, MouseEventHandler, ReactNode, Ref, SetStateAction } from "react";
|
|
4
4
|
import { LinkProps } from "@mui/material/Link";
|
|
5
5
|
import { CreateEnumType, OptionalOnCondition } from "@alextheman/utility";
|
|
6
6
|
import Button$1, { ButtonOwnProps, ButtonProps } from "@mui/material/Button";
|
|
7
|
-
import { LiveProvider } from "react-live";
|
|
8
7
|
import { CommonProps, OverridableComponent } from "@mui/material/OverridableComponent";
|
|
9
8
|
import { SwitchProps } from "@mui/material/Switch";
|
|
10
9
|
import { MenuProps } from "@mui/material/Menu";
|
|
11
10
|
import { MenuItemOwnProps } from "@mui/material/MenuItem";
|
|
12
11
|
import { SvgIconTypeMap } from "@mui/material/SvgIcon";
|
|
13
12
|
import { ListItemButtonProps } from "@mui/material/ListItemButton";
|
|
14
|
-
import { TypographyProps } from "@mui/material/Typography";
|
|
15
13
|
import { AlertColor } from "@mui/material/Alert";
|
|
14
|
+
import { TypographyProps } from "@mui/material/Typography";
|
|
15
|
+
import { LiveProvider } from "react-live";
|
|
16
16
|
|
|
17
17
|
//#region src/components/Artwork.d.ts
|
|
18
18
|
/** The artwork associated with the package's theme song, _An Interface For You And I_. */
|
|
@@ -137,10 +137,6 @@ declare function FileInputList({
|
|
|
137
137
|
...fileInputProps
|
|
138
138
|
}: FileInputListProps): import("react/jsx-runtime").JSX.Element;
|
|
139
139
|
//#endregion
|
|
140
|
-
//#region src/components/ModeToggle.d.ts
|
|
141
|
-
/** A toggle to switch between dark mode and light mode. Must be used in a `ModeProvider`. */
|
|
142
|
-
declare function ModeToggle(): import("react/jsx-runtime").JSX.Element;
|
|
143
|
-
//#endregion
|
|
144
140
|
//#region src/components/Page.d.ts
|
|
145
141
|
interface PageProps {
|
|
146
142
|
/** The Page title to show */
|
|
@@ -294,46 +290,6 @@ declare function QueryBoundaryFallback({
|
|
|
294
290
|
...queryBoundaryNullableProps
|
|
295
291
|
}: QueryBoundaryFallbackProps): import("react/jsx-runtime").JSX.Element;
|
|
296
292
|
//#endregion
|
|
297
|
-
//#region src/groups/QueryBoundary/index.d.ts
|
|
298
|
-
interface QueryBase {
|
|
299
|
-
/** The current loading status (true if loading, false if not) */
|
|
300
|
-
isLoading?: boolean;
|
|
301
|
-
/** The error given if the response gave an error. */
|
|
302
|
-
error?: unknown;
|
|
303
|
-
}
|
|
304
|
-
interface QuerySingle<DataType> extends QueryBase {
|
|
305
|
-
/** The data being loaded. */
|
|
306
|
-
data: DataType | null | undefined;
|
|
307
|
-
dataCollection?: never;
|
|
308
|
-
}
|
|
309
|
-
interface QueryMultiple<ItemType> extends QueryBase {
|
|
310
|
-
/** An array of data items being loaded. */
|
|
311
|
-
dataCollection: Array<ItemType> | null | undefined;
|
|
312
|
-
data?: never;
|
|
313
|
-
}
|
|
314
|
-
type Query<DataType> = QuerySingle<DataType> | QueryMultiple<DataType>;
|
|
315
|
-
interface CreateQueryBoundaryParameters<DataType> {
|
|
316
|
-
query: Query<DataType>;
|
|
317
|
-
}
|
|
318
|
-
interface DefaultQueryBoundaryComponents<DataType> {
|
|
319
|
-
Context: (props: {
|
|
320
|
-
children: ReactNode;
|
|
321
|
-
}) => JSX.Element;
|
|
322
|
-
Error: typeof QueryBoundaryError;
|
|
323
|
-
Data: typeof QueryBoundaryData<DataType>;
|
|
324
|
-
DataMap: typeof QueryBoundaryDataMap<DataType>;
|
|
325
|
-
Fallback: typeof QueryBoundaryFallback;
|
|
326
|
-
Nullable: typeof QueryBoundaryNullable;
|
|
327
|
-
}
|
|
328
|
-
/**
|
|
329
|
-
* A creator function to create a system of QueryBoundary components with the data fully typed throughout.
|
|
330
|
-
*
|
|
331
|
-
* @deprecated Please use either `createBaseQueryBoundary`, `createItemQueryBoundary`, or `createListQueryBoundary` from `@alextheman/components/v7` instead.
|
|
332
|
-
*/
|
|
333
|
-
declare function createQueryBoundary<DataType>({
|
|
334
|
-
query
|
|
335
|
-
}: CreateQueryBoundaryParameters<DataType>): DefaultQueryBoundaryComponents<DataType>;
|
|
336
|
-
//#endregion
|
|
337
293
|
//#region src/types/ContextHookOptions.d.ts
|
|
338
294
|
interface ContextHookOptions<Strict extends boolean = true> {
|
|
339
295
|
/** Error if the context is missing if this is set to true. */
|
|
@@ -385,7 +341,7 @@ declare function QueryBoundaryProvider<DataType>({
|
|
|
385
341
|
}: QueryBoundaryProviderProps<DataType>): import("react/jsx-runtime").JSX.Element;
|
|
386
342
|
//#endregion
|
|
387
343
|
//#region src/groups/QueryBoundary/creators/createBaseQueryBoundary.d.ts
|
|
388
|
-
interface QueryBase
|
|
344
|
+
interface QueryBase<DataType> {
|
|
389
345
|
/** The current loading status (true if loading, false if not) */
|
|
390
346
|
isLoading?: boolean;
|
|
391
347
|
/** The error given if the response gave an error. */
|
|
@@ -394,7 +350,7 @@ interface QueryBase$1<DataType> {
|
|
|
394
350
|
data: DataType;
|
|
395
351
|
}
|
|
396
352
|
interface CreateBaseQueryBoundaryParameters<DataType> {
|
|
397
|
-
query: QueryBase
|
|
353
|
+
query: QueryBase<DataType>;
|
|
398
354
|
}
|
|
399
355
|
interface DefaultQueryBoundaryComponentsBase {
|
|
400
356
|
Context: (props: {
|
|
@@ -410,7 +366,7 @@ declare function createBaseQueryBoundary<DataType>({
|
|
|
410
366
|
}: CreateBaseQueryBoundaryParameters<DataType>): DefaultQueryBoundaryComponentsBase;
|
|
411
367
|
//#endregion
|
|
412
368
|
//#region src/groups/QueryBoundary/creators/createItemQueryBoundary.d.ts
|
|
413
|
-
interface QueryItem<DataType> extends Omit<QueryBase
|
|
369
|
+
interface QueryItem<DataType> extends Omit<QueryBase<DataType>, "data"> {
|
|
414
370
|
/** The data being loaded. */
|
|
415
371
|
data: DataType | null | undefined;
|
|
416
372
|
}
|
|
@@ -426,7 +382,7 @@ declare function createItemQueryBoundary<DataType>({
|
|
|
426
382
|
}: CreateItemQueryBoundaryParameters<DataType>): DefaultQueryBoundaryItemComponents<DataType>;
|
|
427
383
|
//#endregion
|
|
428
384
|
//#region src/groups/QueryBoundary/creators/createListQueryBoundary.d.ts
|
|
429
|
-
interface QueryList<DataType> extends Omit<QueryBase
|
|
385
|
+
interface QueryList<DataType> extends Omit<QueryBase<DataType>, "data"> {
|
|
430
386
|
/** The data being loaded. */
|
|
431
387
|
data: Array<DataType> | null | undefined;
|
|
432
388
|
}
|
|
@@ -488,18 +444,6 @@ declare function QueryBoundaryWrapper<DataType>({
|
|
|
488
444
|
dataParser
|
|
489
445
|
}: QueryBoundaryWrapperProps<DataType>): import("react/jsx-runtime").JSX.Element;
|
|
490
446
|
//#endregion
|
|
491
|
-
//#region src/components/ReactPlayground.d.ts
|
|
492
|
-
interface ReactPlaygroundProps extends ComponentProps<typeof LiveProvider> {
|
|
493
|
-
/** Extra styling to apply to the preview. Must be compatible with the Material UI `sx` prop. */
|
|
494
|
-
previewStyles?: SxProps<Theme>;
|
|
495
|
-
}
|
|
496
|
-
/** Renders a playground to help demonstrate your React code in an interactive setting. */
|
|
497
|
-
declare function ReactPlayground({
|
|
498
|
-
code,
|
|
499
|
-
previewStyles,
|
|
500
|
-
...liveProviderProps
|
|
501
|
-
}: ReactPlaygroundProps): import("react/jsx-runtime").JSX.Element;
|
|
502
|
-
//#endregion
|
|
503
447
|
//#region src/components/SkeletonRow.d.ts
|
|
504
448
|
interface SkeletonRowProps {
|
|
505
449
|
/** The number of columns the SkeletonRow should display. */
|
|
@@ -534,6 +478,10 @@ declare function SwitchWithIcons({
|
|
|
534
478
|
...switchProps
|
|
535
479
|
}: SwitchWithIconsProps): import("react/jsx-runtime").JSX.Element;
|
|
536
480
|
//#endregion
|
|
481
|
+
//#region src/components/ThemeToggle.d.ts
|
|
482
|
+
/** A toggle to switch between dark mode and light mode. Must be used in a `ThemeProvider`. */
|
|
483
|
+
declare function ThemeToggle(): import("react/jsx-runtime").JSX.Element;
|
|
484
|
+
//#endregion
|
|
537
485
|
//#region src/deprecated/DropdownMenu.d.ts
|
|
538
486
|
interface DropdownMenuProps {
|
|
539
487
|
children: ReactNode | ((closeMenu: () => void) => ReactNode);
|
|
@@ -559,9 +507,49 @@ declare function DropdownMenu({
|
|
|
559
507
|
onClose
|
|
560
508
|
}: DropdownMenuProps): import("react/jsx-runtime").JSX.Element;
|
|
561
509
|
//#endregion
|
|
510
|
+
//#region src/deprecated/createQueryBoundary.d.ts
|
|
511
|
+
interface QueryBase$1 {
|
|
512
|
+
/** The current loading status (true if loading, false if not) */
|
|
513
|
+
isLoading?: boolean;
|
|
514
|
+
/** The error given if the response gave an error. */
|
|
515
|
+
error?: unknown;
|
|
516
|
+
}
|
|
517
|
+
interface QuerySingle<DataType> extends QueryBase$1 {
|
|
518
|
+
/** The data being loaded. */
|
|
519
|
+
data: DataType | null | undefined;
|
|
520
|
+
dataCollection?: never;
|
|
521
|
+
}
|
|
522
|
+
interface QueryMultiple<ItemType> extends QueryBase$1 {
|
|
523
|
+
/** An array of data items being loaded. */
|
|
524
|
+
dataCollection: Array<ItemType> | null | undefined;
|
|
525
|
+
data?: never;
|
|
526
|
+
}
|
|
527
|
+
type Query<DataType> = QuerySingle<DataType> | QueryMultiple<DataType>;
|
|
528
|
+
interface CreateQueryBoundaryParameters<DataType> {
|
|
529
|
+
query: Query<DataType>;
|
|
530
|
+
}
|
|
531
|
+
interface DefaultQueryBoundaryComponents<DataType> {
|
|
532
|
+
Context: (props: {
|
|
533
|
+
children: ReactNode;
|
|
534
|
+
}) => JSX.Element;
|
|
535
|
+
Error: typeof QueryBoundaryError;
|
|
536
|
+
Data: typeof QueryBoundaryData<DataType>;
|
|
537
|
+
DataMap: typeof QueryBoundaryDataMap<DataType>;
|
|
538
|
+
Fallback: typeof QueryBoundaryFallback;
|
|
539
|
+
Nullable: typeof QueryBoundaryNullable;
|
|
540
|
+
}
|
|
541
|
+
/**
|
|
542
|
+
* A creator function to create a system of QueryBoundary components with the data fully typed throughout.
|
|
543
|
+
*
|
|
544
|
+
* @deprecated Please use either `createBaseQueryBoundary`, `createItemQueryBoundary`, or `createListQueryBoundary` from `@alextheman/components/v7` instead.
|
|
545
|
+
*/
|
|
546
|
+
declare function createQueryBoundary<DataType>({
|
|
547
|
+
query
|
|
548
|
+
}: CreateQueryBoundaryParameters<DataType>): DefaultQueryBoundaryComponents<DataType>;
|
|
549
|
+
//#endregion
|
|
562
550
|
//#region src/deprecated/DarkModeToggle.d.ts
|
|
563
|
-
/** @deprecated This component has been renamed to `
|
|
564
|
-
declare const DarkModeToggle: typeof
|
|
551
|
+
/** @deprecated This component has been renamed to `ThemeToggle`. */
|
|
552
|
+
declare const DarkModeToggle: typeof ThemeToggle;
|
|
565
553
|
//#endregion
|
|
566
554
|
//#region src/v7/components/DropdownMenu/DropdownMenu.d.ts
|
|
567
555
|
interface DropdownMenuProps$1 extends Omit<MenuProps, "anchorEl" | "open"> {
|
|
@@ -779,6 +767,118 @@ type LoaderProviderProps<DataType> = QueryBoundaryProviderProps<DataType>;
|
|
|
779
767
|
/** @deprecated This component has been renamed to QueryBoundaryProvider */
|
|
780
768
|
declare const LoaderProvider: typeof QueryBoundaryProvider;
|
|
781
769
|
//#endregion
|
|
770
|
+
//#region src/providers/AudioProvider/index.d.ts
|
|
771
|
+
interface TrackData {
|
|
772
|
+
title: string;
|
|
773
|
+
src: string;
|
|
774
|
+
artist: string;
|
|
775
|
+
}
|
|
776
|
+
interface AudioContextValue {
|
|
777
|
+
tracks: Array<TrackData>;
|
|
778
|
+
currentTrack: TrackData | null;
|
|
779
|
+
setCurrentTrack: Dispatch<SetStateAction<TrackData | null>>;
|
|
780
|
+
}
|
|
781
|
+
interface AudioProviderProps {
|
|
782
|
+
tracks: Array<TrackData>;
|
|
783
|
+
children: ReactNode;
|
|
784
|
+
}
|
|
785
|
+
/** Allows access to the audio information provided by AudioProvider. Will fail if AudioProvider could not be accessed and strict mode is true. */
|
|
786
|
+
declare function useAudioContext<Strict extends boolean = true>({
|
|
787
|
+
strict
|
|
788
|
+
}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, AudioContextValue>;
|
|
789
|
+
/** Provides audio information to the children components. */
|
|
790
|
+
declare function AudioProvider({
|
|
791
|
+
tracks,
|
|
792
|
+
children
|
|
793
|
+
}: AudioProviderProps): import("react/jsx-runtime").JSX.Element;
|
|
794
|
+
//#endregion
|
|
795
|
+
//#region src/providers/AudioProvider/AudioControls.d.ts
|
|
796
|
+
/** Controls the tracks provided by the AudioProvider. */
|
|
797
|
+
declare function AudioControls(): import("react/jsx-runtime").JSX.Element;
|
|
798
|
+
//#endregion
|
|
799
|
+
//#region src/providers/ScreenSizeProvider.d.ts
|
|
800
|
+
interface ScreenSizeProps {
|
|
801
|
+
/** The children that will be receiving the ScreenSizeContext. */
|
|
802
|
+
children: ReactNode;
|
|
803
|
+
/** The minimum screen width in pixels required to be considered a large screen. */
|
|
804
|
+
largeScreenWidth?: number;
|
|
805
|
+
/** The minimum screen height in pixels required to be considered a large screen. */
|
|
806
|
+
largeScreenHeight?: number;
|
|
807
|
+
}
|
|
808
|
+
interface ScreenDimensions {
|
|
809
|
+
/** The current window width. */
|
|
810
|
+
windowWidth: number;
|
|
811
|
+
/** The current window height. */
|
|
812
|
+
windowHeight: number;
|
|
813
|
+
}
|
|
814
|
+
interface ScreenSizeContextValue extends ScreenDimensions {
|
|
815
|
+
/** Whether the screen is a large screen or not. */
|
|
816
|
+
isLargeScreen: boolean;
|
|
817
|
+
}
|
|
818
|
+
/** Access the screen size context directly. */
|
|
819
|
+
declare function useScreenSize<Strict extends boolean = true>({
|
|
820
|
+
strict
|
|
821
|
+
}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, ScreenSizeContextValue>;
|
|
822
|
+
/** Provides context about the current screen size. */
|
|
823
|
+
declare function ScreenSizeProvider({
|
|
824
|
+
children,
|
|
825
|
+
largeScreenWidth,
|
|
826
|
+
largeScreenHeight
|
|
827
|
+
}: ScreenSizeProps): import("react/jsx-runtime").JSX.Element;
|
|
828
|
+
//#endregion
|
|
829
|
+
//#region src/providers/SnackbarProvider.d.ts
|
|
830
|
+
interface SnackbarProviderProps {
|
|
831
|
+
/** The children that will have access to the snackbar context. */
|
|
832
|
+
children: ReactNode;
|
|
833
|
+
/** The amount of seconds to wait before hiding the snackbar. */
|
|
834
|
+
autoHideDuration?: number;
|
|
835
|
+
}
|
|
836
|
+
interface SnackbarContextValue {
|
|
837
|
+
/** A function that adds the snackbar to the page. */
|
|
838
|
+
addSnackbar: (message: string, severity?: AlertColor, duration?: number) => void;
|
|
839
|
+
}
|
|
840
|
+
/** Access the snackbar context directly. */
|
|
841
|
+
declare function useSnackbar<Strict extends boolean = true>({
|
|
842
|
+
strict
|
|
843
|
+
}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, SnackbarContextValue>;
|
|
844
|
+
/** Controls the display of the snackbars on the page. */
|
|
845
|
+
declare function SnackbarProvider({
|
|
846
|
+
children,
|
|
847
|
+
autoHideDuration
|
|
848
|
+
}: SnackbarProviderProps): import("react/jsx-runtime").JSX.Element;
|
|
849
|
+
//#endregion
|
|
850
|
+
//#region src/providers/ThemeProvider.d.ts
|
|
851
|
+
interface ThemeContextValue {
|
|
852
|
+
toggleMode: () => void;
|
|
853
|
+
mode: PaletteMode;
|
|
854
|
+
}
|
|
855
|
+
/** Access the mode context directly. */
|
|
856
|
+
declare function useTheme<Strict extends boolean = true>({
|
|
857
|
+
strict
|
|
858
|
+
}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, ThemeContextValue>;
|
|
859
|
+
interface ThemeProviderProps {
|
|
860
|
+
/** The children that will have access to the current mode. */
|
|
861
|
+
children: ReactNode;
|
|
862
|
+
/** The initial mode. */
|
|
863
|
+
mode?: PaletteMode;
|
|
864
|
+
/** Extra options to apply on top of our default theme options */
|
|
865
|
+
themeOptions?: ThemeOptions;
|
|
866
|
+
}
|
|
867
|
+
/** Provides information about the current theme mode to its children components. */
|
|
868
|
+
declare function ThemeProvider({
|
|
869
|
+
children,
|
|
870
|
+
mode: modeProp,
|
|
871
|
+
themeOptions
|
|
872
|
+
}: ThemeProviderProps): import("react/jsx-runtime").JSX.Element;
|
|
873
|
+
//#endregion
|
|
874
|
+
//#region src/deprecated/ModeProvider.d.ts
|
|
875
|
+
/** @deprecated This component has been renamed to `ThemeProvider`. */
|
|
876
|
+
declare const ModeProvider: typeof ThemeProvider;
|
|
877
|
+
//#endregion
|
|
878
|
+
//#region src/deprecated/ModeToggle.d.ts
|
|
879
|
+
/** @deprecated This component has been renamed to `ThemeToggle` */
|
|
880
|
+
declare const ModeToggle: typeof ThemeToggle;
|
|
881
|
+
//#endregion
|
|
782
882
|
//#region src/deprecated/NavigationBottom.d.ts
|
|
783
883
|
interface NavItemBottom {
|
|
784
884
|
/** The value associated with the nav item. */
|
|
@@ -862,6 +962,23 @@ type QueryBoundaryProps<DataType> = QueryBoundaryWrapperProps<DataType>;
|
|
|
862
962
|
/** @deprecated This component has been renamed to `QueryBoundaryWrapper` */
|
|
863
963
|
declare const QueryBoundary: typeof QueryBoundaryWrapper;
|
|
864
964
|
//#endregion
|
|
965
|
+
//#region src/deprecated/ReactPlayground.d.ts
|
|
966
|
+
/** @deprecated This type is no longer being maintained. Please use the type of the components from `react-live` directly. */
|
|
967
|
+
interface ReactPlaygroundProps extends ComponentProps<typeof LiveProvider> {
|
|
968
|
+
/** Extra styling to apply to the preview. Must be compatible with the Material UI `sx` prop. */
|
|
969
|
+
previewStyles?: SxProps<Theme>;
|
|
970
|
+
}
|
|
971
|
+
/**
|
|
972
|
+
* Renders a playground to help demonstrate your React code in an interactive setting.
|
|
973
|
+
*
|
|
974
|
+
* @deprecated This component is no longer being maintained. Please use the components from `react-live` directly.
|
|
975
|
+
*/
|
|
976
|
+
declare function ReactPlayground({
|
|
977
|
+
code,
|
|
978
|
+
previewStyles,
|
|
979
|
+
...liveProviderProps
|
|
980
|
+
}: ReactPlaygroundProps): import("react/jsx-runtime").JSX.Element;
|
|
981
|
+
//#endregion
|
|
865
982
|
//#region src/deprecated/SubmitButton.d.ts
|
|
866
983
|
interface SubmitButtonProps extends Omit<ButtonProps, "type"> {
|
|
867
984
|
/** An option to disable the button on submit if the form is not dirty. */
|
|
@@ -905,104 +1022,5 @@ declare function useDebounce<ValueType>(value: ValueType, delay?: number): Value
|
|
|
905
1022
|
*/
|
|
906
1023
|
declare function useHash<StateType extends string>(initialHash: StateType | undefined): [StateType, Dispatch<SetStateAction<StateType>>];
|
|
907
1024
|
//#endregion
|
|
908
|
-
|
|
909
|
-
interface TrackData {
|
|
910
|
-
title: string;
|
|
911
|
-
src: string;
|
|
912
|
-
artist: string;
|
|
913
|
-
}
|
|
914
|
-
interface AudioContextValue {
|
|
915
|
-
tracks: Array<TrackData>;
|
|
916
|
-
currentTrack: TrackData;
|
|
917
|
-
setCurrentTrack: Dispatch<SetStateAction<TrackData>>;
|
|
918
|
-
}
|
|
919
|
-
interface AudioProviderProps {
|
|
920
|
-
tracks: Array<TrackData>;
|
|
921
|
-
children: ReactNode;
|
|
922
|
-
}
|
|
923
|
-
/** Allows access to the audio information provided by AudioProvider. Will fail if AudioProvider could not be accessed and strict mode is true. */
|
|
924
|
-
declare function useAudioContext<Strict extends boolean = true>({
|
|
925
|
-
strict
|
|
926
|
-
}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, AudioContextValue>;
|
|
927
|
-
/** Provides audio information to the children components. */
|
|
928
|
-
declare function AudioProvider({
|
|
929
|
-
tracks,
|
|
930
|
-
children
|
|
931
|
-
}: AudioProviderProps): import("react/jsx-runtime").JSX.Element;
|
|
932
|
-
//#endregion
|
|
933
|
-
//#region src/providers/AudioProvider/AudioControls.d.ts
|
|
934
|
-
/** Controls the tracks provided by the AudioProvider. */
|
|
935
|
-
declare function AudioControls(): import("react/jsx-runtime").JSX.Element;
|
|
936
|
-
//#endregion
|
|
937
|
-
//#region src/providers/ModeProvider.d.ts
|
|
938
|
-
interface ModeContextValue {
|
|
939
|
-
toggleMode: () => void;
|
|
940
|
-
mode: PaletteMode;
|
|
941
|
-
}
|
|
942
|
-
/** Access the mode context directly. */
|
|
943
|
-
declare function useMode<Strict extends boolean = true>({
|
|
944
|
-
strict
|
|
945
|
-
}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, ModeContextValue>;
|
|
946
|
-
interface ModeProviderProps {
|
|
947
|
-
/** The children that will have access to the current mode. */
|
|
948
|
-
children: ReactNode;
|
|
949
|
-
/** The initial mode. */
|
|
950
|
-
mode?: PaletteMode;
|
|
951
|
-
}
|
|
952
|
-
/** Provides information about the current theme mode to its children components. */
|
|
953
|
-
declare function ModeProvider({
|
|
954
|
-
children,
|
|
955
|
-
mode: modeProp
|
|
956
|
-
}: ModeProviderProps): import("react/jsx-runtime").JSX.Element;
|
|
957
|
-
//#endregion
|
|
958
|
-
//#region src/providers/ScreenSizeProvider.d.ts
|
|
959
|
-
interface ScreenSizeProps {
|
|
960
|
-
/** The children that will be receiving the ScreenSizeContext. */
|
|
961
|
-
children: ReactNode;
|
|
962
|
-
/** The minimum screen width in pixels required to be considered a large screen. */
|
|
963
|
-
largeScreenWidth?: number;
|
|
964
|
-
/** The minimum screen height in pixels required to be considered a large screen. */
|
|
965
|
-
largeScreenHeight?: number;
|
|
966
|
-
}
|
|
967
|
-
interface ScreenSizeContextValue {
|
|
968
|
-
/** Whether the screen is a large screen or not. */
|
|
969
|
-
isLargeScreen: boolean;
|
|
970
|
-
/** The current window width. */
|
|
971
|
-
windowWidth: number;
|
|
972
|
-
/** The current window height. */
|
|
973
|
-
windowHeight: number;
|
|
974
|
-
}
|
|
975
|
-
/** Access the screen size context directly. */
|
|
976
|
-
declare function useScreenSize<Strict extends boolean = true>({
|
|
977
|
-
strict
|
|
978
|
-
}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, ScreenSizeContextValue>;
|
|
979
|
-
/** Provides context about the current screen size. */
|
|
980
|
-
declare function ScreenSizeProvider({
|
|
981
|
-
children,
|
|
982
|
-
largeScreenWidth,
|
|
983
|
-
largeScreenHeight
|
|
984
|
-
}: ScreenSizeProps): import("react/jsx-runtime").JSX.Element;
|
|
985
|
-
//#endregion
|
|
986
|
-
//#region src/providers/SnackbarProvider.d.ts
|
|
987
|
-
interface SnackbarProviderProps {
|
|
988
|
-
/** The children that will have access to the snackbar context. */
|
|
989
|
-
children: ReactNode;
|
|
990
|
-
/** The amount of seconds to wait before hiding the snackbar. */
|
|
991
|
-
autoHideDuration?: number;
|
|
992
|
-
}
|
|
993
|
-
interface SnackbarContextValue {
|
|
994
|
-
/** A function that adds the snackbar to the page. */
|
|
995
|
-
addSnackbar: (message: string, severity?: AlertColor, duration?: number) => void;
|
|
996
|
-
}
|
|
997
|
-
/** Access the snackbar context directly. */
|
|
998
|
-
declare function useSnackbar<Strict extends boolean = true>({
|
|
999
|
-
strict
|
|
1000
|
-
}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, SnackbarContextValue>;
|
|
1001
|
-
/** Controls the display of the snackbars on the page. */
|
|
1002
|
-
declare function SnackbarProvider({
|
|
1003
|
-
children,
|
|
1004
|
-
autoHideDuration
|
|
1005
|
-
}: SnackbarProviderProps): import("react/jsx-runtime").JSX.Element;
|
|
1006
|
-
//#endregion
|
|
1007
|
-
export { Artwork, type AudioContextValue, AudioControls, AudioProvider, type AudioProviderProps, CollapsableItem, type CollapsableItemProps, type ContextHookOptions, type CreateBaseQueryBoundaryParameters, type CreateItemQueryBoundaryParameters, type CreateListQueryBoundaryParameters, type CreateQueryBoundaryParameters, DarkModeToggle, type DefaultQueryBoundaryComponents, type DefaultQueryBoundaryComponentsBase, type DefaultQueryBoundaryItemComponents, type DefaultQueryBoundaryListComponents, DropdownMenu, DropdownMenu2, type DropdownMenu2Props, DropdownMenuExternalLink, DropdownMenuInternalLink, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, ExternalLink, type ExternalLinkProps, FileInput, FileInputList, type FileInputListProps, type FileInputProps, FileType, IconWithPopover, type IconWithPopoverProps, InternalLink, type InternalLinkProps, ListItemInternalLink, Loader, type LoaderContextValue, LoaderData, type LoaderDataProps, LoaderError, type LoaderErrorBaseProps, type LoaderErrorProps, type LoaderErrorPropsWithNullable, type LoaderErrorPropsWithUndefinedOrNull, LoaderProvider, type LoaderProviderBaseProps, type LoaderProviderProps, type LoaderProviderPropsWithError, type LoaderProviderPropsWithNoError, ModeProvider, type ModeProviderProps, ModeToggle, type NavItemBottom, type NavMenuItem, NavigationBottom, type NavigationBottomProps, NavigationDrawer, type NavigationDrawerProps, Page, PopoverText, type PopoverTextProps, type QueryBase, QueryBoundary, QueryBoundaryData, QueryBoundaryDataMap, type QueryBoundaryDataMapBaseProps, type QueryBoundaryDataMapProps, type QueryBoundaryDataMapPropsWithDataParser, type QueryBoundaryDataMapPropsWithItemParser, type QueryBoundaryDataMapPropsWithNoParser, type QueryBoundaryDataProps, QueryBoundaryError, type QueryBoundaryErrorProps, QueryBoundaryFallback, type QueryBoundaryFallbackProps, QueryBoundaryMap, type QueryBoundaryMapProps, QueryBoundaryNullable, type QueryBoundaryNullableProps, type QueryBoundaryNullablePropsWithNullable, type QueryBoundaryNullablePropsWithUndefinedOrNull, type QueryBoundaryProps, QueryBoundaryProvider, type QueryBoundaryProviderBaseProps, type QueryBoundaryProviderProps, type QueryBoundaryProviderPropsWithError, type QueryBoundaryProviderPropsWithNoError, QueryBoundaryWrapper, type QueryBoundaryWrapperProps, type QueryItem, type QueryList, type QueryMultiple, type QuerySingle, ReactPlayground, type ReactPlaygroundProps, type ScreenSizeContextValue, type ScreenSizeProps, ScreenSizeProvider, SkeletonRow, type SkeletonRowProps, SnackbarProvider, type SnackbarProviderProps, SubmitButton, type SubmitButtonProps, SwitchWithIcons, type SwitchWithIconsProps, type TrackData, createBaseQueryBoundary, createItemQueryBoundary, createListQueryBoundary, createQueryBoundary, useAudioContext, useDebounce, useDropdownMenu, useHash, useMode, useQueryBoundary, useScreenSize, useSnackbar };
|
|
1025
|
+
export { Artwork, type AudioContextValue, AudioControls, AudioProvider, type AudioProviderProps, CollapsableItem, type CollapsableItemProps, type ContextHookOptions, type CreateBaseQueryBoundaryParameters, type CreateItemQueryBoundaryParameters, type CreateListQueryBoundaryParameters, DarkModeToggle, type DefaultQueryBoundaryComponentsBase, type DefaultQueryBoundaryItemComponents, type DefaultQueryBoundaryListComponents, DropdownMenu, DropdownMenu2, type DropdownMenu2Props, DropdownMenuExternalLink, DropdownMenuInternalLink, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, ExternalLink, type ExternalLinkProps, FileInput, FileInputList, type FileInputListProps, type FileInputProps, FileType, IconWithPopover, type IconWithPopoverProps, InternalLink, type InternalLinkProps, ListItemInternalLink, Loader, type LoaderContextValue, LoaderData, type LoaderDataProps, LoaderError, type LoaderErrorBaseProps, type LoaderErrorProps, type LoaderErrorPropsWithNullable, type LoaderErrorPropsWithUndefinedOrNull, LoaderProvider, type LoaderProviderBaseProps, type LoaderProviderProps, type LoaderProviderPropsWithError, type LoaderProviderPropsWithNoError, ModeProvider, ModeToggle, type NavItemBottom, type NavMenuItem, NavigationBottom, type NavigationBottomProps, NavigationDrawer, type NavigationDrawerProps, Page, PopoverText, type PopoverTextProps, type QueryBase, QueryBoundary, QueryBoundaryData, QueryBoundaryDataMap, type QueryBoundaryDataMapBaseProps, type QueryBoundaryDataMapProps, type QueryBoundaryDataMapPropsWithDataParser, type QueryBoundaryDataMapPropsWithItemParser, type QueryBoundaryDataMapPropsWithNoParser, type QueryBoundaryDataProps, QueryBoundaryError, type QueryBoundaryErrorProps, QueryBoundaryFallback, type QueryBoundaryFallbackProps, QueryBoundaryMap, type QueryBoundaryMapProps, QueryBoundaryNullable, type QueryBoundaryNullableProps, type QueryBoundaryNullablePropsWithNullable, type QueryBoundaryNullablePropsWithUndefinedOrNull, type QueryBoundaryProps, QueryBoundaryProvider, type QueryBoundaryProviderBaseProps, type QueryBoundaryProviderProps, type QueryBoundaryProviderPropsWithError, type QueryBoundaryProviderPropsWithNoError, QueryBoundaryWrapper, type QueryBoundaryWrapperProps, type QueryItem, type QueryList, ReactPlayground, type ReactPlaygroundProps, type ScreenDimensions, type ScreenSizeContextValue, type ScreenSizeProps, ScreenSizeProvider, SkeletonRow, type SkeletonRowProps, SnackbarProvider, type SnackbarProviderProps, SubmitButton, type SubmitButtonProps, SwitchWithIcons, type SwitchWithIconsProps, type ThemeContextValue, ThemeProvider, type ThemeProviderProps, ThemeToggle, type TrackData, createBaseQueryBoundary, createItemQueryBoundary, createListQueryBoundary, createQueryBoundary, useAudioContext, useDebounce, useDropdownMenu, useHash, useQueryBoundary, useScreenSize, useSnackbar, useTheme };
|
|
1008
1026
|
//# sourceMappingURL=index.d.cts.map
|