@dolanske/vui 1.15.1 → 1.15.3

package/README.md

@@ -1,12 +1,40 @@
 # VUI
 
 1. `npm i @dolanske/vui`
-2. In your main app entry,`import "@dolanske/vui/style` to import the global CSS
+2. In your main app entry, `import "@dolanske/vui/style"` to import the global CSS
 3. Override default style [tokens](https://dolanske.github.io/vui/docs/tokens) to fit your style
 4. Build your thing bro
 
----
-
 ## Documentation
 
-[Visit the docs here <](https://dolanske.github.io/vui/)
+[Visit the docs here](https://dolanske.github.io/vui/)
+
+## Contributing
+
+This repository is split into two packages: the library itself in `src/` and the documentation in `docs/`. The docs are built with [VitePress](https://vitepress.dev/) and are hosted on GitHub Pages.
+
+### Setup
+
+```sh
+# Install library dependencies
+npm install
+
+# Install docs dependencies
+cd docs && npm install && cd ..
+```
+
+### Development
+
+To run the VUI playground locally, run:
+
+```sh
+npm run dev
+```
+
+To run the docs dev server, run:
+
+```sh
+npm run docs
+```
+
+> The docs dev server resolves `@dolanske/vui` directly from `src/`, so changes to components and styles hot-reload instantly without rebuilding the library first.

package/dist/src/components/Resizable/Resizable.vue.d.ts

@@ -11,6 +11,12 @@ interface Props {
      * Hides resizable handles unless hovered.
      */
     hideHandles?: boolean;
+    /**
+     * Minimum size (in pixels) each panel can be resized to. Applies to
+     * every panel and is enforced along the active axis (width for
+     * horizontal layouts, height for vertical ones).
+     */
+    minSize?: number;
 }
 interface PanelProps {
     minWidth: number;

package/dist/src/components/Table/table.d.ts

@@ -1,9 +1,9 @@
 import { ComputedRef, InjectionKey, MaybeRefOrGetter, Ref } from 'vue';
 import { DeepRequired } from '../../shared/types';
 export type BaseRow = Record<string, string | number>;
-export interface TableSelectionProvide {
-    selectedRows: Ref<Set<BaseRow>>;
-    selectRow: (row: BaseRow) => void;
+export interface TableSelectionProvide<Row = BaseRow> {
+    selectedRows: Ref<Set<Row>>;
+    selectRow: (row: Row) => void;
     selectAllRows: () => void;
     enabled: ComputedRef<boolean>;
     isSelectedAll: ComputedRef<boolean>;
@@ -26,22 +26,10 @@ export declare function defineTable<const Dataset extends any[]>(computedDataset
     setSort: (key: keyof Dataset[number], type?: "asc" | "desc" | "toggle") => void;
     clearSort: () => void;
     search: Ref<string | undefined, string | undefined>;
-    rows: Readonly<Ref<import('vue').DeepReadonly<Dataset>, import('vue').DeepReadonly<Dataset>>>;
-    allRows: Readonly<Ref<import('vue').DeepReadonly<Dataset>, import('vue').DeepReadonly<Dataset>>>;
-    selectedRows: Readonly<Ref<ReadonlySet<{
-        readonly [x: string]: string | number;
-    }>, ReadonlySet<{
-        readonly [x: string]: string | number;
-    }>>>;
-    headers: Readonly<Ref<readonly {
-        readonly label: string;
-        readonly sortToggle: () => void;
-        readonly sortKey?: "asc" | "desc" | undefined;
-    }[], readonly {
-        readonly label: string;
-        readonly sortToggle: () => void;
-        readonly sortKey?: "asc" | "desc" | undefined;
-    }[]>>;
+    rows: ComputedRef<Dataset>;
+    allRows: ComputedRef<Dataset>;
+    selectedRows: Readonly<Ref<ReadonlySet<import('vue').DeepReadonly<import('@vue/reactivity').UnwrapRefSimple<Dataset[number]>>>, ReadonlySet<import('vue').DeepReadonly<import('@vue/reactivity').UnwrapRefSimple<Dataset[number]>>>>>;
+    headers: ComputedRef<Header[]>;
     pagination: ComputedRef<import('../Pagination/pagination').Pagination>;
     canPrevPage: ComputedRef<boolean>;
     canNextPage: ComputedRef<boolean>;

package/dist/src/index.d.ts

@@ -1,6 +1,7 @@
 import { Command, default as Commands } from './components/Commands/Commands.vue';
 import { SelectOption, default as Select } from './components/Select/Select.vue';
 import { Size, Sizes, Spaces, SpaceSize } from './shared/types';
+import { Breakpoints, breakpoints, viewport } from './shared/viewport';
 import { default as Accordion } from './components/Accordion/Accordion.vue';
 import { default as AccordionGroup } from './components/Accordion/AccordionGroup.vue';
 import { default as Alert } from './components/Alert/Alert.vue';
@@ -69,7 +70,6 @@ import { default as Tooltip } from './components/Tooltip/Tooltip.vue';
 import { default as Backdrop } from './internal/Backdrop/Backdrop.vue';
 import { searchString } from './shared/helpers';
 import { setColorTheme, theme } from './shared/theme';
-import { breakpoints, viewport } from './shared/viewport';
 import { useViewTransition } from './shared/viewTransition';
 import * as Table from './components/Table';
-export { Accordion, AccordionGroup, Alert, AspectRatio, Avatar, AvatarGroup, Backdrop, Badge, BadgeGroup, BreadcrumbItem, Breadcrumbs, breakpoints, Button, ButtonGroup, Calendar, Card, Carousel, Checkbox, Color, type Command, Commands, Confirm, ContextMenu, CopyClipboard, Counter, defineTable, Divider, Drawer, Dropdown, DropdownItem, DropdownTitle, Dropzone, File, Flex, Grid, Histogram, Indicator, Input, Kbd, KbdGroup, Marquee, Menubar, MenuItem, Modal, OTP, OTPItem, Overflow, paginate, Pagination, Password, Popout, PopoutHover, Progress, pushToast, Radio, RadioGroup, removeToast, Resizable, ResizableView, searchString, Select, type SelectOption, setColorTheme, Sheet, Sidebar, type Size, type Sizes, Skeleton, Slider, type Spaces, type SpaceSize, Spinner, Switch, Tab, Table, Tabs, Textarea, theme, Toasts, Tooltip, useViewTransition, viewport, };
+export { Accordion, AccordionGroup, Alert, AspectRatio, Avatar, AvatarGroup, Backdrop, Badge, BadgeGroup, BreadcrumbItem, Breadcrumbs, type Breakpoints, breakpoints, Button, ButtonGroup, Calendar, Card, Carousel, Checkbox, Color, type Command, Commands, Confirm, ContextMenu, CopyClipboard, Counter, defineTable, Divider, Drawer, Dropdown, DropdownItem, DropdownTitle, Dropzone, File, Flex, Grid, Histogram, Indicator, Input, Kbd, KbdGroup, Marquee, Menubar, MenuItem, Modal, OTP, OTPItem, Overflow, paginate, Pagination, Password, Popout, PopoutHover, Progress, pushToast, Radio, RadioGroup, removeToast, Resizable, ResizableView, searchString, Select, type SelectOption, setColorTheme, Sheet, Sidebar, type Size, type Sizes, Skeleton, Slider, type Spaces, type SpaceSize, Spinner, Switch, Tab, Table, Tabs, Textarea, theme, Toasts, Tooltip, useViewTransition, viewport, };

package/dist/src/shared/viewport.d.ts

@@ -13,21 +13,21 @@ export interface Breakpoints {
      */
     l: boolean;
 }
-export declare const breakpoints: Ref<{
+type BreakpointValues = Record<string, number> & {
     s: number;
     m: number;
     l: number;
-}, {
+};
+export declare const breakpoints: Ref<{
+    [x: string]: number;
     s: number;
     m: number;
     l: number;
-} | {
+}, BreakpointValues | {
+    [x: string]: number;
     s: number;
     m: number;
     l: number;
 }>;
-export declare const viewport: {
-    s: boolean;
-    m: boolean;
-    l: boolean;
-};
+export declare const viewport: Breakpoints;
+export {};