@progress/kendo-react-spreadsheet 5.14.0-dev.202305311028 → 5.14.0-dev.202305312206

package/dist/es/Spreadsheet.d.ts

@@ -1,3 +1,9 @@
 import * as React from 'react';
 import { SpreadsheetProps, SpreadsheetHandle } from './SpreadsheetProps';
+/**
+ * Represents the [KendoReact Spreadsheet component]({% slug overview_spreadsheet %}).
+ *
+ * Accepts properties of type [SpreadsheetProps]({% slug api_spreadsheet_spreadsheetprops %}).
+ * Obtaining the `ref` returns an object of type [SpreadsheetHandle]({% slug api_spreadsheet_spreadsheethandle %}).
+ */
 export declare const Spreadsheet: React.ForwardRefExoticComponent<SpreadsheetProps & React.RefAttributes<SpreadsheetHandle | null>>;

package/dist/es/Spreadsheet.js

@@ -39,6 +39,12 @@ const toolbarButtons = [
     '.k-combobox',
     '.k-colorpicker'
 ];
+/**
+ * Represents the [KendoReact Spreadsheet component]({% slug overview_spreadsheet %}).
+ *
+ * Accepts properties of type [SpreadsheetProps]({% slug api_spreadsheet_spreadsheetprops %}).
+ * Obtaining the `ref` returns an object of type [SpreadsheetHandle]({% slug api_spreadsheet_spreadsheethandle %}).
+ */
 export const Spreadsheet = React.forwardRef((props, ref) => {
     validatePackage(packageMetadata);
     const { toolbar = defaultTabs } = props;

package/dist/es/SpreadsheetProps.d.ts

@@ -1,25 +1,32 @@
 /// <reference types="react" />
 import { Workbook as OoxmlWorkbook } from '@progress/kendo-ooxml';
-import { SpreadsheetOptions as SpreadsheetOpts, Spreadsheet, Range, DocumentDescriptor, View, Sheet, ExcelExportSettings, SheetDescriptor, Workbook } from '@progress/kendo-spreadsheet-common';
-export declare class SpreadsheetWidget extends Spreadsheet {
-}
+import { SpreadsheetOptions as SpreadsheetOpts, SpreadsheetWidget, Range, DocumentDescriptor, View, Sheet, ExcelExportSettings, SheetDescriptor, Workbook } from '@progress/kendo-spreadsheet-common';
 export interface SpreadsheetOptions extends Omit<SpreadsheetOpts, 'formulaBarInputRef' | 'formulaCellInputRef' | 'nameBoxRef' | 'locale'> {
 }
-export { DocumentDescriptor, View, Workbook, Sheet, SheetDescriptor, ExcelExportSettings };
+export { SpreadsheetWidget, DocumentDescriptor, View, Workbook, Sheet, SheetDescriptor, ExcelExportSettings };
 interface SpreadsheetEvent {
     /**
      * The widget instance which fired the event.
      */
     sender: SpreadsheetWidget;
 }
+/**
+ * Represents the `SpreadsheetSelectEvent` object.
+ */
 export interface SpreadsheetSelectEvent extends SpreadsheetEvent {
     /**
      * The Range that is selected.
      */
     range: Range;
 }
+/**
+ * Represents the `SpreadsheetChangeEvent` object.
+ */
 export interface SpreadsheetChangeEvent extends SpreadsheetEvent, SpreadsheetSelectEvent {
 }
+/**
+ * Represents the `SpreadsheetExcelImportEvent` object.
+ */
 export interface SpreadsheetExcelImportEvent extends SpreadsheetEvent {
     /**
      * The file that is being imported.
@@ -30,6 +37,9 @@ export interface SpreadsheetExcelImportEvent extends SpreadsheetEvent {
      */
     preventDefault: Function;
 }
+/**
+ * Represents the `SpreadsheetExcelExportEvent` object.
+ */
 export interface SpreadsheetExcelExportEvent extends SpreadsheetEvent {
     /**
      * The array of data items that is used to create the Excel workbook.
@@ -45,10 +55,25 @@ export interface SpreadsheetExcelExportEvent extends SpreadsheetEvent {
      */
     preventDefault: Function;
 }
+/**
+ * Represents the Spreadsheet tab configuration object.
+ */
 export interface SpreadsheetTab {
+    /**
+     * The text of the tab.
+     */
     text?: string;
+    /**
+     * The localization key of the tab's text.
+     */
     textKey?: string;
+    /**
+     * Indicates if the tab to be selected initially.
+     */
     selected?: boolean;
+    /**
+     * The toolbar configuration in the tab content.
+     */
     tools: (React.ComponentType<any> | React.ComponentType<any>[])[];
 }
 export interface SpreadsheetProps {
@@ -56,6 +81,9 @@ export interface SpreadsheetProps {
      * Sets additional classes to the Spreadsheet.
      */
     className?: string;
+    /**
+     * Represents the default props of the Spreadsheet.
+     */
     defaultProps?: SpreadsheetOptions;
     /**
      * A Boolean value which indicates if the toolbar will be displayed. It also allows to customize the tabs content
@@ -88,6 +116,9 @@ export interface SpreadsheetProps {
      */
     onExcelExport?: (event: SpreadsheetExcelExportEvent) => void;
 }
+/**
+ * Represents the Spreadsheet handle object.
+ */
 export interface SpreadsheetHandle {
     /**
      * The current element or `null` if there is no one.
@@ -97,9 +128,23 @@ export interface SpreadsheetHandle {
      * The props values of the Spreadsheet.
      */
     props: SpreadsheetProps;
+    /**
+     * Represents the SpreadsheetWidget object, holding the core functionality of the Spreadsheet.
+     */
     instance: SpreadsheetWidget | null;
+    /**
+     * Returns the `View` object of the Spreadsheet.
+     */
     get view(): View;
+    /**
+     * Returns the `Workbook` object of the Spreadsheet.
+     */
     get workbook(): Workbook;
+    /**
+     * Executes the passed command against the selected cell/range.
+     *
+     * @param options An object containing the command name and the required by it options.
+     */
     executeCommand(options: any): void;
     /**
      * Loads the workbook data from an object with the format that is defined in the configuration.

package/dist/es/SpreadsheetProps.js

@@ -1,4 +1,2 @@
-import { Spreadsheet, View, Sheet, Workbook } from '@progress/kendo-spreadsheet-common';
-export class SpreadsheetWidget extends Spreadsheet {
-}
-export { View, Workbook, Sheet };
+import { SpreadsheetWidget, View, Sheet, Workbook } from '@progress/kendo-spreadsheet-common';
+export { SpreadsheetWidget, View, Workbook, Sheet };

package/dist/es/package-metadata.js

@@ -5,7 +5,7 @@ export const packageMetadata = {
     name: '@progress/kendo-react-spreadsheet',
     productName: 'KendoReact',
     productCodes: ['KENDOUIREACT', 'KENDOUICOMPLETE'],
-    publishDate: 1685528389,
+    publishDate: 1685570053,
     version: '',
     licensingDocsUrl: 'https://www.telerik.com/kendo-react-ui/my-license/?utm_medium=product&utm_source=kendoreact&utm_campaign=kendo-ui-react-purchase-license-keys-warning'
 };

package/dist/es/tools/align.d.ts

@@ -1,9 +1,18 @@
 import * as React from 'react';
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the Alignment tool component.
+ */
 export interface AlignmentProps extends SpreadsheetToolProps {
+    /**
+     * The value of the tool.
+     */
     value: {
         textAlign?: string;
         verticalAlign?: string;
     };
 }
+/**
+ * The Alignment tool component.
+ */
 export declare const Alignment: React.FunctionComponent<AlignmentProps>;

package/dist/es/tools/align.js

@@ -13,6 +13,9 @@ const alignItems = [
     { icon: 'align-middle', svgIcon: alignMiddleIcon, textKey: keys.alignMiddle, commandName: 'verticalAlign', value: 'center' },
     { icon: 'align-bottom', svgIcon: alignBottomIcon, textKey: keys.alignBottom, commandName: 'verticalAlign', value: 'bottom' }
 ];
+/**
+ * The Alignment tool component.
+ */
 export const Alignment = props => {
     const { value, spreadsheetRef } = props;
     const { textAlign, verticalAlign } = value || {};

package/dist/es/tools/backgroundColor.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="react" />
 import { ColorToolProps } from './utils';
+/**
+ * The props of the BackgroundColor tool component.
+ */
 export interface BackgroundColorProps extends ColorToolProps {
 }
+/**
+ * The BackgroundColor tool component.
+ */
 export declare const BackgroundColor: React.FunctionComponent<BackgroundColorProps>;

package/dist/es/tools/backgroundColor.js

@@ -1,6 +1,9 @@
 import { keys } from '../messages';
 import { ColorTool } from './utils';
 import { dropletIcon } from '@progress/kendo-svg-icons';
+/**
+ * The BackgroundColor tool component.
+ */
 export const BackgroundColor = ColorTool({
     icon: 'droplet',
     svgIcon: dropletIcon,

package/dist/es/tools/bold.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="react" />
 import { PropertyChangeToolProps } from './utils';
+/**
+ * The props of the Bold tool component.
+ */
 export interface BoldProps extends PropertyChangeToolProps {
 }
+/**
+ * The Bold tool component.
+ */
 export declare const Bold: React.FunctionComponent<BoldProps>;

package/dist/es/tools/bold.js

@@ -2,5 +2,8 @@ import { boldIcon } from '@progress/kendo-svg-icons';
 import { PropertyChangeTool } from './utils';
 import { keys } from '../messages';
 const boldSettings = { property: 'bold', icon: 'bold', svgIcon: boldIcon, titleKey: keys.bold };
+/**
+ * The Bold tool component.
+ */
 export const Bold = PropertyChangeTool(boldSettings);
 Bold.displayName = 'Bold';

package/dist/es/tools/defaultTools.d.ts

@@ -1,2 +1,5 @@
 import { SpreadsheetTab } from '../SpreadsheetProps';
+/**
+ * The default toolbar configuration.
+ */
 export declare const defaultTabs: SpreadsheetTab[];

package/dist/es/tools/defaultTools.js

@@ -16,6 +16,9 @@ import { AddColumnLeft, AddColumnRight, AddRowAbove, AddRowBelow, DeleteColumn,
 import { keys } from '../messages';
 import { Undo } from './undo';
 import { Redo } from './redo';
+/**
+ * The default toolbar configuration.
+ */
 export const defaultTabs = [
     {
         textKey: keys.file,

package/dist/es/tools/export.d.ts

@@ -1,5 +1,11 @@
 import * as React from 'react';
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the ExcelExport tool component.
+ */
 export interface ExcelExportProps extends SpreadsheetToolProps {
 }
+/**
+ * The ExcelExport tool component.
+ */
 export declare const ExcelExport: React.FunctionComponent<ExcelExportProps>;

package/dist/es/tools/export.js

@@ -3,6 +3,9 @@ import { Button } from '@progress/kendo-react-buttons';
 import { saveAs } from '@progress/kendo-file-saver';
 import { Workbook } from '@progress/kendo-ooxml';
 import { downloadIcon } from '@progress/kendo-svg-icons';
+/**
+ * The ExcelExport tool component.
+ */
 export const ExcelExport = props => {
     const { spreadsheetRef } = props;
     const onDownload = React.useCallback(() => {

package/dist/es/tools/fontFamily.d.ts

@@ -1,5 +1,11 @@
 import * as React from 'react';
 import { DropDownToolProps } from './utils';
+/**
+ * The props of the FontFamily tool component.
+ */
 export interface FontFamilyProps extends DropDownToolProps {
 }
+/**
+ * The FontFamily tool component.
+ */
 export declare const FontFamily: React.FunctionComponent<FontFamilyProps>;

package/dist/es/tools/fontFamily.js

@@ -3,6 +3,9 @@ import { DropDownList } from '@progress/kendo-react-dropdowns';
 import { DEFAULT_FONT_FAMILY, FONT_FAMILIES } from './utils';
 import { useLocalization } from '@progress/kendo-react-intl';
 import { keys, messages } from '../messages';
+/**
+ * The FontFamily tool component.
+ */
 export const FontFamily = props => {
     const { spreadsheetRef, value } = props;
     const onChange = React.useCallback((event) => {

package/dist/es/tools/fontSize.d.ts

@@ -1,5 +1,11 @@
 import * as React from 'react';
 import { DropDownToolProps } from './utils';
+/**
+ * The props of the FontSize tool component.
+ */
 export interface FontSizeProps extends DropDownToolProps {
 }
+/**
+ * The FontSize tool component.
+ */
 export declare const FontSize: React.FunctionComponent<FontSizeProps>;

package/dist/es/tools/fontSize.js

@@ -3,6 +3,9 @@ import { ComboBox } from '@progress/kendo-react-dropdowns';
 import { DEFAULT_FONT_SIZE, FONT_SIZES } from './utils';
 import { keys, messages } from '../messages';
 import { useLocalization } from '@progress/kendo-react-intl';
+/**
+ * The FontSize tool component.
+ */
 export const FontSize = props => {
     const { spreadsheetRef, value } = props;
     const onChange = React.useCallback((event) => {

package/dist/es/tools/format.d.ts

@@ -1,5 +1,11 @@
 import * as React from 'react';
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the Format tool component.
+ */
 export interface FormatProps extends SpreadsheetToolProps {
 }
+/**
+ * The Format tool component.
+ */
 export declare const Format: React.FunctionComponent<FormatProps>;

package/dist/es/tools/format.js

@@ -5,6 +5,9 @@ import { FORMATS } from './utils';
 import { IconWrap } from '@progress/kendo-react-common';
 import { useLocalization } from '@progress/kendo-react-intl';
 import { keys, messages } from '../messages';
+/**
+ * The Format tool component.
+ */
 export const Format = props => {
     const { spreadsheetRef } = props;
     const onChange = React.useCallback((event) => {

package/dist/es/tools/gridLines.d.ts

@@ -1,6 +1,15 @@
 import * as React from 'react';
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the GridLines tool component.
+ */
 export interface GridLinesProps extends SpreadsheetToolProps {
+    /**
+     * The selected state of the tool.
+     */
     value?: boolean;
 }
+/**
+ * The GridLines tool component.
+ */
 export declare const GridLines: React.FunctionComponent<GridLinesProps>;

package/dist/es/tools/gridLines.js

@@ -3,6 +3,9 @@ import { Button } from '@progress/kendo-react-buttons';
 import { bordersNoneIcon } from '@progress/kendo-svg-icons';
 import { useLocalization } from '@progress/kendo-react-intl';
 import { keys, messages } from '../messages';
+/**
+ * The GridLines tool component.
+ */
 export const GridLines = props => {
     const { value: selected, spreadsheetRef } = props;
     const onClick = React.useCallback(() => {

package/dist/es/tools/italic.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="react" />
 import { PropertyChangeToolProps } from './utils';
+/**
+ * The props of the Italic tool component.
+ */
 export interface ItalicProps extends PropertyChangeToolProps {
 }
+/**
+ * The Italic tool component.
+ */
 export declare const Italic: React.FunctionComponent<ItalicProps>;

package/dist/es/tools/italic.js

@@ -2,5 +2,8 @@ import { italicIcon } from '@progress/kendo-svg-icons';
 import { PropertyChangeTool } from './utils';
 import { keys } from '../messages';
 const italicSettings = { property: 'italic', icon: 'italic', svgIcon: italicIcon, titleKey: keys.italic };
+/**
+ * The Italic tool component.
+ */
 export const Italic = PropertyChangeTool(italicSettings);
 Italic.displayName = 'Italic';

package/dist/es/tools/open.d.ts

@@ -1,5 +1,11 @@
 import * as React from 'react';
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the Open tool component.
+ */
 export interface OpenProps extends SpreadsheetToolProps {
 }
+/**
+ * The Open tool component.
+ */
 export declare const Open: React.FunctionComponent<OpenProps>;

package/dist/es/tools/open.js

@@ -4,6 +4,9 @@ import { Upload } from '@progress/kendo-react-upload';
 import { folderOpenIcon } from '@progress/kendo-svg-icons';
 import { useLocalization } from '@progress/kendo-react-intl';
 import { keys, messages } from '../messages';
+/**
+ * The Open tool component.
+ */
 export const Open = props => {
     const { spreadsheetRef } = props;
     const onFileOpen = React.useCallback((event) => {

package/dist/es/tools/redo.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="react" />
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the Redo tool component.
+ */
 export interface RedoProps extends SpreadsheetToolProps {
 }
+/**
+ * The Redo tool component.
+ */
 export declare const Redo: React.FunctionComponent<RedoProps>;

package/dist/es/tools/redo.js

@@ -2,5 +2,8 @@ import { arrowRotateCwIcon } from '@progress/kendo-svg-icons';
 import { UndoRedo } from './utils';
 import { keys } from '../messages';
 const redoSettings = { action: 'redo', icon: 'reload', svgIcon: arrowRotateCwIcon, titleKey: keys.redo };
+/**
+ * The Redo tool component.
+ */
 export const Redo = UndoRedo(redoSettings);
 Redo.displayName = 'Redo';

package/dist/es/tools/tableTools.d.ts

@@ -1,20 +1,56 @@
 import * as React from 'react';
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the AddColumnLeft tool component.
+ */
 export interface AddColumnLeftProps extends SpreadsheetToolProps {
 }
+/**
+ * The props of the AddColumnRight tool component.
+ */
 export interface AddColumnRightProps extends SpreadsheetToolProps {
 }
+/**
+ * The props of the AddRowBelow tool component.
+ */
 export interface AddRowBelowProps extends SpreadsheetToolProps {
 }
+/**
+ * The props of the AddRowAbove tool component.
+ */
 export interface AddRowAboveProps extends SpreadsheetToolProps {
 }
+/**
+ * The props of the DeleteColumn tool component.
+ */
 export interface DeleteColumnProps extends SpreadsheetToolProps {
 }
+/**
+ * The props of the DeleteRow tool component.
+ */
 export interface DeleteRowProps extends SpreadsheetToolProps {
 }
+/**
+ * The AddColumnLeft tool component.
+ */
 export declare const AddColumnLeft: React.FunctionComponent<AddColumnLeftProps>;
+/**
+ * The AddColumnRight tool component.
+ */
 export declare const AddColumnRight: React.FunctionComponent<AddColumnRightProps>;
+/**
+ * The AddRowBelow tool component.
+ */
 export declare const AddRowBelow: React.FunctionComponent<AddRowBelowProps>;
+/**
+ * The AddRowAbove tool component.
+ */
 export declare const AddRowAbove: React.FunctionComponent<AddRowAboveProps>;
+/**
+ * The DeleteColumn tool component.
+ */
 export declare const DeleteColumn: React.FunctionComponent<DeleteColumnProps>;
+/**
+ * The DeleteRow tool component.
+ */
 export declare const DeleteRow: React.FunctionComponent<DeleteRowProps>;

package/dist/es/tools/tableTools.js

@@ -58,11 +58,29 @@ const deleteRow = {
     svgIcon: tableRowDeleteIcon,
     titleKey: keys.deleteRow
 };
+/**
+ * The AddColumnLeft tool component.
+ */
 export const AddColumnLeft = TableDataTool(addColumnLeft);
+/**
+ * The AddColumnRight tool component.
+ */
 export const AddColumnRight = TableDataTool(addColumnRight);
+/**
+ * The AddRowBelow tool component.
+ */
 export const AddRowBelow = TableDataTool(addRowBelow);
+/**
+ * The AddRowAbove tool component.
+ */
 export const AddRowAbove = TableDataTool(addRowAbove);
+/**
+ * The DeleteColumn tool component.
+ */
 export const DeleteColumn = TableDataTool(deleteColumn);
+/**
+ * The DeleteRow tool component.
+ */
 export const DeleteRow = TableDataTool(deleteRow);
 AddColumnLeft.displayName = 'AddColumnLeft';
 AddColumnRight.displayName = 'AddColumnRight';

package/dist/es/tools/textColor.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="react" />
 import { ColorToolProps } from './utils';
+/**
+ * The props of the TextColor tool component.
+ */
 export interface TextColorProps extends ColorToolProps {
 }
+/**
+ * The TextColor tool component.
+ */
 export declare const TextColor: React.FunctionComponent<TextColorProps>;

package/dist/es/tools/textColor.js

@@ -1,6 +1,9 @@
 import { keys } from '../messages';
 import { ColorTool } from './utils';
 import { foregroundColorIcon } from '@progress/kendo-svg-icons';
+/**
+ * The TextColor tool component.
+ */
 export const TextColor = ColorTool({
     icon: 'foreground-color',
     svgIcon: foregroundColorIcon,

package/dist/es/tools/textWrap.d.ts

@@ -1,6 +1,15 @@
 import * as React from 'react';
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the TextWrap tool component.
+ */
 export interface TextWrapProps extends SpreadsheetToolProps {
+    /**
+     * The selected state of the tool.
+     */
     value?: boolean;
 }
+/**
+ * The TextWrap tool component.
+ */
 export declare const TextWrap: React.FunctionComponent<TextWrapProps>;

package/dist/es/tools/textWrap.js

@@ -3,6 +3,9 @@ import { Button } from '@progress/kendo-react-buttons';
 import { textWrapIcon } from '@progress/kendo-svg-icons';
 import { useLocalization } from '@progress/kendo-react-intl';
 import { keys, messages } from '../messages';
+/**
+ * The TextWrap tool component.
+ */
 export const TextWrap = props => {
     const { value: selected, spreadsheetRef } = props;
     const onClick = React.useCallback(() => {

package/dist/es/tools/underline.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="react" />
 import { PropertyChangeToolProps } from './utils';
+/**
+ * The props of the Underline tool component.
+ */
 export interface UnderlineProps extends PropertyChangeToolProps {
 }
+/**
+ * The Underline tool component.
+ */
 export declare const Underline: React.FunctionComponent<UnderlineProps>;

package/dist/es/tools/underline.js

@@ -2,5 +2,8 @@ import { underlineIcon } from '@progress/kendo-svg-icons';
 import { PropertyChangeTool } from './utils';
 import { keys } from '../messages';
 const underlineSettings = { property: 'underline', icon: 'underline', svgIcon: underlineIcon, titleKey: keys.underline };
+/**
+ * The Underline tool component.
+ */
 export const Underline = PropertyChangeTool(underlineSettings);
 Underline.displayName = 'Underline';

package/dist/es/tools/undo.d.ts

@@ -1,5 +1,11 @@
 /// <reference types="react" />
 import { SpreadsheetToolProps } from './utils';
+/**
+ * The props of the Undo tool component.
+ */
 export interface UndoProps extends SpreadsheetToolProps {
 }
+/**
+ * The Undo tool component.
+ */
 export declare const Undo: React.FunctionComponent<UndoProps>;

package/dist/es/tools/undo.js

@@ -2,5 +2,8 @@ import { arrowRotateCcwIcon } from '@progress/kendo-svg-icons';
 import { UndoRedo } from './utils';
 import { keys } from '../messages';
 const undoSettings = { action: 'undo', icon: 'reset', svgIcon: arrowRotateCcwIcon, titleKey: keys.undo };
+/**
+ * The Undo tool component.
+ */
 export const Undo = UndoRedo(undoSettings);
 Undo.displayName = 'Undo';