@univerjs/sheets-ui 0.24.0 → 0.25.0

package/lib/types/facade/f-range.d.ts

@@ -44,7 +44,8 @@ interface IFRangeSheetsUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('H6');
      * console.log(fRange.getCell());
      * ```
@@ -56,7 +57,8 @@ interface IFRangeSheetsUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('H6');
      * console.log(fRange.getCellRect());
      * ```
@@ -68,7 +70,8 @@ interface IFRangeSheetsUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('A1:B2');
      * fRange.setValues([
      *   [1, 2],
@@ -99,7 +102,8 @@ interface IFRangeSheetsUIMixin {
      *
      * // Attach the popup to the start cell of range C3:E5
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('C3:E5');
      * const disposable = fRange.attachPopup({
      *   componentKey: 'myPopup'
@@ -120,7 +124,8 @@ interface IFRangeSheetsUIMixin {
      * ```ts
      * // Attach an alert popup to the start cell of range C3:E5
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('C3:E5');
      *
      * const disposable = fRange.attachAlertPopup({
@@ -155,7 +160,8 @@ interface IFRangeSheetsUIMixin {
      *
      * // Attach the popup to the range C3:E5
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('C3:E5');
      * const disposable = fRange.attachRangePopup({
      *   componentKey: 'myPopup',
@@ -172,7 +178,8 @@ interface IFRangeSheetsUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Highlight the range C3:E5 with default style
      * const fRange = fWorksheet.getRange('C3:E5');
@@ -207,7 +214,8 @@ interface IFRangeSheetsUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const fRange = fWorksheet.getRange('C3:E5');
      * fRange.showDropdown({ type: 'list', props: { options: [{ label: 'Option 1', value: 'option1' }, { label: 'Option 2', value: 'option2' }] } });
      * ```

package/lib/types/facade/f-workbook.d.ts

@@ -214,7 +214,8 @@ export interface IFWorkbookSheetsUIMixin {
      * @example
      * ``` ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // scroll to cell D10
      * fWorksheet.scrollToCell(9, 3);

package/lib/types/facade/f-worksheet.d.ts

@@ -30,7 +30,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.refreshCanvas();
      * ```
      */
@@ -44,7 +45,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const ranges = [fWorksheet.getRange('A1:B2'), fWorksheet.getRange('D4:E5')];
      * const disposable = fWorksheet.highlightRanges(ranges, { fill: 'yellow' });
      *
@@ -60,7 +62,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Set zoom ratio to 200%
      * fWorksheet.zoom(2);
@@ -75,7 +78,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const zoomRatio = fWorksheet.getZoom();
      * console.log(zoomRatio);
      * ```
@@ -87,7 +91,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const visibleRange = fWorksheet.getVisibleRange();
      * console.log(visibleRange);
      * console.log(fWorksheet.getRange(visibleRange).getA1Notation());
@@ -100,7 +105,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const visibleRanges = fWorksheet.getVisibleRangesOfAllViewports();
      * console.log(visibleRanges);
      * const mainLeftTopViewportRange = visibleRanges?.get(univerAPI.Enum.SHEET_VIEWPORT_KEY.VIEW_MAIN_LEFT_TOP);
@@ -118,7 +124,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Scroll to cell D10
      * const fRange = fWorksheet.getRange('D10');
@@ -134,7 +141,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Scroll to cell D10
      * const fRange = fWorksheet.getRange('D10');
@@ -155,7 +163,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * const skeleton = fWorksheet.getSkeleton();
      * console.log(skeleton);
      * ```
@@ -168,7 +177,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Set the long text value in cell A1
      * const fRange = fWorksheet.getRange('A1');
@@ -187,7 +197,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Set the A:C columns to a width that fits their text.
      * fWorksheet.autoResizeColumns(0, 3);
@@ -210,7 +221,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      *
      * // Set the first 3 rows to a height that fits their text.
      * fWorksheet.autoResizeRows(0, 3);
@@ -223,7 +235,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.customizeColumnHeader({
      *   headerStyle: {
      *     fontColor: '#fff',
@@ -252,7 +265,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```typescript
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.customizeRowHeader({
      *   headerStyle: {
      *     backgroundColor: 'pink',
@@ -276,7 +290,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.setColumnHeaderHeight(100);
      * ```
      */
@@ -288,7 +303,8 @@ export interface IFWorksheetUIMixin {
      * @example
      * ```ts
      * const fWorkbook = univerAPI.getActiveWorkbook();
-     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fWorksheet = fWorkbook.getSheetByName('Sheet1');
+     * if (!fWorksheet) return;
      * fWorksheet.setRowHeaderWidth(100);
      * ```
      */

package/lib/types/locale/ar-SA.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;

package/lib/types/locale/de-DE.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type enUS from './en-US';
+declare const locale: typeof enUS;
+export default locale;