@univerjs-pro/sheets-pivot-ui 0.21.1 → 0.22.0

package/README.md

@@ -1,32 +1,44 @@
 # @univerjs-pro/sheets-pivot-ui
 
-[![npm version](https://img.shields.io/npm/v/@univerjs-pro/sheets-pivot-ui)](https://npmjs.org/packages/@univerjs-pro/sheets-pivot-ui)
-[![license](https://img.shields.io/npm/l/@univerjs-pro/sheets-pivot-ui)](https://img.shields.io/npm/l/@univerjs-pro/sheets-pivot-ui)
-![CSS Included](https://img.shields.io/badge/CSS_Included-blue?logo=CSS3)
-![i18n](https://img.shields.io/badge/zh--CN%20%7C%20en--US-cornflowerblue?label=i18n)
+[![npm version](https://img.shields.io/npm/v/@univerjs-pro/sheets-pivot-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/sheets-pivot-ui)
+[![downloads](https://img.shields.io/npm/dm/@univerjs-pro/sheets-pivot-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/sheets-pivot-ui)
 
-## Introduction
+`@univerjs-pro/sheets-pivot-ui` provides pivot table UI integration for Univer Sheets.
 
-A pivot table is a powerful data analysis tool used for quickly and dynamically summarizing and analyzing large volumes of data. It allows users to group, filter, sort, and aggregate raw data across different dimensions, revealing patterns and trends within the data. By dragging and dropping fields to define rows, columns, and values, users can create cross-tabulated tables for multi-level data summarization. Common functions include sum, count, average, maximum/minimum, and more, enabling users to derive valuable insights from complex data. Pivot tables are ideal for scenarios such as financial analysis, business monitoring, and sales data reporting.
+## Package Overview
 
-## Usage
-
-### Installation
+| Package | UMD global | CSS | Locales | Facade entry |
+| --- | --- | :---: | :---: | :---: |
+| `@univerjs-pro/sheets-pivot-ui` | `UniverProSheetsPivotUi` | Yes | Yes | No |
 
-```shell
-# Using npm
-npm install @univerjs/sheet-pivot-ui @univerjs/sheet-pivot
+## Installation
 
-# Using pnpm
-pnpm add @univerjs/sheet-pivot-ui @univerjs/sheet-pivot
+```sh
+pnpm add @univerjs-pro/sheets-pivot-ui
+# or
+npm install @univerjs-pro/sheets-pivot-ui
 ```
 
-### Import
+Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
+
+## Usage
 
 ```ts
-import { UniverSheetsPivotTablePlugin } from '@univerjs-pro/sheets-pivot';
+import '@univerjs-pro/sheets-pivot-ui/lib/index.css';
+import EnUS from '@univerjs-pro/sheets-pivot-ui/locale/en-US';
 import { UniverSheetsPivotTableUIPlugin } from '@univerjs-pro/sheets-pivot-ui';
 
-univer.registerPlugin(UniverSheetsPivotTablePlugin);
 univer.registerPlugin(UniverSheetsPivotTableUIPlugin);
+
+// Merge EnUS into your Univer locale map when this package contributes UI text.
 ```
+
+## Integration Notes
+
+Use this package with `@univerjs-pro/sheets-pivot` when users need pivot table UI.
+
+## Resources
+
+- [Documentation](https://docs.univer.ai/guides/pro)
+- [NPM package](https://npmjs.com/package/@univerjs-pro/sheets-pivot-ui)
+