@dskripchenko/ui 1.20.0 → 1.22.0

package/README.md

@@ -111,7 +111,7 @@ A short selection — the full catalog is in [Storybook](https://dskripchenko.gi
 
 User docs are translated into four languages — pick yours:
 
-- 🇬🇧 **English** (default): [getting-started](./docs/en/getting-started.md), [theming](./docs/en/theming.md), [tokens](./docs/en/tokens.md), [icons](./docs/en/icons.md), [patterns](./docs/en/patterns.md), [validation](./docs/en/validation.md), [charts](./docs/en/charts.md), [markdown](./docs/en/markdown.md), [kanban](./docs/en/kanban.md), [event calendar](./docs/en/event-calendar.md), [video](./docs/en/video.md), [audio](./docs/en/audio.md), [i18n](./docs/en/i18n.md)
+- 🇬🇧 **English** (default): [getting-started](./docs/en/getting-started.md), [theming](./docs/en/theming.md), [tokens](./docs/en/tokens.md), [icons](./docs/en/icons.md), [patterns](./docs/en/patterns.md), [validation](./docs/en/validation.md), [charts](./docs/en/charts.md), [markdown](./docs/en/markdown.md), [board](./docs/en/board.md), [calendar](./docs/en/calendar.md), [kanban](./docs/en/kanban.md), [event calendar](./docs/en/event-calendar.md), [video](./docs/en/video.md), [audio](./docs/en/audio.md), [i18n](./docs/en/i18n.md)
 - 🇷🇺 **Русский**: [docs/ru/](./docs/ru/)
 - 🇩🇪 **Deutsch**: [docs/de/](./docs/de/)
 - 🇨🇳 **中文**: [docs/zh/](./docs/zh/)

package/dist/components/Board/UidBoard.vue.d.ts

@@ -4,11 +4,23 @@ export interface BoardCardTag {
     label: string;
     tone?: Tone | 'default';
 }
+/** Who a card is assigned to: a name, or a name with an avatar picture or colour. */
+export type BoardAssignee = string | {
+    name: string;
+    avatar?: string;
+    color?: string;
+};
 export interface BoardCard {
     key: BoardKey;
     title: string;
     subtitle?: string;
     tags?: BoardCardTag[];
+    /** Shown in the card's footer as initials or the avatar picture. */
+    assignee?: BoardAssignee;
+    /** `YYYY-MM-DD`: the due date, shown formatted; before `today` (and not `done`) it is overdue. */
+    due?: string;
+    /** A finished card: muted, and never overdue. */
+    done?: boolean;
     /** The swimlane the card sits in, when the board has lanes. */
     lane?: BoardKey;
     /** Columns the card may move to; omitted — any column. */
@@ -18,6 +30,8 @@ export interface BoardColumn {
     key: BoardKey;
     title: string;
     cards: BoardCard[];
+    /** The real number of cards when only some are loaded; the count and WIP check use it. */
+    total?: number;
     /** Work-in-progress limit; the header warns when the column holds more. */
     wip?: number | null;
 }
@@ -40,6 +54,8 @@ export interface UidBoardProps {
     /** Freeze the board while a move is being saved. */
     busy?: boolean;
     readonly?: boolean;
+    /** `YYYY-MM-DD`: a card `due` before it is overdue. The local date by default. */
+    today?: string;
 }
 declare function __VLS_template(): {
     attrs: Partial<{}>;
@@ -53,6 +69,10 @@ declare function __VLS_template(): {
             count: number;
             over: boolean;
         }): unknown;
+        /** The bottom of a column, below its cards (with lanes — below the last lane). */
+        'column-footer'?(props: {
+            column: BoardColumn;
+        }): unknown;
     }> & {
         card?(props: {
             card: BoardCard;
@@ -63,6 +83,10 @@ declare function __VLS_template(): {
             count: number;
             over: boolean;
         }): unknown;
+        /** The bottom of a column, below its cards (with lanes — below the last lane). */
+        'column-footer'?(props: {
+            column: BoardColumn;
+        }): unknown;
     };
     refs: {};
     rootEl: HTMLDivElement;
@@ -78,6 +102,7 @@ declare const __VLS_component: import('vue').DefineComponent<UidBoardProps, {},
     readonly: boolean;
     lanes: BoardLane[];
     busy: boolean;
+    today: string;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;

package/dist/components/Board/index.d.ts

@@ -1,2 +1,2 @@
 export { default as UidBoard } from './UidBoard.vue';
-export type { UidBoardProps, BoardCard, BoardCardTag, BoardColumn, BoardLane, BoardMove, BoardKey } from './UidBoard.vue';
+export type { UidBoardProps, BoardCard, BoardCardTag, BoardColumn, BoardLane, BoardMove, BoardKey, BoardAssignee } from './UidBoard.vue';

package/dist/components/Calendar/UidCalendar.vue.d.ts

@@ -1,5 +1,6 @@
 import { CalendarEvent, CalendarRange, CalendarView } from './calendarModel';
 export type { CalendarEvent, CalendarRange, CalendarView } from './calendarModel';
+/** `event-move`: a move gives the new date (and times); a resize gives the new `endTime` (time grid) or inclusive `endDate` (month, all-day row). */
 export interface CalendarEventMove {
     event: CalendarEvent;
     date: string;
@@ -7,6 +8,7 @@ export interface CalendarEventMove {
     time?: string;
     endTime?: string;
 }
+/** The payload of `slot-click`: an empty slot — a time in the day/week grid, a day in the all-day row. */
 export interface CalendarSlot {
     date: string;
     time?: string;
@@ -20,6 +22,8 @@ export interface UidCalendarProps {
     todayLabel?: string;
     views?: CalendarView[];
     editable?: boolean;
+    /** Emit `slot-click` for clicks on empty slots. Defaults to `editable`. */
+    selectable?: boolean;
     hourHeight?: number;
     scrollToHour?: number;
 }
@@ -57,11 +61,12 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {
     "onUpdate:view"?: ((value: CalendarView) => any) | undefined;
     "onUpdate:anchor"?: ((value: string | null) => any) | undefined;
 }>, {
+    selectable: boolean;
     compact: boolean;
+    editable: boolean;
     events: CalendarEvent[];
     maxEventsPerDay: number;
     views: CalendarView[];
-    editable: boolean;
     hourHeight: number;
     scrollToHour: number;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {

package/dist/components/Calendar/calendarModel.d.ts

@@ -7,6 +7,8 @@ export interface CalendarEvent {
     endTime?: string;
     title: string;
     color?: string;
+    /** `false` — never dragged or resized, even in an editable calendar; omitted — follows the calendar. */
+    editable?: boolean;
 }
 export interface CalendarRange {
     view: CalendarView;
@@ -37,4 +39,6 @@ export interface TimedBlock {
     cols: number;
 }
 export declare function layoutDay(events: readonly CalendarEvent[], iso: string): TimedBlock[];
+/** The event stretched to end on `end` (inclusive, never before the start), times kept. */
+export declare function resized(e: CalendarEvent, end: string): Pick<CalendarEvent, 'date' | 'endDate' | 'time' | 'endTime'>;
 export declare function moved(e: CalendarEvent, date: string, time?: string): Pick<CalendarEvent, 'date' | 'endDate' | 'time' | 'endTime'>;

package/dist/components/Calendar/index.d.ts

@@ -1,2 +1,2 @@
 export { default as UidCalendar } from './UidCalendar.vue';
-export type { UidCalendarProps, CalendarEvent } from './UidCalendar.vue';
+export type { UidCalendarProps, CalendarEvent, CalendarEventMove, CalendarSlot, CalendarRange, CalendarView } from './UidCalendar.vue';

package/dist/components/EventCalendar/UidEventCalendar.vue.d.ts

@@ -35,8 +35,8 @@ declare const _default: import('vue').DefineComponent<UidEventCalendarProps, {},
     source: string;
     view: CalendarView | "";
     date: string;
-    views: CalendarView[];
     editable: boolean;
+    views: CalendarView[];
     locked: boolean;
     lockable: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;

package/dist/components/Kanban/UidKanban.vue.d.ts

@@ -26,9 +26,9 @@ declare const _default: import('vue').DefineComponent<UidKanbanProps, {}, {}, {}
     onOpen?: ((card: KanbanOpen) => any) | undefined;
 }>, {
     source: string;
+    today: string;
     editable: boolean;
     locked: boolean;
     lockable: boolean;
-    today: string;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 export default _default;

package/dist/components/Markdown/blockRenderers.d.ts

@@ -40,10 +40,20 @@ export interface UidMarkdownBlockMountHandle {
  * placeholder until it settles. A thrown error or a rejected promise is
  * treated like `{ error }`.
  */
-export type UidMarkdownBlockRenderer = (code: string, ctx: {
+export type UidMarkdownBlockRenderer = (code: string, ctx: UidMarkdownBlockRenderContext) => UidMarkdownBlockResult | Promise<UidMarkdownBlockResult>;
+/** What a block renderer knows of the block and of the markdown around it. */
+export interface UidMarkdownBlockRenderContext {
     language: string;
+    /** The block's number among the markdown's code blocks, from 0. */
     index: number;
-}) => UidMarkdownBlockResult | Promise<UidMarkdownBlockResult>;
+    /**
+     * The markdown's `imageBase` and `linkBase`, when it has them: a block that
+     * names files (a ```video with `src: intro.mp4`) resolves relative paths
+     * against them, as the markdown's own images and links do.
+     */
+    imageBase?: string;
+    linkBase?: string;
+}
 /** Block renderers by fence language (lower case). */
 export type UidMarkdownBlockRenderers = Readonly<Record<string, UidMarkdownBlockRenderer>>;
 export declare const markdownBlockRenderersKey: InjectionKey<UidMarkdownBlockRenderers>;

package/dist/components/Markdown/index.d.ts

@@ -3,4 +3,4 @@ export type { UidMarkdownProps } from './UidMarkdown.vue';
 export { createSlugger, escapeHtml, renderMarkdown, resolveAgainst, splitMarkdown, } from './markdown.js';
 export type { MarkdownHeading, MarkdownOptions, MarkdownSegment, Slugger, UidMarkdownCalloutKind, } from './markdown.js';
 export { markdownBlockRenderersKey, provideMarkdownBlockRenderers, useMarkdownBlockRenderers, } from './blockRenderers.js';
-export type { UidMarkdownBlockRenderer, UidMarkdownBlockRenderers, UidMarkdownBlockResult, UidMarkdownBlockMountContext, UidMarkdownBlockMountHandle, } from './blockRenderers.js';
+export type { UidMarkdownBlockRenderer, UidMarkdownBlockRenderContext, UidMarkdownBlockRenderers, UidMarkdownBlockResult, UidMarkdownBlockMountContext, UidMarkdownBlockMountHandle, } from './blockRenderers.js';

package/dist/components/Markdown/markdown.d.ts

@@ -44,6 +44,11 @@ export interface MarkdownOptions {
      * own links to navigate.
      */
     internalLinksInPlace?: boolean;
+    /** Read-out names of task checkboxes; English when not given. */
+    taskLabels?: {
+        done: string;
+        open: string;
+    };
     /** Titles of `[!NOTE]`-style callouts; English when not given. */
     calloutTitles?: Partial<Record<UidMarkdownCalloutKind, string>>;
 }