@douglasneuroinformatics/libui 2.0.0-beta.8 → 2.0.0

package/README.md

@@ -40,6 +40,20 @@ designed as a generic implementation.
 pnpm install @douglasneuroinformatics/libui
 ```
 
+## Usage
+
+**tailwind.config.cjs**
+
+```javascript
+const baseConfig = require('@douglasneuroinformatics/libui/tailwind.config.cjs');
+
+/** @type {import('tailwindcss').Config} */
+module.exports {
+  content: [...baseConfig.content, './src/**/*.{js,ts,jsx,tsx}'],
+  presets: [baseConfig]
+};
+```
+
 ## Contributing
 
 We welcome contributions! If you're interested in improving the library or adding new features, please refer to our contribution guide.

package/dist/components/index.d.ts

@@ -869,8 +869,10 @@ type LanguageToggleProps = {
     options: {
         [key: string]: string;
     };
+    triggerClassName?: string;
+    variant?: ButtonProps['variant'];
 };
-declare const LanguageToggle: ({ align, options }?: LanguageToggleProps) => react_jsx_runtime.JSX.Element;
+declare const LanguageToggle: ({ align, options, triggerClassName, variant }: LanguageToggleProps) => react_jsx_runtime.JSX.Element;
 
 type LegacyDropdownOptions = {
     [key: string]: string;
@@ -946,6 +948,43 @@ type LegacyStepperProps = {
 /** @deprecated */
 declare const LegacyStepper: ({ className, steps }: LegacyStepperProps) => react_jsx_runtime.JSX.Element;
 
+/** @deprecated */
+type LegacyColumnDropdownOptions<T extends LegacyTableEntry> = {
+    icon?: react__default.ComponentType<Omit<react__default.SVGProps<SVGSVGElement>, 'ref'>>;
+    label: string;
+    onSelection: (column: LegacyTableColumn<T>) => void;
+}[];
+
+/** @deprecated */
+type LegacyTableEntry = {
+    [key: string]: unknown;
+};
+/** @deprecated */
+type LegacyFieldFactory<T extends LegacyTableEntry = LegacyTableEntry> = (entry: T) => string;
+/** @deprecated */
+type LegacyTableColumn<T extends LegacyTableEntry> = {
+    /** How to determine the values for column */
+    field: LegacyFieldFactory<T> | keyof T;
+    /** Override the default formatter for this field */
+    formatter?: (value: any) => string;
+    /** The label to be displayed on the header */
+    label: string;
+};
+/** @deprecated */
+type LegacyTableProps<T extends LegacyTableEntry> = {
+    className?: string;
+    columnDropdownOptions?: LegacyColumnDropdownOptions<T>;
+    columns: LegacyTableColumn<T>[];
+    data: T[];
+    minRows?: number;
+    onEntryClick?: (entry: T) => void;
+};
+/** @deprecated */
+declare const LegacyTable: <T extends LegacyTableEntry>({ className, columnDropdownOptions, columns, data, minRows, onEntryClick }: LegacyTableProps<T>) => react_jsx_runtime.JSX.Element;
+
+/** @deprecated */
+declare const LegacyClientTable: <T extends LegacyTableEntry>({ data, ...props }: LegacyTableProps<T>) => react_jsx_runtime.JSX.Element;
+
 /** An array of arbitrary objects with data to graph  */
 type LineGraphData = readonly {
     [key: string]: any;
@@ -1893,17 +1932,26 @@ declare const Resizable: ResizableType;
 
 declare const ScrollArea: react__default.ForwardRefExoticComponent<Omit<_radix_ui_react_scroll_area.ScrollAreaProps & react__default.RefAttributes<HTMLDivElement>, "ref"> & react__default.RefAttributes<HTMLDivElement>>;
 
-type SearchBarProps = {
+type BaseSearchBarProps = {
     /** Additional CSS classes to add to the wrapper form component, potentially overriding default styling */
     className?: string;
-    /** Event handler called when the value changes */
-    onValueChange: (value: string) => void;
+    /** An optional callback invoked when the user clicks the search bar */
+    onClick?: () => void;
     /** Custom placeholder to use instead of the default */
     placeholder?: string;
+};
+type ControlledSearchBarProps = BaseSearchBarProps & {
+    /** Event handler called when the value changes */
+    onValueChange: (value: string) => void;
     /** The controlled value of the search bar, which should be used in conjunction with onValueChange */
     value: string;
 };
-declare const SearchBar: ({ className, onValueChange, placeholder, value }: SearchBarProps) => react_jsx_runtime.JSX.Element;
+type UncontrolledSearchBarProps = BaseSearchBarProps & {
+    onValueChange?: never;
+    value?: never;
+};
+type SearchBarProps = ControlledSearchBarProps | UncontrolledSearchBarProps;
+declare const SearchBar: ({ className, onClick, onValueChange, placeholder, value }: SearchBarProps) => react_jsx_runtime.JSX.Element;
 
 declare const Select: react.FC<SelectPrimitive.SelectProps> & {
     Content: react.ForwardRefExoticComponent<Omit<SelectPrimitive.SelectContentProps & react.RefAttributes<HTMLDivElement>, "ref"> & react.RefAttributes<HTMLDivElement>>;
@@ -1960,10 +2008,8 @@ declare const Tabs: react.ForwardRefExoticComponent<TabsPrimitive.TabsProps & re
 type TextAreaProps = react__default.TextareaHTMLAttributes<HTMLTextAreaElement>;
 declare const TextArea: react__default.ForwardRefExoticComponent<TextAreaProps & react__default.RefAttributes<HTMLTextAreaElement>>;
 
-type ThemeToggleProps = {
-    align?: 'center' | 'end' | 'start';
-};
-declare const ThemeToggle: () => react_jsx_runtime.JSX.Element;
+type ThemeToggleProps = Omit<ButtonProps, 'children' | 'size'>;
+declare const ThemeToggle: ({ onClick, variant, ...props }: ThemeToggleProps) => react_jsx_runtime.JSX.Element;
 
 type TooltipTriggerProps = Omit<ButtonProps, 'asChild'>;
 
@@ -1994,4 +2040,4 @@ declare const Tooltip: (({ children, delayDuration, skipDelayDuration }: Tooltip
     Trigger: react.ForwardRefExoticComponent<TooltipTriggerProps & react.RefAttributes<HTMLButtonElement>>;
 };
 
-export { Accordion, AlertDialog, ArrowToggle, type ArrowToggleProps, Avatar, BUTTON_ICON_SIZE, Badge, type BadgeProps, Breadcrumb, Button, type ButtonProps, Card, Checkbox, Collapsible, Command, ContextMenu, DatePicker, type DatePickerProps, Dialog, Drawer, DropdownButton, DropdownMenu, ErrorBoundary, ErrorFallback, type ErrorFallbackProps, Form, type FormProps, Heading, type HeadingProps, HoverCard, Input, type InputProps, Label, LanguageToggle, type LanguageToggleProps, LegacyDropdown, type LegacyDropdownProps, LegacyModal, type LegacyModalProps, LegacySelectDropdown, type LegacySelectDropdownProps, type LegacySelectOption, LegacySlider, type LegacySliderProps, LegacyStepper, type LegacyStepperProps, LineGraph, type LineGraphData, type LineGraphLine, MenuBar, NotificationHub, type NotificationHubProps, Pagination, Popover, Progress, RadioGroup, type RadioGroupProps, Resizable, ScrollArea, SearchBar, type SearchBarProps, Select, Separator, Sheet, Slider, Spinner, SpinnerIcon, type Step, Switch, Table, Tabs, TextArea, type TextAreaProps, ThemeToggle, type ThemeToggleProps, Tooltip, badgeVariants, buttonVariants, labelVariants };
+export { Accordion, AlertDialog, ArrowToggle, type ArrowToggleProps, Avatar, BUTTON_ICON_SIZE, Badge, type BadgeProps, type BaseSearchBarProps, Breadcrumb, Button, type ButtonProps, Card, Checkbox, Collapsible, Command, ContextMenu, DatePicker, type DatePickerProps, Dialog, Drawer, DropdownButton, DropdownMenu, ErrorBoundary, ErrorFallback, type ErrorFallbackProps, Form, type FormProps, Heading, type HeadingProps, HoverCard, Input, type InputProps, Label, LanguageToggle, type LanguageToggleProps, LegacyClientTable, LegacyDropdown, type LegacyDropdownProps, type LegacyFieldFactory, LegacyModal, type LegacyModalProps, LegacySelectDropdown, type LegacySelectDropdownProps, type LegacySelectOption, LegacySlider, type LegacySliderProps, LegacyStepper, type LegacyStepperProps, LegacyTable, type LegacyTableColumn, type LegacyTableEntry, type LegacyTableProps, LineGraph, type LineGraphData, type LineGraphLine, MenuBar, NotificationHub, type NotificationHubProps, Pagination, Popover, Progress, RadioGroup, type RadioGroupProps, Resizable, ScrollArea, SearchBar, type SearchBarProps, Select, Separator, Sheet, Slider, Spinner, SpinnerIcon, type Step, Switch, Table, Tabs, TextArea, type TextAreaProps, ThemeToggle, type ThemeToggleProps, Tooltip, badgeVariants, buttonVariants, labelVariants };