@univerjs-pro/bases-dashboard-ui 1.0.0-rc.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. package/README.md +42 -0
  2. package/lib/cjs/index.js +1 -1
  3. package/lib/cjs/locale/ar-SA.js +1 -1
  4. package/lib/cjs/locale/ca-ES.js +1 -1
  5. package/lib/cjs/locale/cs-CZ.js +1 -1
  6. package/lib/cjs/locale/de-DE.js +1 -1
  7. package/lib/cjs/locale/en-US.js +1 -1
  8. package/lib/cjs/locale/es-ES.js +1 -1
  9. package/lib/cjs/locale/fa-IR.js +1 -1
  10. package/lib/cjs/locale/fr-FR.js +1 -1
  11. package/lib/cjs/locale/id-ID.js +1 -1
  12. package/lib/cjs/locale/it-IT.js +1 -1
  13. package/lib/cjs/locale/ja-JP.js +1 -1
  14. package/lib/cjs/locale/ko-KR.js +1 -1
  15. package/lib/cjs/locale/nl-NL.js +1 -1
  16. package/lib/cjs/locale/pl-PL.js +1 -1
  17. package/lib/cjs/locale/pt-BR.js +1 -1
  18. package/lib/cjs/locale/ru-RU.js +1 -1
  19. package/lib/cjs/locale/sk-SK.js +1 -1
  20. package/lib/cjs/locale/th-TH.js +1 -1
  21. package/lib/cjs/locale/tr-TR.js +1 -1
  22. package/lib/cjs/locale/uk-UA.js +1 -1
  23. package/lib/cjs/locale/vi-VN.js +1 -1
  24. package/lib/cjs/locale/zh-CN.js +1 -1
  25. package/lib/cjs/locale/zh-HK.js +1 -1
  26. package/lib/cjs/locale/zh-TW.js +1 -1
  27. package/lib/es/index.js +1 -1
  28. package/lib/es/locale/ar-SA.js +1 -1
  29. package/lib/es/locale/ca-ES.js +1 -1
  30. package/lib/es/locale/cs-CZ.js +1 -1
  31. package/lib/es/locale/de-DE.js +1 -1
  32. package/lib/es/locale/en-US.js +1 -1
  33. package/lib/es/locale/es-ES.js +1 -1
  34. package/lib/es/locale/fa-IR.js +1 -1
  35. package/lib/es/locale/fr-FR.js +1 -1
  36. package/lib/es/locale/id-ID.js +1 -1
  37. package/lib/es/locale/it-IT.js +1 -1
  38. package/lib/es/locale/ja-JP.js +1 -1
  39. package/lib/es/locale/ko-KR.js +1 -1
  40. package/lib/es/locale/nl-NL.js +1 -1
  41. package/lib/es/locale/pl-PL.js +1 -1
  42. package/lib/es/locale/pt-BR.js +1 -1
  43. package/lib/es/locale/ru-RU.js +1 -1
  44. package/lib/es/locale/sk-SK.js +1 -1
  45. package/lib/es/locale/th-TH.js +1 -1
  46. package/lib/es/locale/tr-TR.js +1 -1
  47. package/lib/es/locale/uk-UA.js +1 -1
  48. package/lib/es/locale/vi-VN.js +1 -1
  49. package/lib/es/locale/zh-CN.js +1 -1
  50. package/lib/es/locale/zh-HK.js +1 -1
  51. package/lib/es/locale/zh-TW.js +1 -1
  52. package/lib/index.js +1 -1
  53. package/lib/locale/ar-SA.js +1 -1
  54. package/lib/locale/ca-ES.js +1 -1
  55. package/lib/locale/cs-CZ.js +1 -1
  56. package/lib/locale/de-DE.js +1 -1
  57. package/lib/locale/en-US.js +1 -1
  58. package/lib/locale/es-ES.js +1 -1
  59. package/lib/locale/fa-IR.js +1 -1
  60. package/lib/locale/fr-FR.js +1 -1
  61. package/lib/locale/id-ID.js +1 -1
  62. package/lib/locale/it-IT.js +1 -1
  63. package/lib/locale/ja-JP.js +1 -1
  64. package/lib/locale/ko-KR.js +1 -1
  65. package/lib/locale/nl-NL.js +1 -1
  66. package/lib/locale/pl-PL.js +1 -1
  67. package/lib/locale/pt-BR.js +1 -1
  68. package/lib/locale/ru-RU.js +1 -1
  69. package/lib/locale/sk-SK.js +1 -1
  70. package/lib/locale/th-TH.js +1 -1
  71. package/lib/locale/tr-TR.js +1 -1
  72. package/lib/locale/uk-UA.js +1 -1
  73. package/lib/locale/vi-VN.js +1 -1
  74. package/lib/locale/zh-CN.js +1 -1
  75. package/lib/locale/zh-HK.js +1 -1
  76. package/lib/locale/zh-TW.js +1 -1
  77. package/lib/types/components/mobile/BaseDashboardView.d.ts +2 -0
  78. package/lib/types/components/mobile/BasePivotChartEditor.d.ts +78 -0
  79. package/lib/types/components/mobile/BasePivotInspector.d.ts +10 -0
  80. package/lib/types/components/mobile/BasePivotPanel.d.ts +11 -0
  81. package/lib/types/components/mobile/BasePivotView.d.ts +2 -0
  82. package/lib/types/components/mobile/DashboardChartInspector.d.ts +11 -0
  83. package/lib/types/components/mobile/DashboardFormulaShapeInspector.d.ts +13 -0
  84. package/lib/types/components/mobile/DashboardGrid.d.ts +12 -0
  85. package/lib/types/components/mobile/DashboardInspector.d.ts +20 -0
  86. package/lib/types/components/mobile/DashboardMobileControls.d.ts +8 -0
  87. package/lib/types/components/mobile/DashboardTableFilter.d.ts +13 -0
  88. package/lib/types/components/mobile/DashboardWidgetActions.d.ts +8 -0
  89. package/lib/types/controllers/mobile/base-dashboard-ui.controller.d.ts +6 -0
  90. package/lib/types/index.d.ts +1 -0
  91. package/lib/types/locale/en-US.d.ts +5 -0
  92. package/lib/types/locale/types.d.ts +0 -4
  93. package/lib/types/mobile-plugin.d.ts +14 -0
  94. package/lib/umd/index.js +1 -1
  95. package/lib/umd/locale/ar-SA.js +1 -1
  96. package/lib/umd/locale/ca-ES.js +1 -1
  97. package/lib/umd/locale/cs-CZ.js +1 -1
  98. package/lib/umd/locale/de-DE.js +1 -1
  99. package/lib/umd/locale/en-US.js +1 -1
  100. package/lib/umd/locale/es-ES.js +1 -1
  101. package/lib/umd/locale/fa-IR.js +1 -1
  102. package/lib/umd/locale/fr-FR.js +1 -1
  103. package/lib/umd/locale/id-ID.js +1 -1
  104. package/lib/umd/locale/it-IT.js +1 -1
  105. package/lib/umd/locale/ja-JP.js +1 -1
  106. package/lib/umd/locale/ko-KR.js +1 -1
  107. package/lib/umd/locale/nl-NL.js +1 -1
  108. package/lib/umd/locale/pl-PL.js +1 -1
  109. package/lib/umd/locale/pt-BR.js +1 -1
  110. package/lib/umd/locale/ru-RU.js +1 -1
  111. package/lib/umd/locale/sk-SK.js +1 -1
  112. package/lib/umd/locale/th-TH.js +1 -1
  113. package/lib/umd/locale/tr-TR.js +1 -1
  114. package/lib/umd/locale/uk-UA.js +1 -1
  115. package/lib/umd/locale/vi-VN.js +1 -1
  116. package/lib/umd/locale/zh-CN.js +1 -1
  117. package/lib/umd/locale/zh-HK.js +1 -1
  118. package/lib/umd/locale/zh-TW.js +1 -1
  119. package/package.json +20 -19
