@adminlte/react 0.1.0 → 0.4.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/CHANGELOG.md +34 -3
- package/README.md +30 -27
- package/dist/css/adminlte.css +1450 -2791
- package/dist/index.d.ts +78 -79
- package/package.json +28 -27
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import * as
|
|
2
|
-
import
|
|
3
|
-
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
1
|
+
import * as react from 'react';
|
|
2
|
+
import react__default, { AnchorHTMLAttributes, ReactNode, Key } from 'react';
|
|
4
3
|
import { ApexOptions } from 'apexcharts';
|
|
5
4
|
|
|
6
5
|
/**
|
|
@@ -70,7 +69,7 @@ type LinkComponent = (props: LinkProps) => ReactNode;
|
|
|
70
69
|
declare function LinkProvider({ component, children, }: {
|
|
71
70
|
component?: LinkComponent;
|
|
72
71
|
children: ReactNode;
|
|
73
|
-
}):
|
|
72
|
+
}): react.JSX.Element;
|
|
74
73
|
/** The active Link component — consumer-injected router link, or a plain `<a>` fallback. */
|
|
75
74
|
declare function useLinkComponent(): LinkComponent;
|
|
76
75
|
|
|
@@ -88,7 +87,7 @@ interface TopbarUser {
|
|
|
88
87
|
*/
|
|
89
88
|
interface DashboardLayoutProps {
|
|
90
89
|
menuItems: MenuNode[];
|
|
91
|
-
logo?:
|
|
90
|
+
logo?: react__default.ReactNode;
|
|
92
91
|
logoHref?: string;
|
|
93
92
|
user?: TopbarUser;
|
|
94
93
|
sidebarTheme?: 'light' | 'dark';
|
|
@@ -104,9 +103,9 @@ interface DashboardLayoutProps {
|
|
|
104
103
|
enableSidebarPersistence?: boolean;
|
|
105
104
|
navbarClass?: string;
|
|
106
105
|
bodyClass?: string;
|
|
107
|
-
topbarStart?:
|
|
108
|
-
topbarEnd?:
|
|
109
|
-
footer?:
|
|
106
|
+
topbarStart?: react__default.ReactNode;
|
|
107
|
+
topbarEnd?: react__default.ReactNode;
|
|
108
|
+
footer?: react__default.ReactNode;
|
|
110
109
|
/**
|
|
111
110
|
* Router link to use for sidebar navigation (e.g. an adapter around `next/link`).
|
|
112
111
|
* Enables client-side navigation; defaults to a plain `<a>` (full-page navigation).
|
|
@@ -116,29 +115,29 @@ interface DashboardLayoutProps {
|
|
|
116
115
|
docsHref?: string;
|
|
117
116
|
/** Label for the sidebar footer link (default "View documentation"). */
|
|
118
117
|
docsLabel?: string;
|
|
119
|
-
children:
|
|
118
|
+
children: react__default.ReactNode;
|
|
120
119
|
}
|
|
121
120
|
/**
|
|
122
121
|
* Props for the AuthLayout component (login/register).
|
|
123
122
|
*/
|
|
124
123
|
interface AuthLayoutProps {
|
|
125
124
|
authType?: 'login' | 'register';
|
|
126
|
-
logo?:
|
|
125
|
+
logo?: react__default.ReactNode;
|
|
127
126
|
logoHref?: string;
|
|
128
|
-
children:
|
|
127
|
+
children: react__default.ReactNode;
|
|
129
128
|
}
|
|
130
129
|
/**
|
|
131
130
|
* Props for the AppContent wrapper component.
|
|
132
131
|
*/
|
|
133
132
|
interface AppContentProps {
|
|
134
|
-
header?:
|
|
133
|
+
header?: react__default.ReactNode;
|
|
135
134
|
breadcrumbs?: Array<{
|
|
136
135
|
label: string;
|
|
137
136
|
href?: string;
|
|
138
137
|
}>;
|
|
139
138
|
title?: string;
|
|
140
139
|
fluid?: boolean;
|
|
141
|
-
children:
|
|
140
|
+
children: react__default.ReactNode;
|
|
142
141
|
}
|
|
143
142
|
|
|
144
143
|
interface DirectChatContact {
|
|
@@ -168,9 +167,9 @@ interface SidebarProviderProps {
|
|
|
168
167
|
sidebarMini?: boolean;
|
|
169
168
|
enablePersistence?: boolean;
|
|
170
169
|
sidebarBreakpoint?: number;
|
|
171
|
-
children:
|
|
170
|
+
children: react__default.ReactNode;
|
|
172
171
|
}
|
|
173
|
-
declare function SidebarProvider({ sidebarMini, enablePersistence, sidebarBreakpoint, children, }: SidebarProviderProps):
|
|
172
|
+
declare function SidebarProvider({ sidebarMini, enablePersistence, sidebarBreakpoint, children, }: SidebarProviderProps): react__default.JSX.Element;
|
|
174
173
|
declare function useSidebarContext(): SidebarContextValue;
|
|
175
174
|
|
|
176
175
|
interface ColorModeContextValue {
|
|
@@ -180,9 +179,9 @@ interface ColorModeContextValue {
|
|
|
180
179
|
}
|
|
181
180
|
interface ColorModeProviderProps {
|
|
182
181
|
initialMode?: ColorMode;
|
|
183
|
-
children:
|
|
182
|
+
children: react__default.ReactNode;
|
|
184
183
|
}
|
|
185
|
-
declare function ColorModeProvider({ initialMode, children, }: ColorModeProviderProps):
|
|
184
|
+
declare function ColorModeProvider({ initialMode, children, }: ColorModeProviderProps): react__default.JSX.Element;
|
|
186
185
|
declare function useColorModeContext(): ColorModeContextValue;
|
|
187
186
|
|
|
188
187
|
interface CommandPaletteContextValue {
|
|
@@ -192,8 +191,8 @@ interface CommandPaletteContextValue {
|
|
|
192
191
|
toggle: () => void;
|
|
193
192
|
}
|
|
194
193
|
declare function CommandPaletteProvider({ children }: {
|
|
195
|
-
children:
|
|
196
|
-
}):
|
|
194
|
+
children: react__default.ReactNode;
|
|
195
|
+
}): react__default.JSX.Element;
|
|
197
196
|
/**
|
|
198
197
|
* Returns the command-palette controls, or `undefined` if rendered outside a
|
|
199
198
|
* CommandPaletteProvider (so the topbar search button degrades gracefully).
|
|
@@ -204,16 +203,16 @@ declare function useCommandPalette(): CommandPaletteContextValue | undefined;
|
|
|
204
203
|
* Main dashboard layout component (RSC outer shell).
|
|
205
204
|
* Computes static body classes server-side, nests client providers inside.
|
|
206
205
|
*/
|
|
207
|
-
declare function DashboardLayout({ menuItems, logo, logoHref, user, sidebarTheme, sidebarClass, sidebarBreakpoint, sidebarMini, fixedHeader, fixedSidebar, fixedFooter, colorModeToggle, initialColorMode, dir, enableSidebarPersistence, navbarClass, bodyClass, topbarStart, topbarEnd, footer, linkComponent, docsHref, docsLabel, children, }: DashboardLayoutProps):
|
|
206
|
+
declare function DashboardLayout({ menuItems, logo, logoHref, user, sidebarTheme, sidebarClass, sidebarBreakpoint, sidebarMini, fixedHeader, fixedSidebar, fixedFooter, colorModeToggle, initialColorMode, dir, enableSidebarPersistence, navbarClass, bodyClass, topbarStart, topbarEnd, footer, linkComponent, docsHref, docsLabel, children, }: DashboardLayoutProps): react.JSX.Element;
|
|
208
207
|
|
|
209
208
|
/**
|
|
210
209
|
* Standalone auth page layout (login/register/lockscreen).
|
|
211
210
|
* Applies the `<authType>-page` classes to <body> via effect so it works
|
|
212
211
|
* under a Next.js App Router root layout that already owns <html>/<body>.
|
|
213
212
|
*/
|
|
214
|
-
declare function AuthLayout({ authType, logo, logoHref, children, }: AuthLayoutProps):
|
|
213
|
+
declare function AuthLayout({ authType, logo, logoHref, children, }: AuthLayoutProps): react.JSX.Element;
|
|
215
214
|
|
|
216
|
-
declare function AppContent({ breadcrumbs, title, fluid, children, }: AppContentProps):
|
|
215
|
+
declare function AppContent({ breadcrumbs, title, fluid, children, }: AppContentProps): react.JSX.Element;
|
|
217
216
|
|
|
218
217
|
interface TopbarProps {
|
|
219
218
|
start?: React.ReactNode;
|
|
@@ -224,7 +223,7 @@ interface TopbarProps {
|
|
|
224
223
|
user?: TopbarUser;
|
|
225
224
|
navbarClass?: string;
|
|
226
225
|
}
|
|
227
|
-
declare function Topbar({ start, end, colorModeToggle, search, fullscreen, user, navbarClass, }: TopbarProps):
|
|
226
|
+
declare function Topbar({ start, end, colorModeToggle, search, fullscreen, user, navbarClass, }: TopbarProps): react.JSX.Element;
|
|
228
227
|
|
|
229
228
|
interface SidebarProps {
|
|
230
229
|
items: MenuNode[];
|
|
@@ -235,13 +234,13 @@ interface SidebarProps {
|
|
|
235
234
|
docsHref?: string;
|
|
236
235
|
docsLabel?: string;
|
|
237
236
|
}
|
|
238
|
-
declare function Sidebar({ items, logo, logoHref, theme, sidebarClass, docsHref, docsLabel, }: SidebarProps):
|
|
237
|
+
declare function Sidebar({ items, logo, logoHref, theme, sidebarClass, docsHref, docsLabel, }: SidebarProps): react.JSX.Element;
|
|
239
238
|
|
|
240
239
|
interface SidebarBrandProps {
|
|
241
240
|
logo?: React.ReactNode;
|
|
242
241
|
href?: string;
|
|
243
242
|
}
|
|
244
|
-
declare function SidebarBrand({ logo, href }: SidebarBrandProps):
|
|
243
|
+
declare function SidebarBrand({ logo, href }: SidebarBrandProps): react.JSX.Element;
|
|
245
244
|
|
|
246
245
|
interface SidebarNavProps {
|
|
247
246
|
items: MenuNode[];
|
|
@@ -249,23 +248,23 @@ interface SidebarNavProps {
|
|
|
249
248
|
docsHref?: string;
|
|
250
249
|
docsLabel?: string;
|
|
251
250
|
}
|
|
252
|
-
declare function SidebarNav({ items, docsHref, docsLabel }: SidebarNavProps):
|
|
251
|
+
declare function SidebarNav({ items, docsHref, docsLabel }: SidebarNavProps): react.JSX.Element;
|
|
253
252
|
|
|
254
253
|
interface SidebarNavItemProps {
|
|
255
254
|
item: MenuNode;
|
|
256
255
|
currentPath: string;
|
|
257
256
|
depth?: number;
|
|
258
257
|
}
|
|
259
|
-
declare function SidebarNavItem({ item, currentPath, depth }: SidebarNavItemProps):
|
|
258
|
+
declare function SidebarNavItem({ item, currentPath, depth }: SidebarNavItemProps): react.JSX.Element;
|
|
260
259
|
|
|
261
|
-
declare function SidebarOverlay():
|
|
260
|
+
declare function SidebarOverlay(): react.JSX.Element;
|
|
262
261
|
|
|
263
262
|
interface FooterProps {
|
|
264
263
|
children?: React.ReactNode;
|
|
265
264
|
}
|
|
266
|
-
declare function Footer({ children }: FooterProps):
|
|
265
|
+
declare function Footer({ children }: FooterProps): react.JSX.Element;
|
|
267
266
|
|
|
268
|
-
declare function ColorModeToggle():
|
|
267
|
+
declare function ColorModeToggle(): react.JSX.Element;
|
|
269
268
|
|
|
270
269
|
interface SmallBoxProps {
|
|
271
270
|
title: React.ReactNode;
|
|
@@ -275,7 +274,7 @@ interface SmallBoxProps {
|
|
|
275
274
|
url?: string;
|
|
276
275
|
urlText?: string;
|
|
277
276
|
}
|
|
278
|
-
declare function SmallBox({ title, text, icon, theme, url, urlText, }: SmallBoxProps):
|
|
277
|
+
declare function SmallBox({ title, text, icon, theme, url, urlText, }: SmallBoxProps): react.JSX.Element;
|
|
279
278
|
|
|
280
279
|
interface InfoBoxProps {
|
|
281
280
|
title?: string;
|
|
@@ -285,7 +284,7 @@ interface InfoBoxProps {
|
|
|
285
284
|
progress?: number;
|
|
286
285
|
progressText?: string;
|
|
287
286
|
}
|
|
288
|
-
declare function InfoBox({ title, text, icon, theme, progress, progressText, }: InfoBoxProps):
|
|
287
|
+
declare function InfoBox({ title, text, icon, theme, progress, progressText, }: InfoBoxProps): react.JSX.Element;
|
|
289
288
|
|
|
290
289
|
interface CardProps {
|
|
291
290
|
title?: string;
|
|
@@ -314,7 +313,7 @@ interface CardProps {
|
|
|
314
313
|
children: React.ReactNode;
|
|
315
314
|
className?: string;
|
|
316
315
|
}
|
|
317
|
-
declare function Card({ title, icon, theme, variant, outline, collapsible, defaultCollapsed, removable, onRemove, maximizable, bodyClass, headerClass, footerClass, tools, footer, children, className, }: CardProps):
|
|
316
|
+
declare function Card({ title, icon, theme, variant, outline, collapsible, defaultCollapsed, removable, onRemove, maximizable, bodyClass, headerClass, footerClass, tools, footer, children, className, }: CardProps): react.JSX.Element | null;
|
|
318
317
|
|
|
319
318
|
interface AlertProps {
|
|
320
319
|
theme?: BootstrapTheme;
|
|
@@ -323,7 +322,7 @@ interface AlertProps {
|
|
|
323
322
|
dismissable?: boolean;
|
|
324
323
|
children: React.ReactNode;
|
|
325
324
|
}
|
|
326
|
-
declare function Alert({ theme, title, icon, dismissable, children, }: AlertProps):
|
|
325
|
+
declare function Alert({ theme, title, icon, dismissable, children, }: AlertProps): react.JSX.Element;
|
|
327
326
|
|
|
328
327
|
interface CalloutProps {
|
|
329
328
|
theme?: BootstrapTheme;
|
|
@@ -331,7 +330,7 @@ interface CalloutProps {
|
|
|
331
330
|
icon?: string;
|
|
332
331
|
children: React.ReactNode;
|
|
333
332
|
}
|
|
334
|
-
declare function Callout({ theme, title, icon, children }: CalloutProps):
|
|
333
|
+
declare function Callout({ theme, title, icon, children }: CalloutProps): react.JSX.Element;
|
|
335
334
|
|
|
336
335
|
interface ProgressProps {
|
|
337
336
|
value?: number;
|
|
@@ -341,7 +340,7 @@ interface ProgressProps {
|
|
|
341
340
|
height?: string;
|
|
342
341
|
showLabel?: boolean;
|
|
343
342
|
}
|
|
344
|
-
declare function Progress({ value, theme, striped, animated, height, showLabel, }: ProgressProps):
|
|
343
|
+
declare function Progress({ value, theme, striped, animated, height, showLabel, }: ProgressProps): react.JSX.Element;
|
|
345
344
|
|
|
346
345
|
interface ProgressGroupProps {
|
|
347
346
|
label: string;
|
|
@@ -350,7 +349,7 @@ interface ProgressGroupProps {
|
|
|
350
349
|
max?: number;
|
|
351
350
|
showPercentage?: boolean;
|
|
352
351
|
}
|
|
353
|
-
declare function ProgressGroup({ label, value, color, max, showPercentage, }: ProgressGroupProps):
|
|
352
|
+
declare function ProgressGroup({ label, value, color, max, showPercentage, }: ProgressGroupProps): react.JSX.Element;
|
|
354
353
|
|
|
355
354
|
interface RatingsProps {
|
|
356
355
|
value: number;
|
|
@@ -359,7 +358,7 @@ interface RatingsProps {
|
|
|
359
358
|
readonly?: boolean;
|
|
360
359
|
className?: string;
|
|
361
360
|
}
|
|
362
|
-
declare function Ratings({ value, max, color, readonly, className, }: RatingsProps):
|
|
361
|
+
declare function Ratings({ value, max, color, readonly, className, }: RatingsProps): react.JSX.Element;
|
|
363
362
|
|
|
364
363
|
interface SocialLink {
|
|
365
364
|
icon: string;
|
|
@@ -376,7 +375,7 @@ interface ProfileCardProps {
|
|
|
376
375
|
className?: string;
|
|
377
376
|
children?: React.ReactNode;
|
|
378
377
|
}
|
|
379
|
-
declare function ProfileCard({ name, title, image, imageAlt, socials, description, className, children, }: ProfileCardProps):
|
|
378
|
+
declare function ProfileCard({ name, title, image, imageAlt, socials, description, className, children, }: ProfileCardProps): react.JSX.Element;
|
|
380
379
|
|
|
381
380
|
interface DescriptionBlockProps {
|
|
382
381
|
title: string;
|
|
@@ -384,7 +383,7 @@ interface DescriptionBlockProps {
|
|
|
384
383
|
items?: Record<string, string>;
|
|
385
384
|
className?: string;
|
|
386
385
|
}
|
|
387
|
-
declare function DescriptionBlock({ title, text, items, className, }: DescriptionBlockProps):
|
|
386
|
+
declare function DescriptionBlock({ title, text, items, className, }: DescriptionBlockProps): react.JSX.Element;
|
|
388
387
|
|
|
389
388
|
interface TimelineItem {
|
|
390
389
|
time: string;
|
|
@@ -399,7 +398,7 @@ interface TimelineProps {
|
|
|
399
398
|
items: TimelineItem[];
|
|
400
399
|
className?: string;
|
|
401
400
|
}
|
|
402
|
-
declare function Timeline({ items, className }: TimelineProps):
|
|
401
|
+
declare function Timeline({ items, className }: TimelineProps): react.JSX.Element;
|
|
403
402
|
|
|
404
403
|
interface NavMessage {
|
|
405
404
|
from: string;
|
|
@@ -416,7 +415,7 @@ interface NavMessagesProps {
|
|
|
416
415
|
seeAllUrl?: string;
|
|
417
416
|
seeAllText?: string;
|
|
418
417
|
}
|
|
419
|
-
declare function NavMessages({ messages, badgeColor, count, seeAllUrl, seeAllText, }: NavMessagesProps):
|
|
418
|
+
declare function NavMessages({ messages, badgeColor, count, seeAllUrl, seeAllText, }: NavMessagesProps): react.JSX.Element;
|
|
420
419
|
|
|
421
420
|
interface NavNotification {
|
|
422
421
|
text: string;
|
|
@@ -431,7 +430,7 @@ interface NavNotificationsProps {
|
|
|
431
430
|
seeAllUrl?: string;
|
|
432
431
|
seeAllText?: string;
|
|
433
432
|
}
|
|
434
|
-
declare function NavNotifications({ notifications, badgeColor, count, seeAllUrl, seeAllText, }: NavNotificationsProps):
|
|
433
|
+
declare function NavNotifications({ notifications, badgeColor, count, seeAllUrl, seeAllText, }: NavNotificationsProps): react.JSX.Element;
|
|
435
434
|
|
|
436
435
|
interface NavTask {
|
|
437
436
|
text: string;
|
|
@@ -445,7 +444,7 @@ interface NavTasksProps {
|
|
|
445
444
|
seeAllUrl?: string;
|
|
446
445
|
seeAllText?: string;
|
|
447
446
|
}
|
|
448
|
-
declare function NavTasks({ tasks, badgeColor, seeAllUrl, seeAllText, }: NavTasksProps):
|
|
447
|
+
declare function NavTasks({ tasks, badgeColor, seeAllUrl, seeAllText, }: NavTasksProps): react.JSX.Element;
|
|
449
448
|
|
|
450
449
|
interface DirectChatProps {
|
|
451
450
|
badge?: number;
|
|
@@ -456,26 +455,26 @@ interface DirectChatProps {
|
|
|
456
455
|
onRemove?: () => void;
|
|
457
456
|
className?: string;
|
|
458
457
|
}
|
|
459
|
-
declare function DirectChat({ badge, contacts, messages, collapsible, removable, onRemove, className, }: DirectChatProps):
|
|
458
|
+
declare function DirectChat({ badge, contacts, messages, collapsible, removable, onRemove, className, }: DirectChatProps): react.JSX.Element | null;
|
|
460
459
|
|
|
461
460
|
interface ApexChartProps {
|
|
462
461
|
id: string;
|
|
463
462
|
series: NonNullable<ApexOptions['series']>;
|
|
464
463
|
config: ApexOptions;
|
|
465
464
|
}
|
|
466
|
-
declare function ApexChart({ id, series, config }: ApexChartProps):
|
|
465
|
+
declare function ApexChart({ id, series, config }: ApexChartProps): react.JSX.Element;
|
|
467
466
|
|
|
468
467
|
interface SparklineChartProps {
|
|
469
468
|
id: string;
|
|
470
469
|
data: number[];
|
|
471
470
|
}
|
|
472
|
-
declare function SparklineChart({ id, data }: SparklineChartProps):
|
|
471
|
+
declare function SparklineChart({ id, data }: SparklineChartProps): react.JSX.Element;
|
|
473
472
|
|
|
474
473
|
interface WorldMapProps {
|
|
475
474
|
id: string;
|
|
476
475
|
height?: number;
|
|
477
476
|
}
|
|
478
|
-
declare function WorldMap({ id, height }: WorldMapProps):
|
|
477
|
+
declare function WorldMap({ id, height }: WorldMapProps): react.JSX.Element;
|
|
479
478
|
|
|
480
479
|
interface CommandItem {
|
|
481
480
|
label: string;
|
|
@@ -496,7 +495,7 @@ interface CommandPaletteProps {
|
|
|
496
495
|
items: CommandItem[];
|
|
497
496
|
placeholder?: string;
|
|
498
497
|
}
|
|
499
|
-
declare function CommandPalette({ items, placeholder }: CommandPaletteProps):
|
|
498
|
+
declare function CommandPalette({ items, placeholder }: CommandPaletteProps): react__default.JSX.Element | null;
|
|
500
499
|
|
|
501
500
|
interface AccordionItem {
|
|
502
501
|
title: React.ReactNode;
|
|
@@ -516,7 +515,7 @@ interface AccordionProps {
|
|
|
516
515
|
/**
|
|
517
516
|
* Bootstrap accordion driven by React state (no Bootstrap JS / data-bs-toggle).
|
|
518
517
|
*/
|
|
519
|
-
declare function Accordion({ items, defaultOpen, alwaysOpen, flush, id, className, }: AccordionProps):
|
|
518
|
+
declare function Accordion({ items, defaultOpen, alwaysOpen, flush, id, className, }: AccordionProps): react.JSX.Element;
|
|
520
519
|
|
|
521
520
|
interface TabItem {
|
|
522
521
|
label: React.ReactNode;
|
|
@@ -533,7 +532,7 @@ interface TabsProps {
|
|
|
533
532
|
/**
|
|
534
533
|
* Bootstrap tabs/pills driven by React state (no Bootstrap JS).
|
|
535
534
|
*/
|
|
536
|
-
declare function Tabs({ items, defaultIndex, variant, fill, justified, className, }: TabsProps):
|
|
535
|
+
declare function Tabs({ items, defaultIndex, variant, fill, justified, className, }: TabsProps): react.JSX.Element;
|
|
537
536
|
|
|
538
537
|
interface ToastProps {
|
|
539
538
|
show: boolean;
|
|
@@ -548,7 +547,7 @@ interface ToastProps {
|
|
|
548
547
|
* Controlled Bootstrap toast (no Bootstrap JS). Render inside a
|
|
549
548
|
* `.toast-container` to position it. Auto-dismisses unless `autohideMs={0}`.
|
|
550
549
|
*/
|
|
551
|
-
declare function Toast({ show, onClose, title, theme, autohideMs, children }: ToastProps):
|
|
550
|
+
declare function Toast({ show, onClose, title, theme, autohideMs, children }: ToastProps): react.JSX.Element | null;
|
|
552
551
|
|
|
553
552
|
interface TooltipProps {
|
|
554
553
|
title: string;
|
|
@@ -559,7 +558,7 @@ interface TooltipProps {
|
|
|
559
558
|
* Lightweight tooltip driven by hover/focus state (no Bootstrap JS / Popper).
|
|
560
559
|
* Uses Bootstrap's `.tooltip` styles; positions the bubble with inline styles.
|
|
561
560
|
*/
|
|
562
|
-
declare function Tooltip({ title, placement, children }: TooltipProps):
|
|
561
|
+
declare function Tooltip({ title, placement, children }: TooltipProps): react.JSX.Element;
|
|
563
562
|
|
|
564
563
|
interface BadgeProps {
|
|
565
564
|
theme?: BootstrapTheme;
|
|
@@ -571,7 +570,7 @@ interface BadgeProps {
|
|
|
571
570
|
children: React.ReactNode;
|
|
572
571
|
}
|
|
573
572
|
/** Bootstrap badge with a contrast-aware `text-bg-*` background. */
|
|
574
|
-
declare function Badge({ theme, pill, positioned, className, children }: BadgeProps):
|
|
573
|
+
declare function Badge({ theme, pill, positioned, className, children }: BadgeProps): react.JSX.Element;
|
|
575
574
|
|
|
576
575
|
interface BreadcrumbItem {
|
|
577
576
|
label: React.ReactNode;
|
|
@@ -585,7 +584,7 @@ interface BreadcrumbProps {
|
|
|
585
584
|
label?: string;
|
|
586
585
|
}
|
|
587
586
|
/** Bootstrap breadcrumb trail. The last item is rendered as the active page. */
|
|
588
|
-
declare function Breadcrumb({ items, divider, className, label }: BreadcrumbProps):
|
|
587
|
+
declare function Breadcrumb({ items, divider, className, label }: BreadcrumbProps): react.JSX.Element;
|
|
589
588
|
|
|
590
589
|
interface SpinnerProps {
|
|
591
590
|
theme?: BootstrapTheme;
|
|
@@ -597,7 +596,7 @@ interface SpinnerProps {
|
|
|
597
596
|
className?: string;
|
|
598
597
|
}
|
|
599
598
|
/** Bootstrap loading spinner with an accessible status label. */
|
|
600
|
-
declare function Spinner({ theme, variant, small, label, className, }: SpinnerProps):
|
|
599
|
+
declare function Spinner({ theme, variant, small, label, className, }: SpinnerProps): react.JSX.Element;
|
|
601
600
|
|
|
602
601
|
type AvatarStatus = 'online' | 'offline' | 'away' | 'busy';
|
|
603
602
|
interface AvatarProps {
|
|
@@ -615,7 +614,7 @@ interface AvatarProps {
|
|
|
615
614
|
className?: string;
|
|
616
615
|
}
|
|
617
616
|
/** A user avatar — image or initials fallback, optional presence dot. */
|
|
618
|
-
declare function Avatar({ src, alt, initials, size, rounded, theme, status, className, }: AvatarProps):
|
|
617
|
+
declare function Avatar({ src, alt, initials, size, rounded, theme, status, className, }: AvatarProps): react.JSX.Element;
|
|
619
618
|
interface AvatarGroupProps {
|
|
620
619
|
/** Pixel overlap between stacked avatars. Default 12. */
|
|
621
620
|
overlap?: number;
|
|
@@ -623,7 +622,7 @@ interface AvatarGroupProps {
|
|
|
623
622
|
children: React.ReactNode;
|
|
624
623
|
}
|
|
625
624
|
/** Overlapping stack of `Avatar`s. */
|
|
626
|
-
declare function AvatarGroup({ overlap, className, children }: AvatarGroupProps):
|
|
625
|
+
declare function AvatarGroup({ overlap, className, children }: AvatarGroupProps): react.JSX.Element;
|
|
627
626
|
|
|
628
627
|
interface ListGroupProps {
|
|
629
628
|
/** Remove the outer border/rounding (for use inside a card). */
|
|
@@ -634,7 +633,7 @@ interface ListGroupProps {
|
|
|
634
633
|
children: React.ReactNode;
|
|
635
634
|
}
|
|
636
635
|
/** Bootstrap list group container. */
|
|
637
|
-
declare function ListGroup({ flush, horizontal, className, children }: ListGroupProps):
|
|
636
|
+
declare function ListGroup({ flush, horizontal, className, children }: ListGroupProps): react.JSX.Element;
|
|
638
637
|
interface ListGroupItemProps {
|
|
639
638
|
active?: boolean;
|
|
640
639
|
disabled?: boolean;
|
|
@@ -647,7 +646,7 @@ interface ListGroupItemProps {
|
|
|
647
646
|
children: React.ReactNode;
|
|
648
647
|
}
|
|
649
648
|
/** A single list group item — `<a>`, `<button>` or `<div>` depending on its props. */
|
|
650
|
-
declare function ListGroupItem({ active, disabled, action, theme, href, onClick, className, children, }: ListGroupItemProps):
|
|
649
|
+
declare function ListGroupItem({ active, disabled, action, theme, href, onClick, className, children, }: ListGroupItemProps): react.JSX.Element;
|
|
651
650
|
|
|
652
651
|
interface TableColumn<T> {
|
|
653
652
|
/** Key into the row, or a unique id when using `render`. */
|
|
@@ -677,7 +676,7 @@ interface TableProps<T> {
|
|
|
677
676
|
className?: string;
|
|
678
677
|
}
|
|
679
678
|
/** A typed, declarative table driven by `columns` + `data`. */
|
|
680
|
-
declare function Table<T>({ columns, data, rowKey, striped, hover, bordered, borderless, small, responsive, theme, caption, emptyMessage, className, }: TableProps<T>):
|
|
679
|
+
declare function Table<T>({ columns, data, rowKey, striped, hover, bordered, borderless, small, responsive, theme, caption, emptyMessage, className, }: TableProps<T>): react.JSX.Element;
|
|
681
680
|
|
|
682
681
|
interface PaginationProps {
|
|
683
682
|
/** 1-based current page. */
|
|
@@ -694,7 +693,7 @@ interface PaginationProps {
|
|
|
694
693
|
className?: string;
|
|
695
694
|
}
|
|
696
695
|
/** Bootstrap pagination. Renders `<button>`s when `onPageChange` is given, else `<a href="#">`. */
|
|
697
|
-
declare function Pagination({ page, totalPages, onPageChange, size, siblingCount, align, hideControls, label, className, }: PaginationProps):
|
|
696
|
+
declare function Pagination({ page, totalPages, onPageChange, size, siblingCount, align, hideControls, label, className, }: PaginationProps): react.JSX.Element | null;
|
|
698
697
|
|
|
699
698
|
interface Step {
|
|
700
699
|
label: React.ReactNode;
|
|
@@ -712,7 +711,7 @@ interface StepperProps {
|
|
|
712
711
|
className?: string;
|
|
713
712
|
}
|
|
714
713
|
/** A progress stepper (wizard). Pure/controlled — drive `active` from parent state. */
|
|
715
|
-
declare function Stepper({ steps, active, orientation, onStepClick, className }: StepperProps):
|
|
714
|
+
declare function Stepper({ steps, active, orientation, onStepClick, className }: StepperProps): react.JSX.Element;
|
|
716
715
|
|
|
717
716
|
interface DropdownItem {
|
|
718
717
|
label?: React.ReactNode;
|
|
@@ -744,7 +743,7 @@ interface DropdownProps {
|
|
|
744
743
|
* Bootstrap dropdown (driven by the Bootstrap JS bundle via `data-bs-toggle`).
|
|
745
744
|
* Ensure `bootstrap.bundle.js` is loaded in the host app.
|
|
746
745
|
*/
|
|
747
|
-
declare function Dropdown({ label, items, theme, size, variant, align, direction, split, className, }: DropdownProps):
|
|
746
|
+
declare function Dropdown({ label, items, theme, size, variant, align, direction, split, className, }: DropdownProps): react.JSX.Element;
|
|
748
747
|
|
|
749
748
|
interface CarouselSlide {
|
|
750
749
|
src?: string;
|
|
@@ -772,7 +771,7 @@ interface CarouselProps {
|
|
|
772
771
|
/**
|
|
773
772
|
* Bootstrap carousel (driven by the Bootstrap JS bundle). Pass a unique `id`.
|
|
774
773
|
*/
|
|
775
|
-
declare function Carousel({ id, slides, controls, indicators, ride, fade, interval, className, }: CarouselProps):
|
|
774
|
+
declare function Carousel({ id, slides, controls, indicators, ride, fade, interval, className, }: CarouselProps): react.JSX.Element;
|
|
776
775
|
|
|
777
776
|
interface OffcanvasProps {
|
|
778
777
|
/** Required: unique id; triggers reference it via `target`. */
|
|
@@ -791,7 +790,7 @@ interface OffcanvasProps {
|
|
|
791
790
|
* Bootstrap offcanvas panel (driven by the Bootstrap JS bundle). Pair with an
|
|
792
791
|
* `OffcanvasTrigger` (or any element with `data-bs-toggle="offcanvas"`).
|
|
793
792
|
*/
|
|
794
|
-
declare function Offcanvas({ id, title, placement, scroll, backdrop, footer, className, children, }: OffcanvasProps):
|
|
793
|
+
declare function Offcanvas({ id, title, placement, scroll, backdrop, footer, className, children, }: OffcanvasProps): react.JSX.Element;
|
|
795
794
|
interface OffcanvasTriggerProps {
|
|
796
795
|
/** The `id` of the Offcanvas to open. */
|
|
797
796
|
target: string;
|
|
@@ -802,7 +801,7 @@ interface OffcanvasTriggerProps {
|
|
|
802
801
|
children: React.ReactNode;
|
|
803
802
|
}
|
|
804
803
|
/** A button that opens the Offcanvas with the matching `target` id. */
|
|
805
|
-
declare function OffcanvasTrigger({ target, theme, variant, size, className, children, }: OffcanvasTriggerProps):
|
|
804
|
+
declare function OffcanvasTrigger({ target, theme, variant, size, className, children, }: OffcanvasTriggerProps): react.JSX.Element;
|
|
806
805
|
|
|
807
806
|
interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
|
|
808
807
|
theme?: BootstrapTheme;
|
|
@@ -811,7 +810,7 @@ interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
|
|
|
811
810
|
icon?: string;
|
|
812
811
|
label?: string;
|
|
813
812
|
}
|
|
814
|
-
declare function Button({ theme, outline, size, icon, label, children, className, ...props }: ButtonProps):
|
|
813
|
+
declare function Button({ theme, outline, size, icon, label, children, className, ...props }: ButtonProps): react.JSX.Element;
|
|
815
814
|
|
|
816
815
|
interface InputProps extends React.InputHTMLAttributes<HTMLInputElement> {
|
|
817
816
|
label?: string;
|
|
@@ -820,7 +819,7 @@ interface InputProps extends React.InputHTMLAttributes<HTMLInputElement> {
|
|
|
820
819
|
error?: string;
|
|
821
820
|
hint?: string;
|
|
822
821
|
}
|
|
823
|
-
declare const Input:
|
|
822
|
+
declare const Input: react.ForwardRefExoticComponent<InputProps & react.RefAttributes<HTMLInputElement>>;
|
|
824
823
|
|
|
825
824
|
interface SelectProps extends React.SelectHTMLAttributes<HTMLSelectElement> {
|
|
826
825
|
label?: string;
|
|
@@ -832,7 +831,7 @@ interface SelectProps extends React.SelectHTMLAttributes<HTMLSelectElement> {
|
|
|
832
831
|
}>;
|
|
833
832
|
children?: React.ReactNode;
|
|
834
833
|
}
|
|
835
|
-
declare const Select:
|
|
834
|
+
declare const Select: react.ForwardRefExoticComponent<SelectProps & react.RefAttributes<HTMLSelectElement>>;
|
|
836
835
|
|
|
837
836
|
interface TextareaProps extends React.TextareaHTMLAttributes<HTMLTextAreaElement> {
|
|
838
837
|
label?: string;
|
|
@@ -840,7 +839,7 @@ interface TextareaProps extends React.TextareaHTMLAttributes<HTMLTextAreaElement
|
|
|
840
839
|
error?: string;
|
|
841
840
|
hint?: string;
|
|
842
841
|
}
|
|
843
|
-
declare const Textarea:
|
|
842
|
+
declare const Textarea: react.ForwardRefExoticComponent<TextareaProps & react.RefAttributes<HTMLTextAreaElement>>;
|
|
844
843
|
|
|
845
844
|
interface InputSwitchProps {
|
|
846
845
|
name: string;
|
|
@@ -852,14 +851,14 @@ interface InputSwitchProps {
|
|
|
852
851
|
fgroupClass?: string;
|
|
853
852
|
error?: string;
|
|
854
853
|
}
|
|
855
|
-
declare const InputSwitch:
|
|
854
|
+
declare const InputSwitch: react.ForwardRefExoticComponent<InputSwitchProps & react.RefAttributes<HTMLInputElement>>;
|
|
856
855
|
|
|
857
856
|
interface InputColorProps extends React.InputHTMLAttributes<HTMLInputElement> {
|
|
858
857
|
label?: string;
|
|
859
858
|
fgroupClass?: string;
|
|
860
859
|
error?: string;
|
|
861
860
|
}
|
|
862
|
-
declare function InputColor({ name, label, fgroupClass, error, className, defaultValue, ...props }: InputColorProps):
|
|
861
|
+
declare function InputColor({ name, label, fgroupClass, error, className, defaultValue, ...props }: InputColorProps): react.JSX.Element;
|
|
863
862
|
|
|
864
863
|
interface InputFileProps extends React.InputHTMLAttributes<HTMLInputElement> {
|
|
865
864
|
label?: string;
|
|
@@ -867,7 +866,7 @@ interface InputFileProps extends React.InputHTMLAttributes<HTMLInputElement> {
|
|
|
867
866
|
error?: string;
|
|
868
867
|
multiple?: boolean;
|
|
869
868
|
}
|
|
870
|
-
declare function InputFile({ name, label, fgroupClass, error, multiple, className, ...props }: InputFileProps):
|
|
869
|
+
declare function InputFile({ name, label, fgroupClass, error, multiple, className, ...props }: InputFileProps): react.JSX.Element;
|
|
871
870
|
|
|
872
871
|
interface InputFlatpickrProps extends React.InputHTMLAttributes<HTMLInputElement> {
|
|
873
872
|
label?: string;
|
|
@@ -876,7 +875,7 @@ interface InputFlatpickrProps extends React.InputHTMLAttributes<HTMLInputElement
|
|
|
876
875
|
dateType?: 'text' | 'date' | 'time' | 'datetime';
|
|
877
876
|
options?: Record<string, unknown>;
|
|
878
877
|
}
|
|
879
|
-
declare function InputFlatpickr({ name, label, fgroupClass, error, dateType, options, className, ...props }: InputFlatpickrProps):
|
|
878
|
+
declare function InputFlatpickr({ name, label, fgroupClass, error, dateType, options, className, ...props }: InputFlatpickrProps): react.JSX.Element;
|
|
880
879
|
|
|
881
880
|
interface InputTomSelectProps extends React.SelectHTMLAttributes<HTMLSelectElement> {
|
|
882
881
|
label?: string;
|
|
@@ -888,7 +887,7 @@ interface InputTomSelectProps extends React.SelectHTMLAttributes<HTMLSelectEleme
|
|
|
888
887
|
}>;
|
|
889
888
|
tomSelectOptions?: Record<string, unknown>;
|
|
890
889
|
}
|
|
891
|
-
declare function InputTomSelect({ name, label, fgroupClass, error, options, tomSelectOptions, className, 'aria-label': ariaLabelProp, ...props }: InputTomSelectProps):
|
|
890
|
+
declare function InputTomSelect({ name, label, fgroupClass, error, options, tomSelectOptions, className, 'aria-label': ariaLabelProp, ...props }: InputTomSelectProps): react.JSX.Element;
|
|
892
891
|
|
|
893
892
|
interface ModalProps {
|
|
894
893
|
id: string;
|
|
@@ -903,7 +902,7 @@ interface ModalProps {
|
|
|
903
902
|
onShow?: () => void;
|
|
904
903
|
onHide?: () => void;
|
|
905
904
|
}
|
|
906
|
-
declare function Modal({ id, title, size, theme, staticBackdrop, scrollable, centered, footer, children, }: ModalProps):
|
|
905
|
+
declare function Modal({ id, title, size, theme, staticBackdrop, scrollable, centered, footer, children, }: ModalProps): react.JSX.Element;
|
|
907
906
|
|
|
908
907
|
interface DatatableColumn {
|
|
909
908
|
title: string;
|
|
@@ -920,7 +919,7 @@ interface DatatableProps {
|
|
|
920
919
|
tabulatorOptions?: Record<string, unknown>;
|
|
921
920
|
className?: string;
|
|
922
921
|
}
|
|
923
|
-
declare function Datatable({ id, columns, data, apiUrl, tabulatorOptions, className, }: DatatableProps):
|
|
922
|
+
declare function Datatable({ id, columns, data, apiUrl, tabulatorOptions, className, }: DatatableProps): react.JSX.Element;
|
|
924
923
|
|
|
925
924
|
interface EditorProps {
|
|
926
925
|
name: string;
|
|
@@ -933,7 +932,7 @@ interface EditorProps {
|
|
|
933
932
|
fgroupClass?: string;
|
|
934
933
|
onChange?: (html: string) => void;
|
|
935
934
|
}
|
|
936
|
-
declare function Editor({ name, label, value, placeholder, quillOptions, fgroupClass, onChange, }: EditorProps):
|
|
935
|
+
declare function Editor({ name, label, value, placeholder, quillOptions, fgroupClass, onChange, }: EditorProps): react.JSX.Element;
|
|
937
936
|
|
|
938
937
|
interface UsePushMenuOptions {
|
|
939
938
|
sidebarBreakpoint?: number;
|