@hoci/core 0.8.1 → 0.10.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Chizuki
+Copyright (c) 2022 Chizuki(chizukicn@outlook.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,67 @@
+# @hoci/core
+
+[中文](README.zh-CN.md) | English
+
+Core composables, props, emits, and types for [hoci](../hoci/README.md). **No Vue components** — use [@hoci/components](../components/README.md) for ready-made components. Built on Vue 3 and [@vueuse/core](https://vueuse.org/).
+
+> **💡 Recommendation:** For most use cases, we recommend using the **hoci** package instead of directly installing `@hoci/core`. The **hoci** package provides a unified entry point with components, composables, and auto-import resolver.
+
+## Install
+
+```sh
+pnpm add @hoci/core
+```
+
+**Peer dependencies:** Vue 3.3+, [@vueuse/core](https://vueuse.org/) 10.5+.
+
+## Composables API
+
+| Composable | Returns | Description |
+|------------|---------|-------------|
+| **useAffix** | `{ className, wrapperRef, isFixed, placeholderStyle, fixedStyle, updatePosition }` | Pin content to viewport or target while scrolling. Returns fixed state, styles, and refs. |
+| **useFileUpload** | `{ inputRef, files, handleChange, handleDrop, handleDragOver }` | File input with drag-and-drop. Returns file list and handlers. |
+| **useIcon** | `{ style }` | Icon logic (size, color, mask). Returns computed styles. |
+| **useSelectionItem** | `{ isActive, activate, reject, className }` | Selectable list item logic. Returns active state and handlers. |
+| **usePopover** | `{ visible, show, close, popupRef, triggerRef, placement, offset }` | Floating panel with placement control. Returns visibility state and refs. |
+| **useSelectionList** | `{ options, actives, isActive, changeActive, renderItem, render }` | Single/multi selection state management. Returns selection state and render function. |
+| **useSelectionContext** | `HiSelectionContext` | Inject selection context from parent HiSelection. Returns context with activate, isActive, etc. |
+| **useSwitch** | `{ toggle, modelValue, className, isDisabled, activateEvent }` | Toggle switch logic. Returns state and toggle handler. |
+| **useVirtualList** | `{ virtualizer, scrollToIndex, scrollToOffset }` | Virtualized list for large data. Returns virtualizer instance and scroll methods. |
+
+## Props & Emits
+
+| Area | Props | Emits | Description |
+|------|-------|-------|-------------|
+| **Affix** | `affixProps` | `affixEmits` | Fixed positioning props (offset, position, target, zIndex) and events (scroll, change) |
+| **ConfigProvider** | `configProviderProps` | - | Global config props (icon, activateEvent) |
+| **FileUpload** | `fileUploadProps` | `fileUploadEmits` | File selection props (modelValue, multiple) and events (update:modelValue, change) |
+| **Icon** | `iconProps` | - | Icon props (src, size, width, height, color, mask) |
+| **Item** | `itemProps` | `itemEmits` | Selection item props (value, disabled) and events (reject) |
+| **Popover** | `popoverProps` | `popoverEmits` | Popover props (placement, triggerEvent, offset, visible) and events (update:visible, change) |
+| **Selection** | `selectionProps` | `selectionEmits` | Selection props (modelValue, multiple, activeClass, itemClass) and events (update:modelValue, change) |
+| **Switch** | `switchProps` | `switchEmits` | Switch props (modelValue, activeClass, disabled) and events (update:modelValue, change, reject) |
+| **VirtualList** | `virtualListProps` | `virtualListEmits` | Virtual list props (count, estimateSize, options) and events (scroll, scrollStart, scrollEnd) |
+
+## Utilities
+
+| Export | Description |
+|--------|-------------|
+| **provideAffixTarget** | Provide affix target element for child components |
+| **AFFIX_TARGET_KEY** | Injection key for affix target context |
+
+Shared types, composables (e.g. `useShowable`), and utilities are re-exported from [@hoci/shared](../shared/README.md).
+
+## Usage
+
+Use composables to build your own templates; for pre-built Vue components, use **@hoci/components** or **hoci**.
+
+```ts
+import { selectionEmits, selectionProps, useSelectionList } from "@hoci/core";
+
+// Use in your own component
+const { isActive, changeActive, render } = useSelectionList(props, { emit, slots });
+```
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,67 @@
+# @hoci/core
+
+[English](README.md) | 中文
+
+[hoci](../hoci/README.zh-CN.md) 的核心组合式函数、props、emits 与类型。**不提供 Vue 组件** — 即用型组件请使用 [@hoci/components](../components/README.zh-CN.md)。基于 Vue 3 与 [@vueuse/core](https://vueuse.org/)。
+
+> **💡 推荐：** 大多数场景下，我们推荐使用 **hoci** 主包，而不是直接安装 `@hoci/core`。**hoci** 包提供了统一的入口，包含组件、组合式函数和自动导入解析器。
+
+## 安装
+
+```sh
+pnpm add @hoci/core
+```
+
+**依赖要求：** Vue 3.3+、[@vueuse/core](https://vueuse.org/) 10.5+。
+
+## 组合式函数 API
+
+| 组合式函数 | 返回值 | 说明 |
+|------------|--------|------|
+| **useAffix** | `{ className, wrapperRef, isFixed, placeholderStyle, fixedStyle, updatePosition }` | 滚动时将内容固定在视口或目标。返回固定状态、样式和引用。 |
+| **useFileUpload** | `{ inputRef, files, handleChange, handleDrop, handleDragOver }` | 支持拖拽的文件上传。返回文件列表和处理函数。 |
+| **useIcon** | `{ style }` | 图标逻辑（尺寸、颜色、遮罩）。返回计算后的样式。 |
+| **useSelectionItem** | `{ isActive, activate, reject, className }` | 可选项逻辑。返回激活状态和处理函数。 |
+| **usePopover** | `{ visible, show, close, popupRef, triggerRef, placement, offset }` | 可控制位置的浮动面板。返回可见性状态和引用。 |
+| **useSelectionList** | `{ options, actives, isActive, changeActive, renderItem, render }` | 单选/多选状态管理。返回选择状态和渲染函数。 |
+| **useSelectionContext** | `HiSelectionContext` | 从父级 HiSelection 注入选择上下文。返回包含 activate、isActive 等的上下文。 |
+| **useSwitch** | `{ toggle, modelValue, className, isDisabled, activateEvent }` | 开关逻辑。返回状态和切换处理函数。 |
+| **useVirtualList** | `{ virtualizer, scrollToIndex, scrollToOffset }` | 大列表虚拟滚动。返回虚拟化实例和滚动方法。 |
+
+## Props 与 Emits
+
+| 模块 | Props | Emits | 说明 |
+|------|-------|-------|------|
+| **Affix** | `affixProps` | `affixEmits` | 固定定位属性（offset、position、target、zIndex）和事件（scroll、change） |
+| **ConfigProvider** | `configProviderProps` | - | 全局配置属性（icon、activateEvent） |
+| **FileUpload** | `fileUploadProps` | `fileUploadEmits` | 文件选择属性（modelValue、multiple）和事件（update:modelValue、change） |
+| **Icon** | `iconProps` | - | 图标属性（src、size、width、height、color、mask） |
+| **Item** | `itemProps` | `itemEmits` | 选择项属性（value、disabled）和事件（reject） |
+| **Popover** | `popoverProps` | `popoverEmits` | 浮动面板属性（placement、triggerEvent、offset、visible）和事件（update:visible、change） |
+| **Selection** | `selectionProps` | `selectionEmits` | 选择属性（modelValue、multiple、activeClass、itemClass）和事件（update:modelValue、change） |
+| **Switch** | `switchProps` | `switchEmits` | 开关属性（modelValue、activeClass、disabled）和事件（update:modelValue、change、reject） |
+| **VirtualList** | `virtualListProps` | `virtualListEmits` | 虚拟列表属性（count、estimateSize、options）和事件（scroll、scrollStart、scrollEnd） |
+
+## 工具函数
+
+| 导出 | 说明 |
+|------|------|
+| **provideAffixTarget** | 为子组件提供 affix 目标元素 |
+| **AFFIX_TARGET_KEY** | Affix 目标上下文的注入键 |
+
+类型、组合式函数（如 `useShowable`）与工具由 [@hoci/shared](../shared/README.zh-CN.md) 重新导出。
+
+## 使用方式
+
+基于组合式函数进行二次组件开发；若需要现成 Vue 组件，请使用 **@hoci/components** 或 **hoci**。
+
+```ts
+import { selectionEmits, selectionProps, useSelectionList } from "@hoci/core";
+
+// 在你自己的组件中使用
+const { isActive, changeActive, render } = useSelectionList(props, { emit, slots });
+```
+
+## 许可
+
+MIT

package/dist/chunk-zc3tnsvq.js

@@ -0,0 +1,36 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (!no_symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+
+//#endregion
+export { __reExport as n, __exportAll as t };