package/README.md CHANGED
@@ -1,13 +1,55 @@
1
1
  # @univerjs-pro/bases-dashboard-ui
2
2
 
3
+ [![npm version](https://img.shields.io/npm/v/@univerjs-pro/bases-dashboard-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/bases-dashboard-ui)
4
+ [![license](https://img.shields.io/npm/l/@univerjs-pro/bases-dashboard-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/bases-dashboard-ui)
5
+ [![downloads](https://img.shields.io/npm/dm/@univerjs-pro/bases-dashboard-ui?style=flat-square)](https://npmjs.com/package/@univerjs-pro/bases-dashboard-ui)
6
+
3
7
  `@univerjs-pro/bases-dashboard-ui` provides the DOM Pivot View and the 12-column Base Dashboard UI.
4
8
 
9
+ ## Package Overview
10
+
11
+ | Package | UMD global | CSS | Locales | Facade entry |
12
+ | --- | --- | :---: | :---: | :---: |
13
+ | `@univerjs-pro/bases-dashboard-ui` | `UniverProBasesDashboardUi` | Yes | Yes | No |
14
+
5
15
  ## Installation
6
16
 
7
17
  ```sh
8
18
  pnpm add @univerjs-pro/bases-dashboard-ui
19
+ # or
20
+ npm install @univerjs-pro/bases-dashboard-ui
9
21
  ```
10
22
 
23
+ Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
24
+
25
+ ## Usage
26
+
11
27
  Register `UniverBaseDashboardUIPlugin`, import `@univerjs-pro/bases-dashboard-ui/lib/index.css`, and merge the locale file for each language enabled by the host application.
12
28
 
13
29
  Dashboard charts are selected from Pivot Views. Dashboard widgets also support Base table filters, rich-text-backed text, uploaded images, and Formula Shapes.
30
+
31
+ ### Mobile
32
+
33
+ Register `UniverMobileUIPlugin`, `UniverBasesMobileUIPlugin`, and `UniverChartMobileUIPlugin` before
34
+ `UniverBaseDashboardUIPlugin`. The mobile plugins satisfy the shared dependency identities and select
35
+ the mobile component registrations; using a mobile Chart Provider alone does not select the mobile plugin.
36
+
37
+ When registered with `UniverBasesMobileUIPlugin`, dashboards display widgets in one column without
38
+ rewriting their desktop grid geometry. Widget actions open an anchored floating menu for editing, ordering, and deletion through
39
+ the existing dashboard commands and history. Dashboard navigation provides create, rename, and delete.
40
+
41
+ Pivot configuration uses a drawer. Field menus provide area changes and ordering without drag and drop;
42
+ filter and value settings open nested drawers. Chart controls inherit the shared mobile select, color,
43
+ dropdown, and dialog components used by Sheets. Dashboard permission editing is hosted by the mobile
44
+ `IDialogService` and is exposed only when the authorization provider supports the target.
45
+
46
+ ## Integration Notes
47
+
48
+ - Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
49
+ - Import the package stylesheet once in your application.
50
+ - Merge the locale resources for each language enabled by your application.
51
+
52
+ ## Resources
53
+
54
+ - [Documentation](https://docs.univer.ai/guides/pro)
55
+ - [NPM package](https://npmjs.com/package/@univerjs-pro/bases-dashboard-ui)