@ticatec/uniface-element 0.3.23 → 5.0.0

package/dist/data_display/card/README_CN.md

@@ -0,0 +1,125 @@
+# Card 卡片
+
+内容容器，可选标题栏（或自定义 header snippet）、内容体，以及底部操作栏。
+
+> Svelte 5 组件。自定义标题通过 `headerBar` snippet 传入；内容体就是默认的 children。
+
+## 安装
+
+```bash
+npm install @ticatec/uniface-element
+```
+
+## 导入
+
+```svelte
+<script lang="ts">
+  import Card from '@ticatec/uniface-element/Card';
+  import type { CardAction } from '@ticatec/uniface-element/Card';
+</script>
+```
+
+## 属性
+
+| 属性 | 类型 | 默认值 | 描述 |
+|------|------|--------|------|
+| `title` | `string` | `''` | 纯文本标题，由 `CardHeader` 渲染。为空且传了 `headerBar` 时改用自定义 snippet |
+| `headerBar` | `Snippet` | `undefined` | 自定义标题内容（`title` 为空时生效） |
+| `actions` | `CardAction[]` | `[]` | 底部操作栏。空数组 → 不渲染底栏 |
+| `data` | `any` | `null` | 作为参数传给每个 action 的 `callback(data)` |
+| `variant` | `'plain' \| '3d'` | `'plain'` | `'3d'` 加盒阴影让卡片浮起来 |
+| `style` | `string` | `''` | 根节点的内联 CSS |
+| `theme` | `string` | `''` | 主题值，作为 `data-theme` 写到根节点上方便做作用域 CSS |
+| `children` | `Snippet` | `undefined` | 卡片内容体 |
+
+### `CardAction`
+
+```ts
+interface CardAction {
+  icon?: string;       // icon 字体类名，比如 'icon_google_edit'
+  img?: string;        // 图片 URL（未设 icon 时使用）
+  tooltip?: string;    // 悬停提示（`disabled` 为真时不显示）
+  disabled?: boolean;
+  callback: (data: any) => void;
+}
+```
+
+> `icon` 和 `img` 都不设的话该项不渲染任何东西 —— 二选一必填。操作栏对同一个 action 有约 500ms 的点击防抖。
+
+## 示例
+
+### 标题 + 内容
+
+```svelte
+<Card title="我的卡片" variant="3d">
+  <p>这是卡片内容</p>
+</Card>
+```
+
+### 自定义 header snippet
+
+```svelte
+<Card {headerBar}>
+  <p>内容</p>
+</Card>
+
+{#snippet headerBar()}
+  <header style="display:flex; align-items:center; gap:8px;">
+    <i class="icon_google_star"></i>
+    <strong>自定义标题</strong>
+  </header>
+{/snippet}
+```
+
+### 操作栏
+
+```svelte
+<script lang="ts">
+  import Card from '@ticatec/uniface-element/Card';
+  import type { CardAction } from '@ticatec/uniface-element/Card';
+
+  const cardData = { id: 123, name: '示例项目' };
+
+  const actions: CardAction[] = [
+    { icon: 'icon_google_save', tooltip: '保存', callback: (d) => console.log('save', d) },
+    { icon: 'icon_google_delete', tooltip: '删除', callback: (d) => console.log('delete', d) },
+  ];
+</script>
+
+<Card title="项目详情" {actions} data={cardData} variant="3d">
+  <p><strong>ID:</strong> {cardData.id}</p>
+  <p><strong>名称:</strong> {cardData.name}</p>
+</Card>
+```
+
+## 样式定制
+
+### 卡片本体
+
+| 变量 | 用处 |
+|------|------|
+| `--uniface-card-default-size` | 根节点宽度 |
+| `--uniface-card-radius` | 圆角 |
+| `--uniface-card-color-surface` | 卡片背景 |
+| `--uniface-card-border-color` | 外边框 |
+| `--uniface-card-color-inside-border` | 标题/内容/底栏之间的分隔线 |
+| `--uniface-card-header-margin` | 标题区域内边距 |
+| `--uniface-card-text-muted` | 标题文字颜色 |
+| `--uniface-card-shadow` | `variant="3d"` 的盒阴影（缺省回退到 `rgba(0,0,0,0.16) 0 1px 4px`） |
+
+### 操作栏
+
+| 变量 | 用处 |
+|------|------|
+| `--uniface-card-footer-margin` | 底栏内边距 |
+| `--uniface-card-footer-height` | 底栏高度 |
+| `--uniface-card-bar-font-size` | 操作图标基准尺寸 |
+| `--uniface-card-color-action-bar` | 图标默认颜色 |
+| `--uniface-card-color-action-bar-hover` | 图标悬停颜色 |
+| `--uniface-card-color-action-bar-disabled` | 图标禁用颜色 |
+| `--action-image-size` / `--uniface-action-image-size` | 单卡片覆盖操作图标/图片的尺寸 |
+
+## variant
+
+- **`plain`**（默认）—— 扁平，只有边框
+- **`3d`** —— 加 `--uniface-card-shadow`；根节点同时有 hover 过渡（border-color / transform / box-shadow）

