Neutrino Docs
SDK Reference

@neutrino-io/ui-core

API reference for @neutrino-io/ui-core

Exports

SymbolKindTypeDescription
fontsVariablereadonly ["inter", "manrope", "system"]
toastVariable((message: titleT, data?: ExternalToast) =\> string | number) & { success: (message: titleT | React.ReactNode, data?: ...
SidebarProviderFunction({ defaultOpen, open: openProp, onOpenChange: setOpenProp, className, style, children, ...props }: React.ComponentPro...
SidebarFunction({ side, variant, collapsible, className, children, ...props }: React.ComponentProps\<"div"\> & { side?: "left" | "righ...
SidebarTriggerFunction({ className, onClick, ...props }: React.ComponentProps\<typeof Button\>) =\> import("@types/react/jsx-runtime").JSX.Ele...
useSidebarFunction() =\> SidebarContextProps
SidebarContentFunction({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element
SidebarFooterFunction({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element
SidebarHeaderFunction({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element
SidebarRailFunction({ className, ...props }: React.ComponentProps\<"button"\>) =\> import("@types/react/jsx-runtime").JSX.Element
SidebarInsetFunction({ className, ...props }: React.ComponentProps\<"main"\>) =\> import("@types/react/jsx-runtime").JSX.Element
PaginationFunction({ currentPage, totalPages, onPageChange, disabled, showFirstLast, maxVisiblePages, className, }: PaginationProps) =\>...
PaginationInfoFunction({ currentPage, pageSize, totalItems, itemName, className, }: PaginationInfoProps) =\> import("@types/react/jsx-runtim...
PaginationWithInfoFunction({ currentPage, totalPages, pageSize, totalItems, itemName, showInfo, onPageChange, disabled, showFirstLast, maxVisib...
ProgressFunction({ className, value, ...props }: React.ComponentProps\<typeof ProgressPrimitive.Root\>) =\> import("@types/react/jsx-run...
FeatureRegistryContextVariableReact.Context\<FeatureRegistryContextType | null\>
FeatureRegistryProviderFunction({ config, options, children, }: FeatureRegistryProviderProps) =\> import("@types/react/jsx-runtime").JSX.Element
ThemeProviderFunction({ children, defaultTheme, storageKey, selectedTheme, ...props }: ThemeProviderProps) =\> import("@types/react/jsx-run...
useThemeVariable() =\> ThemeProviderState
ThemeTypeTheme
ThemeProviderPropsInterfaceThemeProviderProps
ThemeSwitchFunction({ theme, setTheme, updateMetaTag, className, }: ThemeSwitchProps) =\> import("@types/react/jsx-runtime").JSX.ElementGeneric theme switch component that can work with any theme provider
Accepts theme state and setter as props for maximum flexibility
ThemeSelectorFunction({ value, onValueChange, className, children, }: ThemeSelectorProps) =\> import("@types/react/jsx-runtime").JSX.Element
FontProviderVariableReact.FC\<FontProviderProps\>
useFontVariable() =\> FontContextType
FontProviderPropsInterfaceFontProviderProps
SearchProviderFunction({ children, groups }: SearchProviderProps) =\> import("@types/react/jsx-runtime").JSX.Element
useSearchVariable() =\> SearchContextType
SearchContextTypeInterfaceSearchContextType
SearchProviderPropsInterfaceSearchProviderProps
NeutrinoProviderFunction({ config, queryClient, authWrapper, }: NeutrinoProviderProps) =\> import("@types/react/jsx-runtime").JSX.Element
useNeutrinoConfigFunction() =\> NeutrinoConfig
NeutrinoProviderPropsInterfaceNeutrinoProviderProps
KeyboardShortcutsModalFunction({ shortcuts, }: KeyboardShortcutsModalProps) =\> import("@types/react/jsx-runtime").JSX.Element
KeyboardShortcutsFunction({ groups, open: controlledOpen, onOpenChange, }: KeyboardShortcutsProps) =\> import("@types/react/jsx-runtime").JSX.E...Generic keyboard shortcuts modal component
Displays a list of shortcuts grouped by category
Handles the '?' key listener to toggle the modal
ShortcutInterfaceShortcut
ShortcutGroupInterfaceShortcutGroup
CommandPaletteFunction({ open, onOpenChange, placeholder, emptyMessage, groups, maxHeight, }: CommandPaletteProps) =\> import("@types/react/...Generic command palette component that can be used across applications
Accepts groups of actions and handles the command execution flow
CommandPaletteGroupInterfaceCommandPaletteGroup
errorRouteManifestVariableRouteManifest
PageHeaderFunction({ title, description, breadcrumbs, actions, action, size, divider, className, }: PageHeaderProps) =\> import("@types/...
SectionHeaderFunction({ title, description, actions, className, }: SectionHeaderProps) =\> import("@types/react/jsx-runtime").JSX.Element
SectionHeaderPropsInterfaceSectionHeaderProps
StatCardVariableStatCardComponent
isOverThresholdFunction(value: number, max: number, threshold: number) =\> booleanReturns true when value / max meets or exceeds threshold. Used by
consumers to drive a threshold alert in the StatCard.Header actions slot.
StatCardPropsTypeStatCardProps
UsageCardFunction({ title, value, secondaryLine, progress, color, limitLabel, actionLabel, onAction, className, }: UsageCardProps) =\> ...
UsageCardPropsInterfaceUsageCardProps
UsageCardProgressInterfaceUsageCardProgress
UsageCardColorTypeUsageCardColor
FeatureWrapperFunction({ featureConfig, children, }: FeatureWrapperProps) =\> string | number | bigint | boolean | Iterable\<React.ReactNode\>...Wrapper component that applies navigation configuration for features
withFeatureWrapperFunction\<P extends object\>(Component: React.ComponentType\<P\>, featureConfig: FeatureConfig) =\> { (props: P & { ref?: React.Re...Higher-order component for wrapping feature components with navigation integration
useFeatureContextFunction(featureId: string) =\> { featureId: string; }Hook for feature components to access their navigation context
AlertDialogFunction({ ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.Element
AlertDialogPortalFunction({ ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Portal\>) =\> import("@types/react/jsx-runtime").JSX.El...
AlertDialogOverlayFunction({ className, ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Overlay\>) =\> import("@types/react/jsx-runt...
AlertDialogTriggerFunction({ ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Trigger\>) =\> import("@types/react/jsx-runtime").JSX.E...
AlertDialogContentFunction({ className, ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Content\>) =\> import("@types/react/jsx-runt...
AlertDialogHeaderFunction({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element
AlertDialogFooterFunction({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element
AlertDialogTitleFunction({ className, ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Title\>) =\> import("@types/react/jsx-runtim...
AlertDialogDescriptionFunction({ className, ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Description\>) =\> import("@types/react/jsx-...
AlertDialogActionFunction({ className, ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Action\>) =\> import("@types/react/jsx-runti...
AlertDialogCancelFunction({ className, ...props }: React.ComponentProps\<typeof AlertDialogPrimitive.Cancel\>) =\> import("@types/react/jsx-runti...
AvatarFunction({ className, ...props }: React.ComponentProps\<typeof AvatarPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JS...
AvatarImageFunction({ className, ...props }: React.ComponentProps\<typeof AvatarPrimitive.Image\>) =\> import("@types/react/jsx-runtime").J...
AvatarFallbackFunction({ className, ...props }: React.ComponentProps\<typeof AvatarPrimitive.Fallback\>) =\> import("@types/react/jsx-runtime"...
UserAvatarFunction({ name, imageUrl, initials, className, ...rest }: UserAvatarProps) =\> import("@types/react/jsx-runtime").JSX.ElementAvatar with consistent fallback styling and locale-aware initials.

Single source of truth for avatar rendering across console + features (sidebar footer, members table, comment threads, etc.). Replaces the ad-hoc \<AvatarFallback\> blends that were drifting per consumer. | | UserAvatarProps | Interface | UserAvatarProps | | | Badge | Function | ({ className, variant, asChild, ...props }: React.ComponentProps\<"span"\> & VariantProps\<typeof badgeVariants\> & { asC... | | | badgeVariants | Variable | (props?: ({ variant?: "default" \| "destructive" \| "outline" \| "secondary" \| "success" \| null \| undefined; } & import(... | | | Button | Function | ({ className, variant, size, asChild, ...props }: React.ComponentProps\<"button"\> & VariantProps\<typeof buttonVariants... | | | buttonVariants | Variable | (props?: ({ variant?: "link" \| "default" \| "destructive" \| "outline" \| "secondary" \| "ghost" \| null \| undefined; size... | | | Calendar | Function | ({ className, classNames, showOutsideDays, captionLayout, buttonVariant, formatters, components, ...props }: React.Co... | | | CalendarDayButton | Function | ({ className, day, modifiers, ...props }: React.ComponentProps\<typeof DayButton\>) =\> import("@types/react/jsx-runtime... | | | Card | Function | ({ className, density, ...props }: CardProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | CardHeader | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | CardFooter | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | CardTitle | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | CardAction | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | CardDescription | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | CardContent | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | Checkbox | Function | ({ className, ...props }: React.ComponentProps\<typeof CheckboxPrimitive.Root\>) =\> import("@types/react/jsx-runtime").... | | | Collapsible | Function | ({ ...props }: React.ComponentProps\<typeof CollapsiblePrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | CollapsibleTrigger | Function | ({ ...props }: React.ComponentProps\<typeof CollapsiblePrimitive.CollapsibleTrigger\>) =\> import("@types/react/jsx-runt... | | | CollapsibleContent | Function | ({ ...props }: React.ComponentProps\<typeof CollapsiblePrimitive.CollapsibleContent\>) =\> import("@types/react/jsx-runt... | | | Command | Function | ({ className, ...props }: React.ComponentProps\<typeof CommandPrimitive\>) =\> import("@types/react/jsx-runtime").JSX.El... | | | CommandDialog | Function | ({ title, description, children, className, showCloseButton, ...props }: React.ComponentProps\<typeof Dialog\> & { titl... | | | CommandInput | Function | ({ className, ...props }: React.ComponentProps\<typeof CommandPrimitive.Input\>) =\> import("@types/react/jsx-runtime").... | | | CommandList | Function | ({ className, ...props }: React.ComponentProps\<typeof CommandPrimitive.List\>) =\> import("@types/react/jsx-runtime").J... | | | CommandEmpty | Function | ({ ...props }: React.ComponentProps\<typeof CommandPrimitive.Empty\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | CommandGroup | Function | ({ className, ...props }: React.ComponentProps\<typeof CommandPrimitive.Group\>) =\> import("@types/react/jsx-runtime").... | | | CommandItem | Function | ({ className, ...props }: React.ComponentProps\<typeof CommandPrimitive.Item\>) =\> import("@types/react/jsx-runtime").J... | | | CommandShortcut | Function | ({ className, ...props }: React.ComponentProps\<"span"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | CommandSeparator | Function | ({ className, ...props }: React.ComponentProps\<typeof CommandPrimitive.Separator\>) =\> import("@types/react/jsx-runtim... | | | Dialog | Function | ({ ...props }: React.ComponentProps\<typeof DialogPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | DialogClose | Function | ({ ...props }: React.ComponentProps\<typeof DialogPrimitive.Close\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | DialogContent | Function | ({ className, children, showCloseButton, ...props }: React.ComponentProps\<typeof DialogPrimitive.Content\> & { showClo... | | | DialogDescription | Function | ({ className, ...props }: React.ComponentProps\<typeof DialogPrimitive.Description\>) =\> import("@types/react/jsx-runti... | | | DialogFooter | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | DialogHeader | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | DialogOverlay | Function | ({ className, ...props }: React.ComponentProps\<typeof DialogPrimitive.Overlay\>) =\> import("@types/react/jsx-runtime")... | | | DialogPortal | Function | ({ ...props }: React.ComponentProps\<typeof DialogPrimitive.Portal\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | DialogTitle | Function | ({ className, ...props }: React.ComponentProps\<typeof DialogPrimitive.Title\>) =\> import("@types/react/jsx-runtime").J... | | | DialogTrigger | Function | ({ ...props }: React.ComponentProps\<typeof DialogPrimitive.Trigger\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | DropdownMenu | Function | ({ ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.Ele... | | | DropdownMenuPortal | Function | ({ ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Portal\>) =\> import("@types/react/jsx-runtime").JSX.E... | | | DropdownMenuTrigger | Function | ({ ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Trigger\>) =\> import("@types/react/jsx-runtime").JSX.... | | | DropdownMenuContent | Function | ({ className, sideOffset, ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Content\>) =\> import("@types/r... | | | DropdownMenuGroup | Function | ({ ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Group\>) =\> import("@types/react/jsx-runtime").JSX.El... | | | DropdownMenuLabel | Function | ({ className, inset, ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Label\> & { inset?: boolean; }) =\> ... | | | DropdownMenuItem | Function | ({ className, inset, variant, ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Item\> & { inset?: boolean... | | | DropdownMenuCheckboxItem | Function | ({ className, children, checked, ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.CheckboxItem\>) =\> impo... | | | DropdownMenuRadioGroup | Function | ({ ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.RadioGroup\>) =\> import("@types/react/jsx-runtime").J... | | | DropdownMenuRadioItem | Function | ({ className, children, ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.RadioItem\>) =\> import("@types/r... | | | DropdownMenuSeparator | Function | ({ className, ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Separator\>) =\> import("@types/react/jsx-r... | | | DropdownMenuShortcut | Function | ({ className, ...props }: React.ComponentProps\<"span"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | DropdownMenuSub | Function | ({ ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.Sub\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | DropdownMenuSubTrigger | Function | ({ className, inset, children, ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.SubTrigger\> & { inset?: ... | | | DropdownMenuSubContent | Function | ({ className, ...props }: React.ComponentProps\<typeof DropdownMenuPrimitive.SubContent\>) =\> import("@types/react/jsx-... | | | useFormField | Variable | () =\> { invalid: boolean; isDirty: boolean; isTouched: boolean; isValidating: boolean; error?: import("react-hook-for... | | | Form | Variable | \<TFieldValues extends FieldValues, TContext = any, TTransformedValues = TFieldValues\>(props: import("react-hook-form/... | | | FormItem | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | FormLabel | Function | ({ className, ...props }: React.ComponentProps\<typeof LabelPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX... | | | FormControl | Function | ({ ...props }: React.ComponentProps\<typeof Slot\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | FormDescription | Function | ({ className, ...props }: React.ComponentProps\<"p"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | FormMessage | Function | ({ className, ...props }: React.ComponentProps\<"p"\>) =\> import("@types/react/jsx-runtime").JSX.Element \| null | | | FormField | Variable | \<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath\<TFieldValues\> = FieldPath\<TFieldValues\>\>({ .... | | | Input | Function | ({ className, type, ...props }: React.ComponentProps\<"input"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | InputOTP | Function | ({ className, containerClassName, ...props }: React.ComponentProps\<typeof OTPInput\>) =\> import("@types/react/jsx-runt... | | | InputOTPGroup | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | InputOTPSlot | Function | ({ index, className, ...props }: React.ComponentProps\<"div"\> & { index: number; }) =\> import("@types/react/jsx-runtim... | | | InputOTPSeparator | Function | ({ ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | Label | Function | ({ className, ...props }: React.ComponentProps\<typeof LabelPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX... | | | Popover | Function | ({ ...props }: React.ComponentProps\<typeof PopoverPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | PopoverTrigger | Function | ({ ...props }: React.ComponentProps\<typeof PopoverPrimitive.Trigger\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | PopoverContent | Function | ({ className, align, sideOffset, ...props }: React.ComponentProps\<typeof PopoverPrimitive.Content\>) =\> import("@types... | | | PopoverAnchor | Function | ({ ...props }: React.ComponentProps\<typeof PopoverPrimitive.Anchor\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | RadioGroup | Function | ({ className, ...props }: React.ComponentProps\<typeof RadioGroupPrimitive.Root\>) =\> import("@types/react/jsx-runtime"... | | | RadioGroupItem | Function | ({ className, ...props }: React.ComponentProps\<typeof RadioGroupPrimitive.Item\>) =\> import("@types/react/jsx-runtime"... | | | ScrollArea | Function | ({ className, children, ...props }: React.ComponentProps\<typeof ScrollAreaPrimitive.Root\>) =\> import("@types/react/js... | | | ScrollBar | Function | ({ className, orientation, ...props }: React.ComponentProps\<typeof ScrollAreaPrimitive.ScrollAreaScrollbar\>) =\> impor... | | | Select | Function | ({ ...props }: React.ComponentProps\<typeof SelectPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SelectContent | Function | ({ className, children, position, ...props }: React.ComponentProps\<typeof SelectPrimitive.Content\>) =\> import("@types... | | | SelectGroup | Function | ({ ...props }: React.ComponentProps\<typeof SelectPrimitive.Group\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SelectItem | Function | ({ className, children, ...props }: React.ComponentProps\<typeof SelectPrimitive.Item\>) =\> import("@types/react/jsx-ru... | | | SelectLabel | Function | ({ className, ...props }: React.ComponentProps\<typeof SelectPrimitive.Label\>) =\> import("@types/react/jsx-runtime").J... | | | SelectScrollDownButton | Function | ({ className, ...props }: React.ComponentProps\<typeof SelectPrimitive.ScrollDownButton\>) =\> import("@types/react/jsx-... | | | SelectScrollUpButton | Function | ({ className, ...props }: React.ComponentProps\<typeof SelectPrimitive.ScrollUpButton\>) =\> import("@types/react/jsx-ru... | | | SelectSeparator | Function | ({ className, ...props }: React.ComponentProps\<typeof SelectPrimitive.Separator\>) =\> import("@types/react/jsx-runtime... | | | SelectTrigger | Function | ({ className, size, children, ...props }: React.ComponentProps\<typeof SelectPrimitive.Trigger\> & { size?: "sm" \| "def... | | | SelectValue | Function | ({ ...props }: React.ComponentProps\<typeof SelectPrimitive.Value\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | Separator | Function | ({ className, orientation, decorative, ...props }: React.ComponentProps\<typeof SeparatorPrimitive.Root\>) =\> import("@... | | | Sheet | Function | ({ ...props }: React.ComponentProps\<typeof SheetPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SheetTrigger | Function | ({ ...props }: React.ComponentProps\<typeof SheetPrimitive.Trigger\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SheetClose | Function | ({ ...props }: React.ComponentProps\<typeof SheetPrimitive.Close\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SheetContent | Function | ({ className, children, side, ...props }: React.ComponentProps\<typeof SheetPrimitive.Content\> & { side?: "top" \| "rig... | | | SheetHeader | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SheetFooter | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SheetTitle | Function | ({ className, ...props }: React.ComponentProps\<typeof SheetPrimitive.Title\>) =\> import("@types/react/jsx-runtime").JS... | | | SheetDescription | Function | ({ className, ...props }: React.ComponentProps\<typeof SheetPrimitive.Description\>) =\> import("@types/react/jsx-runtim... | | | SidebarGroup | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SidebarGroupAction | Function | ({ className, asChild, ...props }: React.ComponentProps\<"button"\> & { asChild?: boolean; }) =\> import("@types/react/j... | | | SidebarGroupContent | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SidebarGroupLabel | Function | ({ className, asChild, ...props }: React.ComponentProps\<"div"\> & { asChild?: boolean; }) =\> import("@types/react/jsx-... | | | SidebarInput | Function | ({ className, ...props }: React.ComponentProps\<typeof Input\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SidebarMenu | Function | ({ className, ...props }: React.ComponentProps\<"ul"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SidebarMenuAction | Function | ({ className, asChild, showOnHover, ...props }: React.ComponentProps\<"button"\> & { asChild?: boolean; showOnHover?: b... | | | SidebarMenuBadge | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SidebarMenuButton | Function | ({ asChild, isActive, variant, size, tooltip, className, ...props }: React.ComponentProps\<"button"\> & { asChild?: boo... | | | SidebarMenuItem | Function | ({ className, ...props }: React.ComponentProps\<"li"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SidebarMenuSkeleton | Function | ({ className, showIcon, ...props }: React.ComponentProps\<"div"\> & { showIcon?: boolean; }) =\> import("@types/react/js... | | | SidebarMenuSub | Function | ({ className, ...props }: React.ComponentProps\<"ul"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SidebarMenuSubButton | Function | ({ asChild, size, isActive, className, ...props }: React.ComponentProps\<"a"\> & { asChild?: boolean; size?: "sm" \| "md... | | | SidebarMenuSubItem | Function | ({ className, ...props }: React.ComponentProps\<"li"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | SidebarSeparator | Function | ({ className, ...props }: React.ComponentProps\<typeof Separator\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | Skeleton | Function | ({ className, ...props }: React.ComponentProps\<"div"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | Toaster | Variable | ({ theme, ...props }: ToasterProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | Switch | Function | ({ className, ...props }: React.ComponentProps\<typeof SwitchPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JS... | | | Table | Function | ({ className, ...props }: React.ComponentProps\<"table"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TableHeader | Function | ({ className, ...props }: React.ComponentProps\<"thead"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TableBody | Function | ({ className, ...props }: React.ComponentProps\<"tbody"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TableFooter | Function | ({ className, ...props }: React.ComponentProps\<"tfoot"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TableHead | Function | ({ className, ...props }: React.ComponentProps\<"th"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TableRow | Function | ({ className, ...props }: React.ComponentProps\<"tr"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TableCell | Function | ({ className, ...props }: React.ComponentProps\<"td"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TableCaption | Function | ({ className, ...props }: React.ComponentProps\<"caption"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | Tabs | Function | ({ className, ...props }: React.ComponentProps\<typeof TabsPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.... | | | TabsList | Function | ({ className, ...props }: React.ComponentProps\<typeof TabsPrimitive.List\>) =\> import("@types/react/jsx-runtime").JSX.... | | | TabsTrigger | Function | ({ className, ...props }: React.ComponentProps\<typeof TabsPrimitive.Trigger\>) =\> import("@types/react/jsx-runtime").J... | | | TabsContent | Function | ({ className, ...props }: React.ComponentProps\<typeof TabsPrimitive.Content\>) =\> import("@types/react/jsx-runtime").J... | | | Textarea | Function | ({ className, ...props }: React.ComponentProps\<"textarea"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | Tooltip | Function | ({ ...props }: React.ComponentProps\<typeof TooltipPrimitive.Root\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TooltipTrigger | Function | ({ ...props }: React.ComponentProps\<typeof TooltipPrimitive.Trigger\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | TooltipContent | Function | ({ className, sideOffset, children, ...props }: React.ComponentProps\<typeof TooltipPrimitive.Content\>) =\> import("@ty... | | | TooltipProvider | Function | ({ delayDuration, ...props }: React.ComponentProps\<typeof TooltipPrimitive.Provider\>) =\> import("@types/react/jsx-run... | | | PaginationProps | Interface | PaginationProps | | | PaginationInfoProps | Interface | PaginationInfoProps | Pagination Info Component Shows "Showing X-Y of Z items" | | PaginationWithInfoProps | Interface | PaginationWithInfoProps | Combined Pagination with Info | | HeaderProps | Interface | HeaderProps | | | Header | Variable | { ({ className, fixed, children, ...props }: HeaderProps): import("@types/react/jsx-runtime").JSX.Element; displayNam... | | | MainProps | Interface | MainProps | | | Main | Variable | { ({ fixed, ...props }: MainProps): import("@types/react/jsx-runtime").JSX.Element; displayName: string; } | | | SettingsSection | Function | ({ title, description, action, children, className, width, constrained, }: SettingsSectionProps) =\> import("@types/re... | | | SettingsSectionProps | Interface | SettingsSectionProps | | | TopNav | Function | ({ className, links, ...props }: TopNavProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | NavGroup | Function | ({ title, items }: NavGroup) =\> import("@types/react/jsx-runtime").JSX.Element | | | NavigationProgress | Function | () =\> import("@types/react/jsx-runtime").JSX.Element | | | SearchTrigger | Function | ({ className, placeholder, onTrigger, keyboardShortcut, width, }: SearchTriggerProps) =\> import("@types/react/jsx-run... | Generic search trigger component that can be used across applications Accepts an onTrigger callback to handle search opening/activation | | SearchTriggerProps | Interface | SearchTriggerProps | | | UserDropdown | Function | ({ user, menuActions, onLogout, fallbackAvatar, className, themeControl, }: UserDropdownProps) =\> import("@types/reac... | Generic user dropdown component that can be used across applications Accepts user data and menu actions as props for maximum flexibility | | UserMenuAction | Interface | UserMenuAction | | | UserData | Interface | UserData | | | UserDropdownThemeControl | Interface | UserDropdownThemeControl | | | UserDropdownProps | Interface | UserDropdownProps | | | PasswordInput | Variable | React.ForwardRefExoticComponent\<PasswordInputProps & React.RefAttributes\<HTMLInputElement\>\> | | | SelectDropdown | Function | ({ value, defaultValue, onValueChange, placeholder, options, items, className, }: SelectDropdownProps) =\> import("@ty... | | | SelectDropdownProps | Interface | SelectDropdownProps | | | ConfirmDialog | Function | ({ open, onOpenChange, title, desc, description, onConfirm, handleConfirm, confirmText, destructive, disabled, confir... | | | ConfirmDialogProps | Interface | ConfirmDialogProps | | | TypedConfirmInput | Function | ({ expected, value, onValueChange, label, helpText, id, disabled, className, }: TypedConfirmInputProps) =\> import("@t... | Type-to-confirm input for irreversible destructive actions.

Single source of truth for the "type EXACTLY '<name>' to delete" pattern. Use with a confirm button gated on useTypedConfirmMatch() (or compare value === expected directly).

The expected phrase is rendered inside the help text via \<code\> so users can see exactly what to type. | | isTypedConfirmMatch | Function | (value: string, expected: string) =\> boolean | Returns true when the typed value exactly matches the expected phrase. | | TypedConfirmInputProps | Interface | TypedConfirmInputProps | | | Alert | Function | ({ className, variant, children, }: { className?: string; variant?: string; children: React.ReactNode; }) =\> import("... | | | AlertDescription | Function | ({ className, children, }: { className?: string; children: React.ReactNode; }) =\> import("@types/react/jsx-runtime").... | | | AlertTitle | Function | ({ className, children, }: { className?: string; children: React.ReactNode; }) =\> import("@types/react/jsx-runtime").... | | | FeatureLoading | Function | () =\> import("@types/react/jsx-runtime").JSX.Element | Loading fallback for lazy-loaded features Provides a skeleton UI that matches the typical feature layout | | DangerZoneCard | Function | ({ title, description, children, className, }: DangerZoneCardProps) =\> import("@types/react/jsx-runtime").JSX.Element | Canonical container for irreversible / data-destructive actions.

Standardizes the visual treatment across Account ("Delete account"), Organization ("Delete organization"), and any future destructive surfaces. Single source of truth so the three drifted variants from the audit (red-bordered card vs no-border red-heading vs alert-strip) collapse to one pattern.

Layout: <Card border-destructive> <CardHeader> <AlertTriangle /> {title} </CardHeader> <CardContent> {children} </CardContent> </Card> | | DangerZoneCardProps | Interface | DangerZoneCardProps | | | CardErrorFallback | Function | ({ error, reset, title, className, }: CardErrorFallbackProps) =\> import("@types/react/jsx-runtime").JSX.Element | Card-shaped error surface. Intended for inline section recovery — shows a brief message + a Try again button that calls reset(). | | ErrorBoundaryFallbackProps | Interface | ErrorBoundaryFallbackProps | | | ErrorBoundaryProps | Interface | ErrorBoundaryProps | | | ErrorBoundary | Class | ErrorBoundary | Scoped error boundary for sectioned UIs.

Wrap each \<SettingsSection\> (or any independently-failable card) in its own boundary so a single render-time failure surfaces inline — neighboring sections keep working. Replaces the white-screen default that comes from an uncaught render exception. | | CardErrorFallbackProps | Interface | CardErrorFallbackProps | | | LongText | Function | ({ className, children, maxLength, }: LongTextProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | LongTextProps | Interface | LongTextProps | | | CardGridSkeleton | Function | ({ count, className, }: { count?: number; className?: string; }) =\> import("@types/react/jsx-runtime").JSX.Element | Skeleton for a grid of cards (e.g. home dashboard, feature lists) | | PageSkeleton | Function | ({ className, cardCount, }: { className?: string; cardCount?: number; }) =\> import("@types/react/jsx-runtime").JSX.El... | Full-page skeleton with a heading area and card grid below | | EmptyState | Function | ({ icon, title, description, action, className, variant, }: EmptyStateProps) =\> import("@types/react/jsx-runtime").JS... | Generic empty state component for when features/pages have no data. Follows the shadcn/ui composition pattern. | | SkipToMain | Variable | () =\> import("@types/react/jsx-runtime").JSX.Element | | | ThemeSwitchProps | Interface | ThemeSwitchProps | | | useFeatureLayout | Function | (featureConfig: FeatureConfig) =\> { navigationConfig: { mode: "default" \| "custom" \| "hybrid"; sidebar: { show: boole... | | | useLayoutComponents | Function | () =\> { Header: { ({ className, fixed, children, ...props }: import("packages/ui-core/src/index").HeaderProps): impor... | Hook that provides actual UI components for layout integration. Returns real component references that can be used by features. | | useIsMobile | Function | () =\> boolean | | | useFeatureRegistry | Function | () =\> import("packages/ui-core/src/providers/feature-registry-provider").FeatureRegistryContextType | | | useFeature | Function | (featureId: string) =\> FeatureModule \| null | | | useFeatureConfig | Function | (featureId: string) =\> FeatureConfig \| null | | | useFeatureEnabled | Function | (featureId: string) =\> boolean | | | useEnabledFeatures | Function | () =\> FeatureConfig[] | | | useFeaturesByDomain | Function | (domain: "core" \| "foresight" \| "equinox") =\> FeatureConfig[] | | | useFeaturesByType | Function | (type: "system" \| "business") =\> FeatureConfig[] | | | useRegistryStats | Function | () =\> { totalFeatures: number; enabledFeatures: number; loadedFeatures: number; loadedPackages: number; } | | | useDynamicFeatureLoader | Function | (segments: string[], options: UseFeatureLoaderOptions) =\> UseFeatureLoaderResult | Hook for loading features dynamically from URL segments | | useFeaturePreloader | Function | (resolver: FeatureResolverLike) =\> { preloadFeature: (segments: string[]) =\> Promise\<void\>; } | Hook for preloading features | | FeatureResolutionResult | Interface | FeatureResolutionResult | | | FeatureResolverLike | Interface | FeatureResolverLike | | | UseFeatureLoaderOptions | Interface | UseFeatureLoaderOptions | | | UseFeatureLoaderResult | Interface | UseFeatureLoaderResult | | | useNnoSession | Function | (authenticated: boolean) =\> UseNnoSessionResult | Fetch the NNO-enriched session from the auth service. Only runs when authenticated is true (user has a valid Better Auth session). | | checkPermission | Function | (permissions: string[], permission: string) =\> boolean | Check if a single permission is held. The '*' wildcard (platform-admin) grants all permissions. | | checkAnyPermission | Function | (permissions: string[], candidates: string[]) =\> boolean | Check if any of the supplied permissions are held. | | NnoSession | Interface | NnoSession | | | cn | Function | (...inputs: ClassValue[]) =\> string | Utility function to merge Tailwind CSS classes Combines clsx and tailwind-merge for optimal class handling | | formatDate | Function | (dateString: string, options?: Intl.DateTimeFormatOptions, locale?: string) =\> string | Common formatting utility functions Consolidated from ui-foresight and ui-equinox | | formatDateTime | Function | (dateString: string, locale?: string) =\> string | Format a date string to a localized date and time format | | formatCategory | Function | (category: string) =\> string | Format a category string (replace underscores, capitalize words) | | truncateText | Function | (text: string, maxLength: number) =\> string | Truncate text to a maximum length with ellipsis | | debounce | Function | \<TArgs extends readonly unknown[], TReturn\>(func: (...args: TArgs) =\> TReturn, wait: number) =\> (...args: TArgs) =\> void | Common helper utility functions | | SidebarData | Interface | SidebarData | | | NavItem | Type | NavItem | | | NavCollapsible | Type | NavCollapsible | | | NavLink | Type | NavLink | | | SidebarItem | Interface | SidebarItem | | | FeatureNavigationConfig | Interface | FeatureNavigationConfig | | | FeatureConfig | Interface | FeatureConfig | Full feature config used in features.config.ts. = Partial<FeatureDefinition> (from feature-sdk, optional for migration) + ShellOrchestrationFields (shell-only)

  • legacy shell fields kept for compatibility.

All FeatureDefinition fields are Partial here so existing shell entries don't need to add sdk-only fields immediately — migration is incremental. | | Font | Type | "inter" \| "manrope" \| "system" | | | Breadcrumb | Function | ({ ...props }: React.ComponentProps\<"nav"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | BreadcrumbList | Function | ({ className, ...props }: React.ComponentProps\<"ol"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | BreadcrumbItem | Function | ({ className, ...props }: React.ComponentProps\<"li"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | BreadcrumbLink | Function | ({ asChild, className, ...props }: React.ComponentProps\<"a"\> & { asChild?: boolean; }) =\> import("@types/react/jsx-ru... | | | BreadcrumbPage | Function | ({ className, ...props }: React.ComponentProps\<"span"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | BreadcrumbSeparator | Function | ({ children, className, ...props }: React.ComponentProps\<"li"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | BreadcrumbEllipsis | Function | ({ className, ...props }: React.ComponentProps\<"span"\>) =\> import("@types/react/jsx-runtime").JSX.Element | | | ThemeDefinition | Interface | ThemeDefinition | | | themeRegistry | Variable | Record\<string, ThemeDefinition\> | | | defaultTheme | Variable | ThemeDefinition | | | darkTheme | Variable | ThemeDefinition | | | oceanTheme | Variable | ThemeDefinition | | | forestTheme | Variable | ThemeDefinition | | | sunsetTheme | Variable | ThemeDefinition | | | roseTheme | Variable | ThemeDefinition | | | midnightTheme | Variable | ThemeDefinition | | | DefaultHome | Function | ({ createStackHref, stacks: stacksProp, isStacksLoading: isStacksLoadingProp, usage: usageProp, isUsageLoading: isUsa... | | | DefaultHomeProps | Interface | DefaultHomeProps | | | DefaultHelp | Function | ({ docsUrl, supportEmail, }: DefaultHelpProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | DefaultHelpProps | Interface | DefaultHelpProps | | | NotFoundPage | Function | ({ homeHref, helpHref, }: NotFoundPageProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | NotFoundPageProps | Interface | NotFoundPageProps | | | ServerErrorPage | Function | ({ homeHref, helpHref, }: ServerErrorPageProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | ServerErrorPageProps | Interface | ServerErrorPageProps | | | ForbiddenPage | Function | ({ homeHref, signInHref, helpHref, }: ForbiddenPageProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | ForbiddenPageProps | Interface | ForbiddenPageProps | | | UnauthorizedPage | Function | ({ signInHref, homeHref, helpHref, }: UnauthorizedPageProps) =\> import("@types/react/jsx-runtime").JSX.Element | | | UnauthorizedPageProps | Interface | UnauthorizedPageProps | | | AuthenticatedLayout | Function | typeof AuthenticatedLayout | Default authenticated layout with 3 rendering modes:

  1. Full hybrid — both sidebar and header are replaced by the feature. Only renders \<SearchProvider\>, \<KeyboardShortcutsModal /\>, and children.

  2. Sidebar-replace hybrid — sidebar is replaced but the header is kept. Renders header + children without the sidebar shell.

  3. Default — full sidebar + header + main layout. | | AuthenticatedLayoutProps | Interface | AuthenticatedLayoutProps | |

On this page