@univerjs-pro/bases-dashboard-ui 1.3.1 → 1.5.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 (107) hide show
  1. package/README.md +13 -9
  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/BasePivotChartEditor.d.ts +9 -9
  78. package/lib/types/components/mobile/BasePivotChartEditor.d.ts +9 -9
  79. package/lib/types/locale/en-US.d.ts +2 -0
  80. package/lib/types/utils/dashboard-formula-shape.d.ts +4 -4
  81. package/lib/types/utils/dashboard-text.d.ts +2 -2
  82. package/lib/umd/index.js +1 -1
  83. package/lib/umd/locale/ar-SA.js +1 -1
  84. package/lib/umd/locale/ca-ES.js +1 -1
  85. package/lib/umd/locale/cs-CZ.js +1 -1
  86. package/lib/umd/locale/de-DE.js +1 -1
  87. package/lib/umd/locale/en-US.js +1 -1
  88. package/lib/umd/locale/es-ES.js +1 -1
  89. package/lib/umd/locale/fa-IR.js +1 -1
  90. package/lib/umd/locale/fr-FR.js +1 -1
  91. package/lib/umd/locale/id-ID.js +1 -1
  92. package/lib/umd/locale/it-IT.js +1 -1
  93. package/lib/umd/locale/ja-JP.js +1 -1
  94. package/lib/umd/locale/ko-KR.js +1 -1
  95. package/lib/umd/locale/nl-NL.js +1 -1
  96. package/lib/umd/locale/pl-PL.js +1 -1
  97. package/lib/umd/locale/pt-BR.js +1 -1
  98. package/lib/umd/locale/ru-RU.js +1 -1
  99. package/lib/umd/locale/sk-SK.js +1 -1
  100. package/lib/umd/locale/th-TH.js +1 -1
  101. package/lib/umd/locale/tr-TR.js +1 -1
  102. package/lib/umd/locale/uk-UA.js +1 -1
  103. package/lib/umd/locale/vi-VN.js +1 -1
  104. package/lib/umd/locale/zh-CN.js +1 -1
  105. package/lib/umd/locale/zh-HK.js +1 -1
  106. package/lib/umd/locale/zh-TW.js +1 -1
  107. package/package.json +23 -23
package/README.md CHANGED
@@ -8,9 +8,9 @@
8
8
 
9
9
  ## Package Overview
10
10
 
11
- | Package | UMD global | CSS | Locales | Facade entry |
12
- | --- | --- | :---: | :---: | :---: |
13
- | `@univerjs-pro/bases-dashboard-ui` | `UniverProBasesDashboardUi` | Yes | Yes | No |
11
+ | Package | UMD global | CSS | Locales | Facade entry | Worker entry |
12
+ | --- | --- | :---: | :---: | :---: | :---: |
13
+ | `@univerjs-pro/bases-dashboard-ui` | `UniverProBasesDashboardUi` | Yes | Yes | No | No |
14
14
 
15
15
  ## Installation
16
16
 
@@ -20,16 +20,14 @@ pnpm add @univerjs-pro/bases-dashboard-ui
20
20
  npm install @univerjs-pro/bases-dashboard-ui
21
21
  ```
22
22
 
23
- Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
24
-
25
23
  ## Usage
26
24
 
25
+ Start with the [integration setup](https://docs.univer.ai/) for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.
26
+
27
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.
28
28
 
29
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
30
 
31
- ### Mobile
32
-
33
31
  Register `UniverMobileUIPlugin`, `UniverBasesMobileUIPlugin`, and `UniverChartMobileUIPlugin` before
34
32
  `UniverBaseDashboardUIPlugin`. The mobile plugins satisfy the shared dependency identities and select
35
33
  the mobile component registrations; using a mobile Chart Provider alone does not select the mobile plugin.
@@ -43,13 +41,19 @@ filter and value settings open nested drawers. Chart controls inherit the shared
43
41
  dropdown, and dialog components used by Sheets. Dashboard permission editing is hosted by the mobile
44
42
  `IDialogService` and is exposed only when the authorization provider supports the target.
45
43
 
44
+ ```ts
45
+ import { UniverBaseDashboardUIPlugin } from '@univerjs-pro/bases-dashboard-ui';
46
+
47
+ univer.registerPlugin(UniverBaseDashboardUIPlugin);
48
+ ```
49
+
46
50
  ## Integration Notes
47
51
 
48
- - Keep all `@univerjs/*` and `@univerjs-pro/*` packages on the same version.
49
52
  - Import the package stylesheet once in your application.
50
53
  - Merge the locale resources for each language enabled by your application.
51
54
 
52
55
  ## Resources
53
56
 
54
- - [Documentation](https://docs.univer.ai/guides/pro)
57
+ - [Documentation](https://docs.univer.ai)
55
58
  - [NPM package](https://npmjs.com/package/@univerjs-pro/bases-dashboard-ui)
59
+ - [GitHub repository](https://github.com/dream-num/univer-pro)