package/dist/data_display/concise_data_table/ConciseListTable.svelte

@@ -0,0 +1,272 @@
+<script lang="ts">
+    import {onMount, tick} from 'svelte';
+    import DataRow from "./DataRow.svelte";
+    import {type RowClickHandler, type TableOptions} from "./TableOptions";
+    import utils from "./utils";
+    import type Column from "./Column";
+
+    interface Props {
+        list: Array<any>;
+        columns: Array<Column>;
+        autoScroll?: boolean;
+        scrollInterval?: number;
+        rowClickHandler?: RowClickHandler | null;
+        options?: TableOptions;
+        style?: string;
+        class?: string;
+        onfocus?: (event: FocusEvent) => void;
+        onblur?: (event: FocusEvent) => void;
+    }
+
+    let {
+        list,
+        columns,
+        autoScroll = false,
+        scrollInterval = 2000,
+        rowClickHandler = null,
+        options = {},
+        style = '',
+        class: className = '',
+        onfocus,
+        onblur,
+    }: Props = $props();
+
+    let tabOptions = $derived({headerHeight: 36, rowHeight: 32, ...options});
+
+    const id = (new Date().getTime() * 1000 + Math.floor(Math.random() * 1000)).toString(36);
+
+    let tableContainer: HTMLElement | undefined;
+    let viewPanel: HTMLElement | undefined;
+    let headerRow: HTMLElement | undefined;
+    let scrollTimer: ReturnType<typeof setInterval> | undefined;
+    let visibleRowCount = 0;
+    let rowHeight = 0;
+    let viewWidth = $state(0);
+    let viewHeight = 0;
+    let resizeObserver: ResizeObserver | undefined;
+
+    let tableStyle = $derived(utils.generateTableStyle(id, columns, tabOptions, viewWidth));
+
+    onMount(() => {
+        resizeObserver = new ResizeObserver(() => {
+            viewWidth = Math.round(viewPanel?.clientWidth ?? 0) - 1;
+            viewHeight = Math.round(viewPanel?.clientHeight ?? 0) - 1;
+        });
+        if (viewPanel) resizeObserver.observe(viewPanel);
+
+        return () => {
+            resizeObserver?.disconnect();
+            stopAutoScroll();
+            const existingStyle = document.getElementById(`marqueeStyle_${id}`);
+            if (existingStyle) existingStyle.remove();
+        };
+    });
+
+    const setupAutoScroll = async () => {
+        if (autoScroll && tableContainer && list.length > 0) {
+            await tick();
+            const tableBody = tableContainer.querySelector('.table-body');
+            if (tableBody && tableBody.children.length > 0) {
+                rowHeight = (tableBody.children[0] as HTMLElement).offsetHeight;
+                visibleRowCount = Math.floor((tableContainer.offsetHeight - (headerRow?.offsetHeight ?? 0)) / rowHeight);
+                if (list.length <= visibleRowCount) return;
+                startAutoScroll();
+            }
+        }
+    }
+
+    const startAutoScroll = () => {
+        if (scrollTimer) clearInterval(scrollTimer);
+        const originalDataHeight = list.length * rowHeight;
+        const tableBody = tableContainer?.querySelector('.table-body') as HTMLElement | null;
+        if (tableBody) {
+            const animationDuration = scrollInterval * list.length / 1000;
+            tableBody.style.animation = 'none';
+
+            const existingStyle = document.getElementById(`marqueeStyle_${id}`);
+            if (existingStyle) existingStyle.remove();
+
+            const styleElement = document.createElement('style');
+            styleElement.id = `marqueeStyle_${id}`;
+            styleElement.textContent = `
+                @keyframes marqueeScroll_${id} {
+                    0% { transform: translateY(0px); }
+                    100% { transform: translateY(-${originalDataHeight}px); }
+                }
+            `;
+            document.head.appendChild(styleElement);
+
+            tableBody.offsetHeight;
+            tableBody.style.animation = `marqueeScroll_${id} ${animationDuration}s linear infinite`;
+        }
+    }
+
+    const stopAutoScroll = () => {
+        if (scrollTimer) {
+            clearInterval(scrollTimer);
+            scrollTimer = undefined;
+        }
+        const tableBody = tableContainer?.querySelector('.table-body') as HTMLElement | null;
+        if (tableBody) {
+            tableBody.style.animation = 'none';
+            tableBody.style.transform = 'translateY(0px)';
+        }
+    }
+
+    $effect(() => {
+        list;
+        autoScroll;
+        scrollInterval;
+        stopAutoScroll();
+        setupAutoScroll();
+    });
+
+    const handleRowClick = (row: any) => () => {
+        rowClickHandler?.(row);
+    }
+
+    const handleTableFocus = (event: FocusEvent) => {
+        onfocus?.(event);
+    }
+
+    const handleTableBlur = (event: FocusEvent) => {
+        onblur?.(event);
+    }
+
+    export function setFocus() {
+        const firstRow = tableContainer?.querySelector('.table-body .table-row');
+        if (firstRow) {
+            setTimeout(() => {
+                (firstRow as HTMLElement).focus();
+            }, 50);
+        }
+    }
+</script>
+
+<div
+    id="tab_{id}"
+    class="uniface-concise-datatable {className}"
+    {style}
+    onfocusin={handleTableFocus}
+    onfocusout={handleTableBlur}>
+    {@html tableStyle}
+    <div class="table-container" bind:this={tableContainer}>
+        <div class="table-header">
+            <div class="table-row" bind:this={headerRow} role="row">
+                {#each columns as column, idx}
+                    <div class="data-cell col_{idx}" role="columnheader">
+                        {column.title ?? ''}
+                    </div>
+                {/each}
+            </div>
+        </div>
+
+        <div
+            class="table-body-container"
+            bind:this={viewPanel}
+            class:auto-scroll={autoScroll}
+            role="table"
+            aria-label="Data table"
+            aria-rowcount={list.length + 1}>
+            <div class="table-body">
+                {#if autoScroll}
+                    {#each list as row, rowIndex}
+                        <DataRow
+                            data={row}
+                            {columns}
+                            {rowIndex}
+                            showAlternative={rowIndex % 2 == 1}
+                            onclick={handleRowClick(row)}/>
+                    {/each}
+                    {#each list as row, rowIndex}
+                        <DataRow
+                            data={row}
+                            {columns}
+                            rowIndex={rowIndex + list.length}
+                            showAlternative={(rowIndex + list.length) % 2 == 1}
+                            onclick={handleRowClick(row)}/>
+                    {/each}
+                    {#each list as row, rowIndex}
+                        <DataRow
+                            data={row}
+                            {columns}
+                            rowIndex={rowIndex + list.length * 2}
+                            showAlternative={(rowIndex + list.length * 2) % 2 == 1}
+                            onclick={handleRowClick(row)}/>
+                    {/each}
+                {:else}
+                    {#each list as row, rowIndex}
+                        <DataRow
+                            data={row}
+                            {columns}
+                            {rowIndex}
+                            showAlternative={rowIndex % 2 == 1}
+                            onclick={handleRowClick(row)}/>
+                    {/each}
+                {/if}
+            </div>
+        </div>
+    </div>
+</div>
+
+<style>:global .uniface-concise-datatable {
+  width: 100%;
+  height: 100%;
+  overflow: hidden;
+  display: flex;
+  flex-direction: column;
+  color: var(--uniface-concise-table-bg, unset);
+}
+:global .uniface-concise-datatable .table-container {
+  display: flex;
+  flex-direction: column;
+  height: 100%;
+  width: 100%;
+  overflow: hidden;
+}
+:global .uniface-concise-datatable .table-row {
+  display: flex;
+  width: 100%;
+  position: relative;
+  align-items: center;
+}
+:global .uniface-concise-datatable .table-row .data-cell {
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+  padding: 2px 4px;
+}
+:global .uniface-concise-datatable .table-header {
+  background-color: #f5f5f5;
+  padding: 0;
+  flex-shrink: 0;
+  z-index: 10;
+  user-select: none;
+}
+:global .uniface-concise-datatable .table-header .table-row {
+  font-weight: 600;
+}
+:global .uniface-concise-datatable .table-header .table-row .data-cell {
+  text-align: center !important;
+}
+:global .uniface-concise-datatable .table-body-container {
+  flex: 1;
+  overflow-y: auto;
+  overflow-x: hidden;
+}
+:global .uniface-concise-datatable .table-body-container .table-body {
+  width: 100%;
+}
+:global .uniface-concise-datatable .table-body-container .table-row {
+  cursor: pointer;
+}
+:global .uniface-concise-datatable .table-body-container .table-row.alternative {
+  background-color: var(--uniface-concise-table-row-alter-bg, #F8FAFC);
+  color: var(--uniface-concise-table-row-alter-color, #374151);
+}
+:global .uniface-concise-datatable .table-body-container .table-row:hover {
+  background-color: #f9f9f9;
+}
+:global .uniface-concise-datatable .table-body-container.auto-scroll {
+  overflow-y: hidden;
+}</style>

package/dist/data_display/concise_data_table/ConciseListTable.svelte.d.ts

@@ -0,0 +1,19 @@
+import { type RowClickHandler, type TableOptions } from "./TableOptions";
+import type Column from "./Column";
+interface Props {
+    list: Array<any>;
+    columns: Array<Column>;
+    autoScroll?: boolean;
+    scrollInterval?: number;
+    rowClickHandler?: RowClickHandler | null;
+    options?: TableOptions;
+    style?: string;
+    class?: string;
+    onfocus?: (event: FocusEvent) => void;
+    onblur?: (event: FocusEvent) => void;
+}
+declare const ConciseListTable: import("svelte").Component<Props, {
+    setFocus: () => void;
+}, "">;
+type ConciseListTable = ReturnType<typeof ConciseListTable>;
+export default ConciseListTable;

package/dist/data_display/concise_data_table/DataCell.svelte

@@ -0,0 +1,28 @@
+<script lang="ts">
+    import type Column from "./Column";
+
+    interface Props {
+        column: Column;
+        idx: number;
+        data: any;
+    }
+
+    let {
+        column,
+        idx,
+        data,
+    }: Props = $props();
+
+    let text = $derived(column.formatter ? column.formatter(data[column.field]) : (data[column.field] ?? ''));
+    // Safe by default: HTML rendering is opt-in only (escapeHTML: true), matching the
+    // semantics of the data_table component's DataColumn#escapeHTML flag.
+    let renderAsHtml = $derived(column.escapeHTML === true);
+</script>
+
+<div class="data-cell col_{idx}" role="cell">
+    {#if renderAsHtml}
+        {@html text}
+    {:else}
+        <span>{text}</span>
+    {/if}
+</div>

package/dist/data_display/concise_data_table/DataCell.svelte.d.ts

@@ -0,0 +1,9 @@
+import type Column from "./Column";
+interface Props {
+    column: Column;
+    idx: number;
+    data: any;
+}
+declare const DataCell: import("svelte").Component<Props, {}, "">;
+type DataCell = ReturnType<typeof DataCell>;
+export default DataCell;

package/dist/data_display/concise_data_table/DataRow.svelte

@@ -0,0 +1,44 @@
+<script lang="ts">
+    import type Column from "./Column";
+    import DataCell from "./DataCell.svelte";
+
+    interface Props {
+        columns: Array<Column>;
+        data: any;
+        showAlternative?: boolean;
+        rowIndex?: number;
+        onclick?: (event: MouseEvent) => void;
+    }
+
+    let {
+        columns,
+        data,
+        showAlternative = false,
+        rowIndex = 0,
+        onclick,
+    }: Props = $props();
+
+    const handleRowKeyDown = (event: KeyboardEvent) => {
+        if (event.key === 'Enter' || event.key === ' ') {
+            event.preventDefault();
+            const clickEvent = new MouseEvent('click', {
+                bubbles: true,
+                cancelable: true
+            });
+            event.currentTarget?.dispatchEvent(clickEvent);
+        }
+    };
+</script>
+
+<div
+    class="table-row"
+    class:alternative={showAlternative}
+    role="row"
+    tabindex="0"
+    aria-rowindex={rowIndex + 2}
+    {onclick}
+    onkeydown={handleRowKeyDown}>
+    {#each columns as column, idx}
+        <DataCell {idx} {column} {data}/>
+    {/each}
+</div>

package/dist/data_display/concise_data_table/DataRow.svelte.d.ts

@@ -0,0 +1,11 @@
+import type Column from "./Column";
+interface Props {
+    columns: Array<Column>;
+    data: any;
+    showAlternative?: boolean;
+    rowIndex?: number;
+    onclick?: (event: MouseEvent) => void;
+}
+declare const DataRow: import("svelte").Component<Props, {}, "">;
+type DataRow = ReturnType<typeof DataRow>;
+export default DataRow;

package/dist/data_display/concise_data_table/README.md

@@ -0,0 +1,175 @@
+# ConciseListTable
+
+A lightweight single-purpose table for **display-only** data: fixed columns, optional marquee auto-scroll, alternating row styling. No sorting, no resizing, no selection — use the full `DataTable` when you need those.
+
+> Svelte 5 component. The table fills its parent (100% × 100%); the parent must have an explicit height.
+
+## Installation
+
+```bash
+npm install @ticatec/uniface-element
+```
+
+## Import
+
+```svelte
+<script lang="ts">
+  import ConciseListTable from '@ticatec/uniface-element/ConciseDataTable';
+  import type { Column, TableOptions, RowClickHandler } from '@ticatec/uniface-element/ConciseDataTable';
+</script>
+```
+
+## Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `list` | `Array<any>` | — | Required. Rows to render |
+| `columns` | `Array<Column>` | — | Required. Column definitions |
+| `options` | `TableOptions` | `{}` | Visual options (heights, row colors). Defaults: `headerHeight=36`, `rowHeight=32` |
+| `autoScroll` | `boolean` | `false` | Continuous marquee scroll. When on, the list is **rendered 3 times back-to-back** and animated with a CSS `translateY` keyframe |
+| `scrollInterval` | `number` | `2000` | Milliseconds each row stays visible (total animation duration = `scrollInterval × list.length`) |
+| `rowClickHandler` | `(row: any) => void \| null` | `null` | Row click callback |
+| `style` | `string` | `''` | Inline CSS on the root |
+| `class` | `string` | `''` | Extra class on the root |
+| `onfocus` | `(e: FocusEvent) => void` | `undefined` | Forwarded from the root via `focusin` |
+| `onblur` | `(e: FocusEvent) => void` | `undefined` | Forwarded from the root via `focusout` |
+
+### `Column`
+
+```ts
+interface Column {
+  title: string;                                              // header text
+  field: string;                                              // property name on each row
+  width: number;                                              // base width in px (always honored)
+  align?: 'left' | 'center' | 'right';                        // cell text align, default 'left'
+  weight?: number;                                            // flex ratio for leftover horizontal space (default 0 = fixed)
+  formatter?: (value: any) => string;                         // transforms the raw value before rendering
+  escapeHTML?: boolean;                                       // when true, formatter output is rendered as HTML ({@html}); default text-only
+}
+```
+
+**Width algorithm** (see `utils.ts`): each column's actual width = `col.width + col.weight × ((viewWidth − sum(col.width)) / sum(col.weight))`. With no weights, every column stays at its fixed `width` and any leftover space on the right is empty.
+
+### `TableOptions`
+
+All optional. When omitted, the component falls back to `headerHeight=36`, `rowHeight=32`, plus the CSS-variable defaults for colors.
+
+```ts
+interface TableOptions {
+  backgroundColor?: string;            // root background-color
+  color?: string;                       // root text color
+  headerHeight?: number;                // header row height (px)
+  headerBackgroundColor?: string;
+  headerColor?: string;
+  rowHeight?: number;                   // body row height (px) — also applied to header when only this is set
+  alternativeBackgroundColor?: string;  // even-row background
+  alternativeColor?: string;            // even-row text color
+}
+```
+
+## Examples
+
+### Basic
+
+```svelte
+<script lang="ts">
+  import ConciseListTable from '@ticatec/uniface-element/ConciseDataTable';
+  import type { Column } from '@ticatec/uniface-element/ConciseDataTable';
+
+  const columns: Column[] = [
+    { title: 'Name', field: 'name', width: 150 },
+    { title: 'Age', field: 'age', width: 80, align: 'center' },
+  ];
+
+  const list = [
+    { name: 'Alice', age: 30 },
+    { name: 'Bob', age: 25 },
+  ];
+</script>
+
+<div style="height: 320px;">
+  <ConciseListTable {list} {columns} />
+</div>
+```
+
+### Weighted columns + formatter
+
+Leftover space is split 1:2 between the two weighted columns; the 100-px status column stays fixed.
+
+```svelte
+<script lang="ts">
+  import ConciseListTable from '@ticatec/uniface-element/ConciseDataTable';
+  import type { Column, TableOptions } from '@ticatec/uniface-element/ConciseDataTable';
+
+  const columns: Column[] = [
+    { title: 'Product', field: 'product', width: 120, weight: 1 },
+    { title: 'Desc',    field: 'desc',    width: 120, weight: 2 },
+    { title: 'Status',  field: 'status',  width: 100, align: 'center',
+      formatter: (v: string) => v === 'available' ? '✅ In Stock' : '❌ Out' },
+  ];
+
+  const options: TableOptions = {
+    headerHeight: 40,
+    rowHeight: 36,
+    alternativeBackgroundColor: '#f8fafc',
+  };
+
+  const products = [
+    { product: 'Laptop',  desc: '14-inch ultrabook',  status: 'available' },
+    { product: 'Mouse',   desc: 'Wireless',            status: 'out' },
+  ];
+
+  const rowClickHandler = (row: any) => console.log('clicked', row);
+</script>
+
+<div style="height: 400px;">
+  <ConciseListTable {list: products} {columns} {options} {rowClickHandler} />
+</div>
+```
+
+### Marquee (TV-style auto-scroll)
+
+```svelte
+<div style="height: 280px;">
+  <ConciseListTable list={longList} columns={columns} autoScroll scrollInterval={2000} />
+</div>
+```
+
+When `autoScroll` is on:
+- The list is rendered **3 times** consecutively so the marquee can wrap without a visible seam.
+- The body's `overflow-y` is hidden; you can't scroll manually.
+- Animation is killed/rebuilt whenever `list`, `autoScroll`, or `scrollInterval` change.
+- If all rows fit in the viewport (`list.length ≤ visibleRowCount`), the animation is **not** started.
+
+## Styling
+
+CSS custom properties consumed by the SCSS (override on the root or any ancestor):
+
+| Variable | Used on |
+|----------|---------|
+| `--uniface-concise-table-bg` | Root text color fallback |
+| `--uniface-concise-table-row-alter-bg` | Alternating-row background (default `#F8FAFC`) |
+| `--uniface-concise-table-row-alter-color` | Alternating-row text color (default `#374151`) |
+
+For one-off theming prefer passing `options` (it generates scoped CSS with a unique `#tab_{id}` prefix); use the CSS variables for app-wide defaults.
+
+## Imperative API
+
+`setFocus()` is exported from the instance — call via `bind:this`:
+
+```svelte
+<script lang="ts">
+  let table: ConciseListTable;
+  // table.setFocus()
+</script>
+
+<ConciseListTable bind:this={table} {list} {columns} />
+```
+
+It schedules focus on the first body row after a 50ms timeout.
+
+## Accessibility
+
+- Root has `role="table"` and `aria-rowcount={list.length + 1}`.
+- Header cells have `role="columnheader"`, body rows have `role="row"`.
+- Row click is mouse-only — there is no built-in keyboard activation; add your own handler if needed.